org.keycloak.storage.ldap.idm.query.internal.LDAPQuery クラス

org.keycloak.storage.ldap.idm.query.internal.LDAPQuery 連携図

公開メンバ関数
	LDAPQuery (LDAPStorageProvider ldapProvider)
LDAPQuery	addWhereCondition (Condition... condition)
LDAPQuery	sortBy (Sort... sorts)
LDAPQuery	setSearchDn (String searchDn)
LDAPQuery	addObjectClasses (Collection< String > objectClasses)
LDAPQuery	addReturningLdapAttribute (String ldapAttributeName)
LDAPQuery	addReturningReadOnlyLdapAttribute (String ldapAttributeName)
LDAPQuery	addMappers (Collection< ComponentModel > mappers)
LDAPQuery	setSearchScope (int searchScope)
Set< Sort >	getSorting ()
String	getSearchDn ()
Set< String >	getObjectClasses ()
Set< String >	getReturningLdapAttributes ()
Set< String >	getReturningReadOnlyLdapAttributes ()
List< ComponentModel >	getMappers ()
int	getSearchScope ()
int	getLimit ()
int	getOffset ()
byte []	getPaginationContext ()
List< LDAPObject >	getResultList ()
LDAPObject	getFirstResult ()
int	getResultCount ()
LDAPQuery	setOffset (int offset)
LDAPQuery	setLimit (int limit)
LDAPQuery	setPaginationContext (byte[] paginationContext)
Set< Condition >	getConditions ()
LDAPStorageProvider	getLdapProvider ()

非公開変数類
final LDAPStorageProvider	ldapFedProvider
int	offset
int	limit
byte []	paginationContext
String	searchDn
final Set< Condition >	conditions = new LinkedHashSet<Condition>()
final Set< Sort >	ordering = new LinkedHashSet<Sort>()
final Set< String >	returningLdapAttributes = new LinkedHashSet<String>()
final Set< String >	returningReadOnlyLdapAttributes = new LinkedHashSet<String>()
final Set< String >	objectClasses = new LinkedHashSet<String>()
final List< ComponentModel >	mappers = new ArrayList<>()
int	searchScope = SearchControls.SUBTREE_SCOPE

詳解

Default IdentityQuery implementation.

著者

Shane Bryzak

構築子と解体子

LDAPQuery()

org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.LDAPQuery ( LDAPStorageProvider  ldapProvider )

inline

                                                       {
        this.ldapFedProvider = ldapProvider;
    }

関数詳解

addMappers()

LDAPQuery org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.addMappers ( Collection< ComponentModel >  mappers )

inline

                                                                    {
        this.mappers.addAll(mappers);
        return this;
    }

addObjectClasses()

LDAPQuery org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.addObjectClasses ( Collection< String >  objectClasses )

inline

                                                                        {
        this.objectClasses.addAll(objectClasses);
        return this;
    }

addReturningLdapAttribute()

LDAPQuery org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.addReturningLdapAttribute ( String  ldapAttributeName )

inline

                                                                         {
        this.returningLdapAttributes.add(ldapAttributeName);
        return this;
    }

addReturningReadOnlyLdapAttribute()

LDAPQuery org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.addReturningReadOnlyLdapAttribute ( String  ldapAttributeName )

inline

                                                                                 {
        this.returningReadOnlyLdapAttributes.add(ldapAttributeName.toLowerCase());
        return this;
    }

addWhereCondition()

LDAPQuery org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.addWhereCondition ( Condition...  condition )

inline

                                                               {
        this.conditions.addAll(Arrays.asList(condition));
        return this;
    }

getConditions()

Set<Condition> org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.getConditions ( )

inline

                                          {
        return this.conditions;
    }

getFirstResult()

LDAPObject org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.getFirstResult ( )

inline

                                       {
        List<LDAPObject> results = getResultList();

        if (results.isEmpty()) {
            return null;
        } else if (results.size() == 1) {
            return results.get(0);
        } else {
            throw new ModelDuplicateException("Error - multiple LDAP objects found but expected just one");
        }
    }

getLdapProvider()

LDAPStorageProvider org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.getLdapProvider ( )

inline

                                                 {
        return ldapFedProvider;
    }

getLimit()

int org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.getLimit ( )

inline

                          {
        return limit;
    }

getMappers()

List<ComponentModel> org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.getMappers ( )

