org.keycloak.protocol.LoginProtocol インタフェース

org.keycloak.protocol.LoginProtocol の継承関係図

org.keycloak.protocol.LoginProtocol 連携図

クラス
enum	Error

公開メンバ関数
LoginProtocol	setSession (KeycloakSession session)
LoginProtocol	setRealm (RealmModel realm)
LoginProtocol	setUriInfo (UriInfo uriInfo)
LoginProtocol	setHttpHeaders (HttpHeaders headers)
LoginProtocol	setEventBuilder (EventBuilder event)
Response	authenticated (UserSessionModel userSession, ClientSessionContext clientSessionCtx)
Response	sendError (AuthenticationSessionModel authSession, Error error)
void	backchannelLogout (UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
Response	frontchannelLogout (UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
Response	finishLogout (UserSessionModel userSession)
boolean	requireReauthentication (UserSessionModel userSession, AuthenticationSessionModel authSession)
default boolean	sendPushRevocationPolicyRequest (RealmModel realm, ClientModel resource, int notBefore, String managementUrl)
void	close ()

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

authenticated()

Response org.keycloak.protocol.LoginProtocol.authenticated	(	UserSessionModel	userSession,
		ClientSessionContext	clientSessionCtx
	)

org.keycloak.protocol.saml.SamlProtocol, org.keycloak.protocol.oidc.OIDCLoginProtocol, org.keycloak.protocol.docker.DockerAuthV2Protocolで実装されています。

backchannelLogout()

void org.keycloak.protocol.LoginProtocol.backchannelLogout	(	UserSessionModel	userSession,
		AuthenticatedClientSessionModel	clientSession
	)

org.keycloak.protocol.saml.SamlProtocol, org.keycloak.protocol.oidc.OIDCLoginProtocol, org.keycloak.protocol.docker.DockerAuthV2Protocolで実装されています。

close()

void org.keycloak.provider.Provider.close ( )

inherited

org.keycloak.models.sessions.infinispan.InfinispanUserSessionProvider, org.keycloak.storage.UserStorageManager, org.keycloak.protocol.saml.SamlProtocol, org.keycloak.storage.ldap.LDAPStorageProvider, org.keycloak.forms.login.freemarker.FreeMarkerLoginFormsProvider, org.keycloak.models.cache.infinispan.RealmCacheSession, org.keycloak.models.jpa.JpaUserProvider, org.keycloak.models.cache.infinispan.UserCacheSession, org.keycloak.forms.account.freemarker.FreeMarkerAccountProvider, org.keycloak.protocol.oidc.OIDCLoginProtocol, org.keycloak.models.jpa.session.JpaUserSessionPersisterProvider, org.keycloak.credential.UserCredentialStoreManager, org.keycloak.services.managers.DefaultBruteForceProtector, org.keycloak.connections.jpa.updater.liquibase.LiquibaseJpaUpdaterProvider, org.keycloak.email.freemarker.FreeMarkerEmailTemplateProvider, org.keycloak.protocol.saml.EntityDescriptorDescriptionConverter, org.keycloak.federation.kerberos.KerberosFederationProvider, org.keycloak.models.jpa.JpaUserCredentialStore, org.keycloak.storage.ClientStorageManager, org.keycloak.keys.infinispan.InfinispanPublicKeyStorageProvider, org.keycloak.models.sessions.infinispan.InfinispanAuthenticationSessionProvider, org.keycloak.services.clientregistration.AbstractClientRegistrationProvider, org.keycloak.authentication.authenticators.x509.AbstractX509ClientCertificateAuthenticator, org.keycloak.authentication.authenticators.resetcred.ResetCredentialEmail, org.keycloak.authentication.forms.RegistrationRecaptcha, org.keycloak.authentication.authenticators.browser.ScriptBasedAuthenticator, org.keycloak.email.DefaultEmailSenderProvider, org.keycloak.models.jpa.JpaRealmProvider, org.keycloak.exportimport.dir.DirImportProvider, org.keycloak.protocol.docker.DockerAuthV2Protocol, org.keycloak.authentication.authenticators.browser.SpnegoAuthenticator, org.keycloak.authorization.AuthorizationProvider, org.keycloak.authentication.authenticators.resetcred.ResetCredentialChooseUser, org.keycloak.authentication.forms.RegistrationUserCreation, org.keycloak.connections.jpa.updater.liquibase.lock.LiquibaseDBLockProvider, org.keycloak.theme.ExtendingThemeManager, org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation, org.keycloak.models.cache.infinispan.authorization.StoreFactoryCacheSession, org.keycloak.protocol.saml.installation.SamlIDPDescriptorClientInstallation, org.keycloak.authentication.authenticators.challenge.BasicAuthAuthenticator, org.keycloak.authentication.authenticators.cli.CliUsernamePasswordAuthenticator, org.keycloak.protocol.oidc.installation.KeycloakOIDCClientInstallation, org.keycloak.authentication.forms.RegistrationProfile, org.keycloak.authentication.requiredactions.UpdatePassword, org.keycloak.authentication.requiredactions.UpdateProfile, org.keycloak.protocol.saml.mappers.RoleNameMapper, org.keycloak.authentication.forms.RegistrationPassword, org.keycloak.protocol.oidc.OIDCWellKnownProvider, org.keycloak.events.log.JBossLoggingEventListenerProvider, org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator, org.keycloak.connections.jpa.updater.liquibase.conn.DefaultLiquibaseConnectionProvider, org.keycloak.authentication.authenticators.console.ConsoleUsernamePasswordAuthenticator, org.keycloak.authentication.authenticators.broker.AbstractIdpAuthenticator, org.keycloak.protocol.saml.installation.ModAuthMellonClientInstallation, org.keycloak.authentication.authenticators.browser.IdentityProviderAuthenticator, org.keycloak.credential.hash.Pbkdf2PasswordHashProvider, org.keycloak.events.jpa.JpaEventStoreProvider, org.keycloak.authentication.authenticators.browser.UsernamePasswordForm, org.keycloak.authentication.authenticators.browser.OTPFormAuthenticator, org.keycloak.authentication.requiredactions.ConsoleUpdateTotp, org.keycloak.authentication.requiredactions.ConsoleVerifyEmail, org.keycloak.authentication.requiredactions.VerifyEmail, org.keycloak.authentication.requiredactions.TermsAndConditions, org.keycloak.authorization.protection.introspect.RPTIntrospectionProvider, org.keycloak.protocol.oidc.installation.KeycloakOIDCJbossSubsystemClientInstallation, org.keycloak.authentication.requiredactions.UpdateTotp, org.keycloak.models.UserProvider, org.keycloak.exportimport.dir.DirExportProvider, org.keycloak.models.UserSessionProvider, org.keycloak.scripting.DefaultScriptingProvider, org.keycloak.protocol.oidc.AccessTokenIntrospectionProvider, org.keycloak.protocol.saml.installation.SamlSPDescriptorClientInstallation, org.keycloak.exportimport.singlefile.SingleFileExportProvider, org.keycloak.exportimport.singlefile.SingleFileImportProvider, org.keycloak.policy.HashIterationsPasswordPolicyProviderFactory, org.keycloak.services.migration.DefaultMigrationProvider, org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator, org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper, org.keycloak.services.clientregistration.AdapterInstallationClientRegistrationProvider, org.keycloak.timer.basic.BasicTimerProvider, org.keycloak.theme.FolderThemeProvider, org.keycloak.models.RealmProvider, org.keycloak.policy.HistoryPasswordPolicyProvider, org.keycloak.protocol.saml.installation.KeycloakSamlSubsystemInstallation, org.keycloak.storage.jpa.JpaUserFederatedStorageProvider, org.keycloak.authentication.authenticators.browser.CookieAuthenticator, org.keycloak.keys.AbstractGeneratedSecretKeyProvider, org.keycloak.authorization.jpa.store.JPAStoreFactory, org.keycloak.events.email.EmailEventListenerProvider, org.keycloak.authentication.authenticators.challenge.NoCookieFlowRedirectAuthenticator, org.keycloak.policy.BlacklistPasswordPolicyProvider, org.keycloak.authentication.authenticators.console.ConsoleOTPFormAuthenticator, org.keycloak.authentication.requiredactions.ConsoleTermsAndConditions, org.keycloak.models.sessions.infinispan.InfinispanCodeToTokenStoreProvider, org.keycloak.policy.RegexPatternsPasswordPolicyProvider, org.keycloak.models.sessions.infinispan.InfinispanStickySessionEncoderProvider, org.keycloak.cluster.infinispan.InfinispanClusterProvider, org.keycloak.authentication.requiredactions.ConsoleUpdateProfile, org.keycloak.exportimport.KeycloakClientDescriptionConverter, org.keycloak.policy.DefaultPasswordPolicyManagerProvider, org.keycloak.services.x509.AbstractClientCertificateFromHttpHeadersLookup, org.keycloak.theme.ClasspathThemeProvider, org.keycloak.policy.DigitsPasswordPolicyProvider, org.keycloak.policy.LowerCasePasswordPolicyProvider, org.keycloak.policy.SpecialCharsPasswordPolicyProvider, org.keycloak.policy.UpperCasePasswordPolicyProvider, org.keycloak.models.session.DisabledUserSessionPersisterProvider, org.keycloak.policy.NotUsernamePasswordPolicyProvider, org.keycloak.theme.DefaultThemeSelectorProvider, org.keycloak.connections.infinispan.DefaultInfinispanConnectionProvider, org.keycloak.provider.ExceptionConverter, org.keycloak.policy.LengthPasswordPolicyProvider, org.keycloak.authentication.forms.RegistrationPage, org.keycloak.protocol.oidc.OIDCClientDescriptionConverter, org.keycloak.theme.ClasspathThemeResourceProviderFactory, org.keycloak.policy.HashAlgorithmPasswordPolicyProviderFactory, org.keycloak.models.sessions.infinispan.InfinispanActionTokenStoreProvider, org.keycloak.authentication.authenticators.x509.X509ClientCertificateAuthenticator, org.keycloak.locale.DefaultLocaleSelectorProvider, org.keycloak.policy.ForceExpiredPasswordPolicyProviderFactory, org.keycloak.authentication.authenticators.directgrant.AbstractDirectGrantAuthenticator, org.keycloak.protocol.docker.installation.DockerComposeYamlInstallationProvider, org.keycloak.truststore.FileTruststoreProvider, org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper, org.keycloak.authentication.authenticators.AttemptedAuthenticator, org.keycloak.authorization.policy.provider.drools.DroolsPolicyProvider, org.keycloak.services.clientregistration.policy.ClientRegistrationPolicy, org.keycloak.services.x509.DefaultClientCertificateLookup, org.keycloak.connections.jpa.DefaultJpaConnectionProvider, org.keycloak.authorization.config.UmaWellKnownProvider, org.keycloak.protocol.saml.mappers.AbstractSAMLProtocolMapper, org.keycloak.urls.HostnameProvider, org.keycloak.authentication.authenticators.client.AbstractClientAuthenticator, org.keycloak.keys.KeyProvider, org.keycloak.protocol.docker.installation.DockerRegistryConfigFileInstallationProvider, org.keycloak.protocol.docker.installation.DockerVariableOverrideInstallationProvider, org.keycloak.protocol.docker.mapper.DockerAuthV2ProtocolMapper, org.keycloak.transaction.JtaTransactionManagerLookup, org.keycloak.broker.provider.AbstractIdentityProviderMapper, org.keycloak.authentication.AbstractFormAuthenticator, org.keycloak.crypto.SignatureProvider, org.keycloak.credential.CredentialProvider, org.keycloak.protocol.oidc.ext.OIDCExtProvider (計143項目)で実装されています。

finishLogout()

Response org.keycloak.protocol.LoginProtocol.finishLogout

(

UserSessionModel

userSession

)

org.keycloak.protocol.saml.SamlProtocol, org.keycloak.protocol.oidc.OIDCLoginProtocol, org.keycloak.protocol.docker.DockerAuthV2Protocolで実装されています。

frontchannelLogout()

Response org.keycloak.protocol.LoginProtocol.frontchannelLogout	(	UserSessionModel	userSession,
		AuthenticatedClientSessionModel	clientSession
	)

org.keycloak.protocol.saml.SamlProtocol, org.keycloak.protocol.oidc.OIDCLoginProtocol, org.keycloak.protocol.docker.DockerAuthV2Protocolで実装されています。

requireReauthentication()

boolean org.keycloak.protocol.LoginProtocol.requireReauthentication	(	UserSessionModel	userSession,
		AuthenticationSessionModel	authSession
	)

引数

userSession
authSession

戻り値

true if SSO cookie authentication can't be used. User will need to "actively" reauthenticate

org.keycloak.protocol.saml.SamlProtocol, org.keycloak.protocol.oidc.OIDCLoginProtocol, org.keycloak.protocol.docker.DockerAuthV2Protocolで実装されています。

sendError()

Response org.keycloak.protocol.LoginProtocol.sendError	(	AuthenticationSessionModel	authSession,
		Error	error
	)

org.keycloak.protocol.oidc.OIDCLoginProtocol, org.keycloak.protocol.saml.SamlProtocolで実装されています。

sendPushRevocationPolicyRequest()

default boolean org.keycloak.protocol.LoginProtocol.sendPushRevocationPolicyRequest ( RealmModel  realm, ClientModel  resource, int  notBefore, String  managementUrl  )

inline

Send not-before revocation policy to the given client.

引数

realm
resource
notBefore
managementUrl

戻り値

true 

if revocation policy was successfully updated at the client,

false 

otherwise.

org.keycloak.protocol.oidc.OIDCLoginProtocolで実装されています。

                                                                                                                                 {
        return false;
    }

setEventBuilder()

LoginProtocol org.keycloak.protocol.LoginProtocol.setEventBuilder

(

EventBuilder

event

)

org.keycloak.protocol.oidc.OIDCLoginProtocol, org.keycloak.protocol.saml.SamlProtocol, org.keycloak.protocol.docker.DockerAuthV2Protocolで実装されています。

setHttpHeaders()

LoginProtocol org.keycloak.protocol.LoginProtocol.setHttpHeaders

(

HttpHeaders

headers

)

org.keycloak.protocol.oidc.OIDCLoginProtocol, org.keycloak.protocol.saml.SamlProtocol, org.keycloak.protocol.docker.DockerAuthV2Protocolで実装されています。

setRealm()

LoginProtocol org.keycloak.protocol.LoginProtocol.setRealm

(

RealmModel

realm

)

org.keycloak.protocol.oidc.OIDCLoginProtocol, org.keycloak.protocol.saml.SamlProtocol, org.keycloak.protocol.docker.DockerAuthV2Protocolで実装されています。

setSession()

LoginProtocol org.keycloak.protocol.LoginProtocol.setSession

(

KeycloakSession

session

)

org.keycloak.protocol.oidc.OIDCLoginProtocol, org.keycloak.protocol.saml.SamlProtocol, org.keycloak.protocol.docker.DockerAuthV2Protocolで実装されています。

setUriInfo()

LoginProtocol org.keycloak.protocol.LoginProtocol.setUriInfo

(

UriInfo

uriInfo

)

org.keycloak.protocol.oidc.OIDCLoginProtocol, org.keycloak.protocol.saml.SamlProtocol, org.keycloak.protocol.docker.DockerAuthV2Protocolで実装されています。

---

このインタフェース詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/protocol/LoginProtocol.java