Package com.flowable.idm.engine.ldap

Class LdapUserQuery

java.lang.Object

org.flowable.common.engine.impl.db.ListQueryParameterObject

org.flowable.common.engine.impl.query.AbstractQuery<T,U>

com.flowable.idm.engine.ldap.AbstractLdapQuery<PlatformUserQuery,PlatformUser>

com.flowable.idm.engine.ldap.LdapUserQuery

All Implemented Interfaces:

PlatformUserQuery, Serializable, Query<PlatformUserQuery,PlatformUser>, Command<Object>, UserBaseQuery<PlatformUserQuery,PlatformUser>

public class LdapUserQuery
extends AbstractLdapQuery<PlatformUserQuery,PlatformUser>
implements PlatformUserQuery

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

ListQueryParameterObject.OrderBy, ListQueryParameterObject.ResultType

Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query

Query.NullHandlingOnOrder

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Map<String,String>	COLUMN_TO_PROPERTY_MAPPING
protected static final QueryProperty	EMAIL
protected static final QueryProperty	FIRST_NAME
protected final PlatformIdentityService	identityService
protected boolean	includeIdentityInfo
protected static final QueryProperty	LAST_NAME
protected String	memberOfGroup
protected String	memberOfGroupKey
protected Collection<String>	memberOfGroupKeys
protected Collection<String>	memberOfGroupKeysForOr
protected Collection<String>	memberOfGroups
protected String	tenantId
protected static final QueryProperty	USER_ID
protected String	userDefinitionKey
protected Collection<String>	userIdsForOr

Fields inherited from class com.flowable.idm.engine.ldap.AbstractLdapQuery

filtersMap, ldapConfiguration, logger

Fields inherited from class org.flowable.common.engine.impl.query.AbstractQuery

commandContext, commandExecutor

Fields inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

databaseType, DEFAULT_ORDER_BY, defaultOrderBy, firstResult, maxResults, nullHandlingColumn, nullHandlingOnOrder, orderByCollection, orderProperty, parameter, resultType, SORTORDER_ASC, SORTORDER_DESC

Constructor Summary

Constructors

Constructor	Description
LdapUserQuery(LdapConfigurationApi ldapConfiguration, PlatformIdentityService identityService)

Method Summary

