org.keycloak.storage.ldap.mappers.LDAPStorageMapper インタフェース

org.keycloak.storage.ldap.mappers.LDAPStorageMapper の継承関係図

org.keycloak.storage.ldap.mappers.LDAPStorageMapper 連携図

公開メンバ関数
SynchronizationResult	syncDataFromFederationProviderToKeycloak (RealmModel realm)
SynchronizationResult	syncDataFromKeycloakToFederationProvider (RealmModel realm)
List< UserModel >	getGroupMembers (RealmModel realm, GroupModel group, int firstResult, int maxResults)
void	onImportUserFromLDAP (LDAPObject ldapUser, UserModel user, RealmModel realm, boolean isCreate)
void	onRegisterUserToLDAP (LDAPObject ldapUser, UserModel localUser, RealmModel realm)
UserModel	proxy (LDAPObject ldapUser, UserModel delegate, RealmModel realm)
void	beforeLDAPQuery (LDAPQuery query)
boolean	onAuthenticationFailure (LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm)
void	close ()

詳解

著者

Marek Posolda

関数詳解

beforeLDAPQuery()

void org.keycloak.storage.ldap.mappers.LDAPStorageMapper.beforeLDAPQuery

(

LDAPQuery

query

)

Called before LDAP Identity query for retrieve LDAP users was executed. It allows to change query somehow (add returning attributes from LDAP, change conditions etc)

引数

query

org.keycloak.storage.ldap.mappers.membership.group.GroupLDAPStorageMapper, org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapper, org.keycloak.storage.ldap.mappers.membership.role.RoleLDAPStorageMapper, org.keycloak.storage.ldap.mappers.FullNameLDAPStorageMapper, org.keycloak.storage.ldap.mappers.HardcodedLDAPAttributeMapper, org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapper, org.keycloak.storage.ldap.mappers.msadlds.MSADLDSUserAccountControlStorageMapper, org.keycloak.storage.ldap.mappers.HardcodedLDAPRoleStorageMapper, org.keycloak.storage.ldap.mappers.HardcodedLDAPGroupStorageMapperで実装されています。

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項目)で実装されています。

getGroupMembers()

List<UserModel> org.keycloak.storage.ldap.mappers.LDAPStorageMapper.getGroupMembers	(	RealmModel	realm,
		GroupModel	group,
		int	firstResult,
		int	maxResults
	)

Return empty list if doesn't support storing of groups

org.keycloak.storage.ldap.mappers.membership.group.GroupLDAPStorageMapper, org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperで実装されています。

onAuthenticationFailure()

boolean org.keycloak.storage.ldap.mappers.LDAPStorageMapper.onAuthenticationFailure	(	LDAPObject	ldapUser,
		UserModel	user,
		AuthenticationException	ldapException,
		RealmModel	realm
	)

Called when LDAP authentication of specified user fails. If any mapper returns true from this method, AuthenticationException won't be rethrown!

引数

user
ldapUser
ldapException

戻り値

true if mapper processed the AuthenticationException and did some actions based on that. In that case, AuthenticationException won't be rethrown!

org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapper, org.keycloak.storage.ldap.mappers.msadlds.MSADLDSUserAccountControlStorageMapper, org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperで実装されています。

onImportUserFromLDAP()

void org.keycloak.storage.ldap.mappers.LDAPStorageMapper.onImportUserFromLDAP	(	LDAPObject	ldapUser,
		UserModel	user,
		RealmModel	realm,
		boolean	isCreate
	)

Called when importing user from LDAP to local keycloak DB.

引数

ldapUser
user
realm
isCreate	true if we importing new user from LDAP. False if user already exists in Keycloak, but we are upgrading (syncing) it from LDAP

org.keycloak.storage.ldap.mappers.membership.group.GroupLDAPStorageMapper, org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapper, org.keycloak.storage.ldap.mappers.HardcodedLDAPRoleStorageMapper, org.keycloak.storage.ldap.mappers.msadlds.MSADLDSUserAccountControlStorageMapper, org.keycloak.storage.ldap.mappers.HardcodedLDAPAttributeMapper, org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapper, org.keycloak.storage.ldap.mappers.HardcodedLDAPGroupStorageMapper, org.keycloak.storage.ldap.mappers.membership.role.RoleLDAPStorageMapper, org.keycloak.storage.ldap.mappers.FullNameLDAPStorageMapperで実装されています。

onRegisterUserToLDAP()

void org.keycloak.storage.ldap.mappers.LDAPStorageMapper.onRegisterUserToLDAP	(	LDAPObject	ldapUser,
		UserModel	localUser,
		RealmModel	realm
	)

Called when register new user to LDAP - just after user was created in Keycloak DB

引数

ldapUser
localUser
realm

org.keycloak.storage.ldap.mappers.membership.group.GroupLDAPStorageMapper, org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapper, org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapper, org.keycloak.storage.ldap.mappers.HardcodedLDAPRoleStorageMapper, org.keycloak.storage.ldap.mappers.msadlds.MSADLDSUserAccountControlStorageMapper, org.keycloak.storage.ldap.mappers.membership.role.RoleLDAPStorageMapper, org.keycloak.storage.ldap.mappers.HardcodedLDAPGroupStorageMapper, org.keycloak.storage.ldap.mappers.FullNameLDAPStorageMapper, org.keycloak.storage.ldap.mappers.HardcodedLDAPAttributeMapperで実装されています。

proxy()

UserModel org.keycloak.storage.ldap.mappers.LDAPStorageMapper.proxy	(	LDAPObject	ldapUser,
		UserModel	delegate,
		RealmModel	realm
	)

Called when invoke proxy on LDAP federation provider

引数

ldapUser
delegate
realm

戻り値

org.keycloak.storage.ldap.mappers.membership.group.GroupLDAPStorageMapper, org.keycloak.storage.ldap.mappers.membership.role.RoleLDAPStorageMapper, org.keycloak.storage.ldap.mappers.UserAttributeLDAPStorageMapper, org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapper, org.keycloak.storage.ldap.mappers.msadlds.MSADLDSUserAccountControlStorageMapper, org.keycloak.storage.ldap.mappers.HardcodedLDAPAttributeMapper, org.keycloak.storage.ldap.mappers.FullNameLDAPStorageMapper, org.keycloak.storage.ldap.mappers.HardcodedLDAPRoleStorageMapper, org.keycloak.storage.ldap.mappers.HardcodedLDAPGroupStorageMapperで実装されています。

syncDataFromFederationProviderToKeycloak()

SynchronizationResult org.keycloak.storage.ldap.mappers.LDAPStorageMapper.syncDataFromFederationProviderToKeycloak

(

RealmModel

realm

)

Sync data from federated storage to Keycloak. It's useful just if mapper needs some data preloaded from federated storage (For example load roles from federated provider and sync them to Keycloak database)

Applicable just if sync is supported

org.keycloak.storage.ldap.mappers.membership.group.GroupLDAPStorageMapper, org.keycloak.storage.ldap.mappers.membership.role.RoleLDAPStorageMapper, org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperで実装されています。

syncDataFromKeycloakToFederationProvider()

SynchronizationResult org.keycloak.storage.ldap.mappers.LDAPStorageMapper.syncDataFromKeycloakToFederationProvider

(

RealmModel

realm

)

Sync data from Keycloak back to federated storage

org.keycloak.storage.ldap.mappers.membership.group.GroupLDAPStorageMapper, org.keycloak.storage.ldap.mappers.membership.role.RoleLDAPStorageMapper, org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperで実装されています。

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/storage/ldap/mappers/LDAPStorageMapper.java