org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper クラス

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

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

公開メンバ関数
	AbstractLDAPStorageMapper (ComponentModel mapperModel, LDAPStorageProvider ldapProvider)
SynchronizationResult	syncDataFromFederationProviderToKeycloak (RealmModel realm)
SynchronizationResult	syncDataFromKeycloakToFederationProvider (RealmModel realm)
List< UserModel >	getGroupMembers (RealmModel realm, GroupModel group, int firstResult, int maxResults)
boolean	onAuthenticationFailure (LDAPObject ldapUser, UserModel user, AuthenticationException ldapException, RealmModel realm)
LDAPStorageProvider	getLdapProvider ()
void	close ()
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)

静的公開メンバ関数
static boolean	parseBooleanParameter (ComponentModel mapperModel, String paramName)

限定公開変数類
final KeycloakSession	session
final ComponentModel	mapperModel
final LDAPStorageProvider	ldapProvider

詳解

Stateful per-request object

著者

Marek Posolda

構築子と解体子

AbstractLDAPStorageMapper()

org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper.AbstractLDAPStorageMapper ( ComponentModel  mapperModel, LDAPStorageProvider  ldapProvider  )

inline

                                                                                                   {
        this.mapperModel = mapperModel;
        this.ldapProvider = ldapProvider;
        this.session = ldapProvider.getSession();
    }

関数詳解

beforeLDAPQuery()

void org.keycloak.storage.ldap.mappers.LDAPStorageMapper.beforeLDAPQuery ( LDAPQuery  query )

inherited

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.storage.ldap.mappers.AbstractLDAPStorageMapper.close ( )

inline

org.keycloak.provider.Providerを実装しています。

                        {

    }

getGroupMembers()

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

inline

org.keycloak.storage.ldap.mappers.LDAPStorageMapperを実装しています。

                                                                                                                {
        return Collections.emptyList();
    }

getLdapProvider()

LDAPStorageProvider org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper.getLdapProvider ( )

inline

                                                 {
        return ldapProvider;
    }

onAuthenticationFailure()

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

inline

org.keycloak.storage.ldap.mappers.LDAPStorageMapperを実装しています。

                                                                                                                                         {
        return false;
    }

onImportUserFromLDAP()

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

inherited

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  )

inherited

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

parseBooleanParameter()

static boolean org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper.parseBooleanParameter ( ComponentModel  mapperModel, String  paramName  )

inlinestatic

                                                                                              {
        String paramm = mapperModel.getConfig().getFirst(paramName);
        return Boolean.parseBoolean(paramm);
    }

proxy()

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

inherited

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.AbstractLDAPStorageMapper.syncDataFromFederationProviderToKeycloak ( RealmModel  realm )

inline

org.keycloak.storage.ldap.mappers.LDAPStorageMapperを実装しています。

                                                                                            {
        return new SynchronizationResult();
    }

syncDataFromKeycloakToFederationProvider()

SynchronizationResult org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper.syncDataFromKeycloakToFederationProvider ( RealmModel  realm )

inline

org.keycloak.storage.ldap.mappers.LDAPStorageMapperを実装しています。

                                                                                            {
        return new SynchronizationResult();
    }

メンバ詳解

ldapProvider

final LDAPStorageProvider org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper.ldapProvider

protected

mapperModel

final ComponentModel org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper.mapperModel

protected

session

final KeycloakSession org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper.session

protected

---

このクラス詳解は次のファイルから抽出されました:

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