Modifier and Type	Method	Description
PlatformUserQuery	accessibleByUser(String userId)	Query all users that are accessible by the user with the provided userId.
PlatformUserQuery	accessibleByUserWithUserDefinitionKey(String userId, String userDefinitionKey)	Query all users that are accessible by the user with the provided userId and userDefinitionKey.
PlatformUserQuery	active()
PlatformUserQuery	createAfter(Date createdAfter)
PlatformUserQuery	createdBefore(Date createdBefore)
protected AttributesMapper<PlatformUser>	getAttributesMapper()
protected String	getDistinguishedName()
protected DistinguishedNameProvider	getDistinguishedNameProvider()
protected String	getQueryBase()
protected SortProperties	getSort()
protected Collection<String>	getSortAttributes(String sortProperty)
protected String	getSortProperty(String columnName)
protected PlatformUserQuery	getThis()
protected AttributesMapper<PlatformUser>	getUserAttributesMapper()
protected LdapUserProperties.Mappings	getUserMappings()
protected LdapUserProperties	getUserProperties()
PlatformUserQuery	includeIdentityInfo()	Query the user including the extra identity info.
PlatformUserQuery	infoEquals(String name, Object value)	Checks for a user with the given info name and value.
PlatformUserQuery	infoEqualsIgnoreCase(String name, String value)	Checks for a user with the given info name and value ignoring the case of the value.
PlatformUserQuery	infoValueLike(String name, String valueLike)	Checks for a user with the given info name and value like.
PlatformUserQuery	infoValueLikeIgnoreCase(String name, String valueLike)	Checks for a user with the given info name and value like ignoring the case of the value.
protected PlatformUser	mapWithDbInfos(Attributes attributes)
protected Filter	memberOfFilter(Collection<String> groupDns)
PlatformUserQuery	memberOfGroup(String groupId)
PlatformUserQuery	memberOfGroupKey(String groupKey)	Only select PlatformUsers that belong to the group with the given key.
PlatformUserQuery	memberOfGroupKeys(Collection<String> groupKeys)	Only select PlatformUsers that belong to the groups with the given keys.
PlatformUserQuery	memberOfGroups(List<String> groupIds)
PlatformUserQuery	orderByUserEmail()
PlatformUserQuery	orderByUserFirstName()
PlatformUserQuery	orderByUserId()
PlatformUserQuery	orderByUserLastName()
protected Filter	prepareQueryFilter()
PlatformUserQuery	presence(String presence)	Query for users with the given presence status.
PlatformUserQuery	state(String state)
PlatformUserQuery	subState(String subState)
PlatformUserQuery	subType(String subType)
PlatformUserQuery	tenantId(String tenantId)
PlatformUserQuery	type(String type)	Query for users of the given type
PlatformUserQuery	userDefinitionKey(String userDefinitionKey)
PlatformUserQuery	userDisplayName(String displayName)
PlatformUserQuery	userDisplayNameLike(String displayNameLike)
PlatformUserQuery	userDisplayNameLikeIgnoreCase(String displayNameLikeIgnoreCase)
PlatformUserQuery	userEmail(String email)
PlatformUserQuery	userEmailLike(String emailLike)
PlatformUserQuery	userFirstName(String firstName)
PlatformUserQuery	userFirstNameLike(String firstNameLike)
PlatformUserQuery	userFirstNameLikeIgnoreCase(String firstNameLikeIgnoreCase)
PlatformUserQuery	userFullNameLike(String fullNameLike)
protected PlatformUserQuery	userFullNameLike(String filterKey, String fullNameLike)
PlatformUserQuery	userFullNameLikeIgnoreCase(String fullNameLikeIgnoreCase)
PlatformUserQuery	userId(String id)
PlatformUserQuery	userIdIgnoreCase(String id)
PlatformUserQuery	userIds(List<String> ids)
protected Filter	userIdsFilter(Collection<String> userIds)
PlatformUserQuery	userIdsNotIn(List<String> ids)
PlatformUserQuery	userIdsOrMemberOfGroupKeys(Collection<String> userIds, Collection<String> groupKeys)	Only select PlatformUsers with the given user ids or that belong to the groups with the given keys.
PlatformUserQuery	userLastName(String lastName)
PlatformUserQuery	userLastNameLike(String lastNameLike)
PlatformUserQuery	userLastNameLikeIgnoreCase(String lastNameLikeIgnoreCase)
protected PlatformUserQuery	with(String filterKey, Collection<String> attributeNames, String value, BiFunction<String,String,Filter> filterCreator)
protected PlatformUserQuery	withInfo(String filterKey, String infoName, String value, BiFunction<String,String,Filter> filterCreator)
PlatformUserQuery	withoutTenantId()	Query only users belonging to no tenant.

Methods inherited from class com.flowable.idm.engine.ldap.AbstractLdapQuery

createDirContextProcessorForSort, createFilter, createSearchControlsForQuery, executeCount, executeList, getLdapOperations, withFilter

Methods inherited from class org.flowable.common.engine.impl.query.AbstractQuery

asc, checkQueryOk, count, desc, direction, execute, executeSingleResult, list, listPage, orderBy, orderBy, setCommandExecutor, singleResult

Methods inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

addOrder, buildOrderBy, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getNullHandlingColumn, getOrderBy, getOrderByCollectionSafe, getOrderByForWindow, getOuterJoinOrderBy, getParameter, hasOrderBy, hasOrderByForColumn, isNeedsPaging, mapOrderByToSql, setDatabaseType, setFirstResult, setMaxResults, setNullHandlingColumn, setParameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.flowable.common.engine.api.query.Query