inline

                                             {
        return mappers;
    }

getObjectClasses()

Set<String> org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.getObjectClasses ( )

inline

                                          {
        return unmodifiableSet(this.objectClasses);
    }

getOffset()

int org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.getOffset ( )

inline

                           {
        return offset;
    }

getPaginationContext()

byte [] org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.getPaginationContext ( )

inline

                                         {
        return paginationContext;
    }

getResultCount()

int org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.getResultCount ( )

inline

                                {
        return ldapFedProvider.getLdapIdentityStore().countQueryResults(this);
    }

getResultList()

List<LDAPObject> org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.getResultList ( )

inline

                                            {

        // Apply mappers now
        List<ComponentModel> sortedMappers = ldapFedProvider.getMapperManager().sortMappersAsc(mappers);
        for (ComponentModel mapperModel : sortedMappers) {
            LDAPStorageMapper fedMapper = ldapFedProvider.getMapperManager().getMapper(mapperModel);
            fedMapper.beforeLDAPQuery(this);
        }

        List<LDAPObject> result = new ArrayList<LDAPObject>();

        try {
            for (LDAPObject ldapObject : ldapFedProvider.getLdapIdentityStore().fetchQueryResults(this)) {
                result.add(ldapObject);
            }
        } catch (Exception e) {
            throw new ModelException("LDAP Query failed", e);
        }

        return result;
    }

getReturningLdapAttributes()

Set<String> org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.getReturningLdapAttributes ( )

inline

                                                    {
        return unmodifiableSet(this.returningLdapAttributes);
    }

getReturningReadOnlyLdapAttributes()

Set<String> org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.getReturningReadOnlyLdapAttributes ( )

inline

                                                            {
        return unmodifiableSet(this.returningReadOnlyLdapAttributes);
    }

getSearchDn()

String org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.getSearchDn ( )

inline

                                {
        return this.searchDn;
    }

getSearchScope()

int org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.getSearchScope ( )

inline

                                {
        return searchScope;
    }

getSorting()

Set<Sort> org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.getSorting ( )

inline

                                  {
        return unmodifiableSet(this.ordering);
    }

setLimit()

LDAPQuery org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.setLimit ( int  limit )

inline

                                         {
        this.limit = limit;
        return this;
    }

setOffset()

LDAPQuery org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.setOffset ( int  offset )

inline

                                           {
        this.offset = offset;
        return this;
    }

setPaginationContext()

LDAPQuery org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.setPaginationContext ( byte []  paginationContext )

inline

                                                                    {
        this.paginationContext = paginationContext;
        return this;
    }

setSearchDn()

LDAPQuery org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.setSearchDn ( String  searchDn )

inline

                                                  {
        this.searchDn = searchDn;
        return this;
    }

setSearchScope()

LDAPQuery org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.setSearchScope ( int  searchScope )

inline

                                                     {
        this.searchScope = searchScope;
        return this;
    }

sortBy()

LDAPQuery org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.sortBy ( Sort...  sorts )

inline

                                           {
        this.ordering.addAll(Arrays.asList(sorts));
        return this;
    }

メンバ詳解

conditions

final Set<Condition> org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.conditions = new LinkedHashSet<Condition>()

private

ldapFedProvider

final LDAPStorageProvider org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.ldapFedProvider

private

limit

int org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.limit

private

mappers

final List<ComponentModel> org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.mappers = new ArrayList<>()

private

objectClasses

final Set<String> org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.objectClasses = new LinkedHashSet<String>()

private

offset

int org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.offset

private

ordering

final Set<Sort> org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.ordering = new LinkedHashSet<Sort>()

private

paginationContext

byte [] org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.paginationContext

private

returningLdapAttributes

final Set<String> org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.returningLdapAttributes = new LinkedHashSet<String>()

private

returningReadOnlyLdapAttributes

final Set<String> org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.returningReadOnlyLdapAttributes = new LinkedHashSet<String>()

private

searchDn

String org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.searchDn

private

searchScope

int org.keycloak.storage.ldap.idm.query.internal.LDAPQuery.searchScope = SearchControls.SUBTREE_SCOPE

private

---

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

• D:/AppData/doxygen/keycloak/federation/src/federation/ldap/src/main/java/org/keycloak/storage/ldap/idm/query/internal/LDAPQuery.java