asc, count, desc, list, listPage, orderBy, orderBy, singleResult

Field Details

USER_ID

protected static final QueryProperty USER_ID

FIRST_NAME

protected static final QueryProperty FIRST_NAME

LAST_NAME

protected static final QueryProperty LAST_NAME

EMAIL

protected static final QueryProperty EMAIL

COLUMN_TO_PROPERTY_MAPPING

protected static final Map<String,String> COLUMN_TO_PROPERTY_MAPPING

identityService

protected final PlatformIdentityService identityService

includeIdentityInfo

protected boolean includeIdentityInfo

memberOfGroup

protected String memberOfGroup

memberOfGroups

protected Collection<String> memberOfGroups

memberOfGroupKey

protected String memberOfGroupKey

memberOfGroupKeys

protected Collection<String> memberOfGroupKeys

userIdsForOr

protected Collection<String> userIdsForOr

memberOfGroupKeysForOr

protected Collection<String> memberOfGroupKeysForOr

userDefinitionKey

protected String userDefinitionKey

tenantId

protected String tenantId

Constructor Details

LdapUserQuery

public LdapUserQuery(LdapConfigurationApi ldapConfiguration,
 PlatformIdentityService identityService)

Method Details

mapWithDbInfos

protected PlatformUser mapWithDbInfos(Attributes attributes)
                               throws NamingException

Throws:

NamingException

prepareQueryFilter

protected Filter prepareQueryFilter()

Specified by:

prepareQueryFilter in class AbstractLdapQuery<PlatformUserQuery,PlatformUser>

memberOfFilter

protected Filter memberOfFilter(Collection<String> groupDns)

userIdsFilter

protected Filter userIdsFilter(Collection<String> userIds)

includeIdentityInfo

public PlatformUserQuery includeIdentityInfo()

Description copied from interface: PlatformUserQuery

Query the user including the extra identity info. Implementations are allowed to include the identity info even without explicitly invoking this.

Specified by:

includeIdentityInfo in interface PlatformUserQuery

userDisplayName

public PlatformUserQuery userDisplayName(String displayName)

Specified by:

userDisplayName in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

userDisplayNameLike

public PlatformUserQuery userDisplayNameLike(String displayNameLike)

Specified by:

userDisplayNameLike in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

userDisplayNameLikeIgnoreCase

public PlatformUserQuery userDisplayNameLikeIgnoreCase(String displayNameLikeIgnoreCase)

Specified by:

userDisplayNameLikeIgnoreCase in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

accessibleByUser

public PlatformUserQuery accessibleByUser(String userId)

Description copied from interface: PlatformUserQuery

Query all users that are accessible by the user with the provided userId.

Specified by:

accessibleByUser in interface PlatformUserQuery

Parameters:

userId - the if of the user for which users should be queried

accessibleByUserWithUserDefinitionKey

public PlatformUserQuery accessibleByUserWithUserDefinitionKey(String userId,
 String userDefinitionKey)

Description copied from interface: PlatformUserQuery

Query all users that are accessible by the user with the provided userId and userDefinitionKey.

Specified by:

accessibleByUserWithUserDefinitionKey in interface PlatformUserQuery

Parameters:

userId - the id of the user for which users should be queried

userDefinitionKey - the user definition key for the user for which users should be queried

active

public PlatformUserQuery active()

Specified by:

active in interface PlatformUserQuery

state

public PlatformUserQuery state(String state)

Specified by:

state in interface PlatformUserQuery

subState

public PlatformUserQuery subState(String subState)

Specified by:

subState in interface PlatformUserQuery

userIdsNotIn

public PlatformUserQuery userIdsNotIn(List<String> ids)

Specified by:

userIdsNotIn in interface PlatformUserQuery

userDefinitionKey

public PlatformUserQuery userDefinitionKey(String userDefinitionKey)

Specified by:

userDefinitionKey in interface PlatformUserQuery

type

public PlatformUserQuery type(String type)

Description copied from interface: PlatformUserQuery

Query for users of the given type

Specified by:

type in interface PlatformUserQuery

See Also:

• for known user types

subType

public PlatformUserQuery subType(String subType)

Specified by:

subType in interface PlatformUserQuery

presence

public PlatformUserQuery presence(String presence)

Description copied from interface: PlatformUserQuery

Query for users with the given presence status.

Specified by:

presence in interface PlatformUserQuery

See Also:

• for known presence states

infoEquals

public PlatformUserQuery infoEquals(String name,
 Object value)

Description copied from interface: PlatformUserQuery

Checks for a user with the given info name and value.

Specified by:

infoEquals in interface PlatformUserQuery

Parameters:

name - the name of the info

value - the value that the info should have

infoEqualsIgnoreCase

public PlatformUserQuery infoEqualsIgnoreCase(String name,
 String value)

Description copied from interface: PlatformUserQuery

Checks for a user with the given info name and value ignoring the case of the value.

Specified by:

infoEqualsIgnoreCase in interface PlatformUserQuery

Parameters:

name - the name of the info

value - the value that the info should have

infoValueLike

public PlatformUserQuery infoValueLike(String name,
 String valueLike)

Description copied from interface: PlatformUserQuery

Checks for a user with the given info name and value like.

Specified by:

infoValueLike in interface PlatformUserQuery

Parameters:

name - the name of the info

valueLike - the value like the info should have ('%' has to be added by the caller itself)

infoValueLikeIgnoreCase

public PlatformUserQuery infoValueLikeIgnoreCase(String name,
 String valueLike)

Description copied from interface: PlatformUserQuery

Checks for a user with the given info name and value like ignoring the case of the value.

Specified by:

infoValueLikeIgnoreCase in interface PlatformUserQuery

Parameters:

name - the name of the info

valueLike - the value like the info should have ('%' has to be added by the caller itself)

createdBefore

public PlatformUserQuery createdBefore(Date createdBefore)

Specified by:

createdBefore in interface PlatformUserQuery

createAfter

public PlatformUserQuery createAfter(Date createdAfter)

Specified by:

createAfter in interface PlatformUserQuery

tenantId

public PlatformUserQuery tenantId(String tenantId)

Specified by:

tenantId in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

withoutTenantId

public PlatformUserQuery withoutTenantId()

Description copied from interface: PlatformUserQuery

Query only users belonging to no tenant.

Specified by:

withoutTenantId in interface PlatformUserQuery

memberOfGroupKey

public PlatformUserQuery memberOfGroupKey(String groupKey)

Description copied from interface: PlatformUserQuery

Only select PlatformUsers that belong to the group with the given key.

Specified by:

memberOfGroupKey in interface PlatformUserQuery

memberOfGroupKeys

public PlatformUserQuery memberOfGroupKeys(Collection<String> groupKeys)

Description copied from interface: PlatformUserQuery

Only select PlatformUsers that belong to the groups with the given keys.

Specified by:

memberOfGroupKeys in interface PlatformUserQuery

userId

public PlatformUserQuery userId(String id)

Specified by:

userId in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

userIds

public PlatformUserQuery userIds(List<String> ids)

Specified by:

userIds in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

userIdIgnoreCase

public PlatformUserQuery userIdIgnoreCase(String id)

Specified by:

userIdIgnoreCase in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

userFirstName

public PlatformUserQuery userFirstName(String firstName)

Specified by:

userFirstName in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

userFirstNameLike

public PlatformUserQuery userFirstNameLike(String firstNameLike)

Specified by:

userFirstNameLike in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

userFirstNameLikeIgnoreCase

public PlatformUserQuery userFirstNameLikeIgnoreCase(String firstNameLikeIgnoreCase)

Specified by:

userFirstNameLikeIgnoreCase in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

userLastName

public PlatformUserQuery userLastName(String lastName)

Specified by:

userLastName in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

userLastNameLike

public PlatformUserQuery userLastNameLike(String lastNameLike)

Specified by:

userLastNameLike in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

userLastNameLikeIgnoreCase

public PlatformUserQuery userLastNameLikeIgnoreCase(String lastNameLikeIgnoreCase)

Specified by:

userLastNameLikeIgnoreCase in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

userFullNameLike

public PlatformUserQuery userFullNameLike(String fullNameLike)

Specified by:

userFullNameLike in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

userFullNameLikeIgnoreCase

public PlatformUserQuery userFullNameLikeIgnoreCase(String fullNameLikeIgnoreCase)

Specified by:

userFullNameLikeIgnoreCase in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

userFullNameLike

protected PlatformUserQuery userFullNameLike(String filterKey,
 String fullNameLike)

userEmail

public PlatformUserQuery userEmail(String email)

Specified by:

userEmail in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

userEmailLike

public PlatformUserQuery userEmailLike(String emailLike)

Specified by:

userEmailLike in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

memberOfGroup

public PlatformUserQuery memberOfGroup(String groupId)

Specified by:

memberOfGroup in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

memberOfGroups

public PlatformUserQuery memberOfGroups(List<String> groupIds)

Specified by:

memberOfGroups in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

userIdsOrMemberOfGroupKeys

public PlatformUserQuery userIdsOrMemberOfGroupKeys(Collection<String> userIds,
 Collection<String> groupKeys)

Description copied from interface: PlatformUserQuery

Only select PlatformUsers with the given user ids or that belong to the groups with the given keys.

Specified by:

userIdsOrMemberOfGroupKeys in interface PlatformUserQuery

orderByUserId

public PlatformUserQuery orderByUserId()

Specified by:

orderByUserId in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

orderByUserFirstName

public PlatformUserQuery orderByUserFirstName()

Specified by:

orderByUserFirstName in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

orderByUserLastName

public PlatformUserQuery orderByUserLastName()

Specified by:

orderByUserLastName in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

orderByUserEmail

public PlatformUserQuery orderByUserEmail()

Specified by:

orderByUserEmail in interface UserBaseQuery<PlatformUserQuery,PlatformUser>

withInfo

protected PlatformUserQuery withInfo(String filterKey,
 String infoName,
 String value,
 BiFunction<String,String,Filter> filterCreator)

with

protected PlatformUserQuery with(String filterKey,
 Collection<String> attributeNames,
 String value,
 BiFunction<String,String,Filter> filterCreator)

getUserMappings

protected LdapUserProperties.Mappings getUserMappings()

getUserProperties

protected LdapUserProperties getUserProperties()

getDistinguishedNameProvider

protected DistinguishedNameProvider getDistinguishedNameProvider()

getUserAttributesMapper

protected AttributesMapper<PlatformUser> getUserAttributesMapper()

getQueryBase

protected String getQueryBase()

Specified by:

getQueryBase in class AbstractLdapQuery<PlatformUserQuery,PlatformUser>

getAttributesMapper

protected AttributesMapper<PlatformUser> getAttributesMapper()

Specified by:

getAttributesMapper in class AbstractLdapQuery<PlatformUserQuery,PlatformUser>

getDistinguishedName

protected String getDistinguishedName()

Specified by:

getDistinguishedName in class AbstractLdapQuery<PlatformUserQuery,PlatformUser>

getSort

protected SortProperties getSort()

Specified by:

getSort in class AbstractLdapQuery<PlatformUserQuery,PlatformUser>

getSortProperty

protected String getSortProperty(String columnName)

Specified by:

getSortProperty in class AbstractLdapQuery<PlatformUserQuery,PlatformUser>

getSortAttributes

protected Collection<String> getSortAttributes(String sortProperty)

Specified by:

getSortAttributes in class AbstractLdapQuery<PlatformUserQuery,PlatformUser>

getThis

protected PlatformUserQuery getThis()

Specified by:

getThis in class AbstractLdapQuery<PlatformUserQuery,PlatformUser>