Package com.flowable.idm.engine.ldap

Class LdapGroupQuery

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<PlatformGroupQuery,PlatformGroup>

com.flowable.idm.engine.ldap.LdapGroupQuery

All Implemented Interfaces:

PlatformGroupQuery, Serializable, Query<PlatformGroupQuery,PlatformGroup>, Command<Object>

public class LdapGroupQuery
extends AbstractLdapQuery<PlatformGroupQuery,PlatformGroup>
implements PlatformGroupQuery

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	GROUP_ID
protected static final QueryProperty	GROUP_NAME
protected static final QueryProperty	GROUP_TYPE
protected String	groupMember
protected String	groupMemberDn
protected List<String>	groupMembers
protected String	tenantId

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

Modifier	Constructor	Description
protected	LdapGroupQuery(LdapConfigurationApi ldapConfiguration)

Method Summary

Modifier and Type	Method	Description
protected AttributesMapper<PlatformGroup>	getAttributesMapper()
protected String	getDistinguishedName()
protected DistinguishedNameProvider	getDistinguishedNameProvider()
protected LdapGroupProperties.Mappings	getGroupMappings()
protected LdapGroupProperties	getGroupProperties()
protected String	getQueryBase()
protected SortProperties	getSort()
protected Collection<String>	getSortAttributes(String sortProperty)
protected String	getSortProperty(String columnName)
protected PlatformGroupQuery	getThis()
PlatformGroupQuery	groupId(String groupId)	Only select PlatformGroups with the given id.
PlatformGroupQuery	groupIds(List<String> groupIds)	Only select PlatformGroups with the given ids.
PlatformGroupQuery	groupKey(String groupKey)	Only select PlatformGroups which have the given key.
PlatformGroupQuery	groupKeys(List<String> groupKeys)	Only select PlatformGroups which have the given keys.
PlatformGroupQuery	groupMember(String groupMemberUserId)	Only selects PlatformGroups where the given user is a member of.
PlatformGroupQuery	groupMemberDn(String groupMemberDn)	Only selects PlatformGroups where the users with the given distinguished name is a member of.
PlatformGroupQuery	groupMembers(List<String> groupMemberUserIds)	Only selects PlatformGroups where the given users are a member of.
PlatformGroupQuery	groupName(String groupName)	Only select PlatformGroups with the given name.
PlatformGroupQuery	groupNameLike(String groupNameLike)	Only select PlatformGroups where the name matches the given parameter.
PlatformGroupQuery	groupNameLikeIgnoreCase(String groupNameLikeIgnoreCase)	Only select PlatformGroups where the name matches the given parameter (ignoring case).
PlatformGroupQuery	groupTenantId(String tenantId)	Only select PlatformGroups which have the given tenant id.
PlatformGroupQuery	groupType(String groupType)	Only select PlatformGroups which have the given type.
PlatformGroupQuery	infoEquals(String name, Object value)	Checks for a group with the given info name and value.
PlatformGroupQuery	infoEqualsIgnoreCase(String name, String value)	Checks for a group with the given info name and value ignoring the case of the value.
PlatformGroupQuery	infoValueLike(String name, String valueLike)	Checks for a group with the given info name and value like.
PlatformGroupQuery	infoValueLikeIgnoreCase(String name, String valueLike)	Checks for a group with the given info name and value like ignoring the case of the value.
protected Filter	memberFilter(Collection<String> memberDns)
PlatformGroupQuery	orderByGroupId()	Order by group id (needs to be followed by Query.asc() or Query.desc()).
PlatformGroupQuery	orderByGroupName()	Order by group name (needs to be followed by Query.asc() or Query.desc()).
PlatformGroupQuery	orderByGroupType()	Order by group type (needs to be followed by Query.asc() or Query.desc()).
protected Filter	prepareQueryFilter()
protected PlatformGroupQuery	with(String filterKey, Collection<String> attributeNames, String value, BiFunction<String,String,Filter> filterCreator)
protected PlatformGroupQuery	withInfo(String filterKey, String infoName, String value, BiFunction<String,String,Filter> filterCreator)
PlatformGroupQuery	withoutTenantId()	Only select PlatformGroups which have no tenant id.

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

GROUP_ID

protected static final QueryProperty GROUP_ID

GROUP_NAME

protected static final QueryProperty GROUP_NAME

GROUP_TYPE

protected static final QueryProperty GROUP_TYPE

COLUMN_TO_PROPERTY_MAPPING

protected static final Map<String,String> COLUMN_TO_PROPERTY_MAPPING

groupMember

protected String groupMember

groupMembers

protected List<String> groupMembers

groupMemberDn

protected String groupMemberDn

tenantId

protected String tenantId

Constructor Details

LdapGroupQuery

protected LdapGroupQuery(LdapConfigurationApi ldapConfiguration)

Method Details

prepareQueryFilter

protected Filter prepareQueryFilter()

Specified by:

prepareQueryFilter in class AbstractLdapQuery<PlatformGroupQuery,PlatformGroup>

memberFilter

protected Filter memberFilter(Collection<String> memberDns)

groupId

public PlatformGroupQuery groupId(String groupId)

Description copied from interface: PlatformGroupQuery

Only select PlatformGroups with the given id.

Specified by:

groupId in interface PlatformGroupQuery

groupIds

public PlatformGroupQuery groupIds(List<String> groupIds)

Description copied from interface: PlatformGroupQuery

Only select PlatformGroups with the given ids.

Specified by:

groupIds in interface PlatformGroupQuery

groupName

public PlatformGroupQuery groupName(String groupName)

Description copied from interface: PlatformGroupQuery

Only select PlatformGroups with the given name.

Specified by:

groupName in interface PlatformGroupQuery

groupNameLike

public PlatformGroupQuery groupNameLike(String groupNameLike)

Description copied from interface: PlatformGroupQuery

Only select PlatformGroups where the name matches the given parameter. The syntax to use is that of SQL, eg. %test%.

Specified by:

groupNameLike in interface PlatformGroupQuery

groupNameLikeIgnoreCase

public PlatformGroupQuery groupNameLikeIgnoreCase(String groupNameLikeIgnoreCase)

Description copied from interface: PlatformGroupQuery

Only select PlatformGroups where the name matches the given parameter (ignoring case). The syntax to use is that of SQL, eg. %test%.

Specified by:

groupNameLikeIgnoreCase in interface PlatformGroupQuery

groupType

public PlatformGroupQuery groupType(String groupType)

Description copied from interface: PlatformGroupQuery

Only select PlatformGroups which have the given type.

Specified by:

groupType in interface PlatformGroupQuery

groupKey

public PlatformGroupQuery groupKey(String groupKey)

Description copied from interface: PlatformGroupQuery

Only select PlatformGroups which have the given key.

Specified by:

groupKey in interface PlatformGroupQuery

groupKeys

public PlatformGroupQuery groupKeys(List<String> groupKeys)

Description copied from interface: PlatformGroupQuery

Only select PlatformGroups which have the given keys.

Specified by:

groupKeys in interface PlatformGroupQuery

groupTenantId

public PlatformGroupQuery groupTenantId(String tenantId)

Description copied from interface: PlatformGroupQuery

Only select PlatformGroups which have the given tenant id.

Specified by:

groupTenantId in interface PlatformGroupQuery

withoutTenantId

public PlatformGroupQuery withoutTenantId()

Description copied from interface: PlatformGroupQuery

Only select PlatformGroups which have no tenant id.

Specified by:

withoutTenantId in interface PlatformGroupQuery

groupMember

public PlatformGroupQuery groupMember(String groupMemberUserId)

Description copied from interface: PlatformGroupQuery

Only selects PlatformGroups where the given user is a member of.

Specified by:

groupMember in interface PlatformGroupQuery

groupMembers

public PlatformGroupQuery groupMembers(List<String> groupMemberUserIds)

Description copied from interface: PlatformGroupQuery

Only selects PlatformGroups where the given users are a member of.

Specified by:

groupMembers in interface PlatformGroupQuery

infoEquals

public PlatformGroupQuery infoEquals(String name,
 Object value)

Description copied from interface: PlatformGroupQuery

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

Specified by:

infoEquals in interface PlatformGroupQuery

Parameters:

name - the name of the info

value - the value that the info should have

infoEqualsIgnoreCase

public PlatformGroupQuery infoEqualsIgnoreCase(String name,
 String value)

Description copied from interface: PlatformGroupQuery

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

Specified by:

infoEqualsIgnoreCase in interface PlatformGroupQuery

Parameters:

name - the name of the info

value - the value that the info should have

infoValueLike

public PlatformGroupQuery infoValueLike(String name,
 String valueLike)

Description copied from interface: PlatformGroupQuery

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

Specified by:

infoValueLike in interface PlatformGroupQuery

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 PlatformGroupQuery infoValueLikeIgnoreCase(String name,
 String valueLike)

Description copied from interface: PlatformGroupQuery

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

Specified by:

infoValueLikeIgnoreCase in interface PlatformGroupQuery

Parameters:

name - the name of the info

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

groupMemberDn

public PlatformGroupQuery groupMemberDn(String groupMemberDn)

Only selects PlatformGroups where the users with the given distinguished name is a member of.

Parameters:

groupMemberDn - the user distinguished name

orderByGroupId

public PlatformGroupQuery orderByGroupId()

Description copied from interface: PlatformGroupQuery

Order by group id (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByGroupId in interface PlatformGroupQuery

orderByGroupName

public PlatformGroupQuery orderByGroupName()

Description copied from interface: PlatformGroupQuery

Order by group name (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByGroupName in interface PlatformGroupQuery

orderByGroupType

public PlatformGroupQuery orderByGroupType()

Description copied from interface: PlatformGroupQuery

Order by group type (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByGroupType in interface PlatformGroupQuery

withInfo

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

with

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

getGroupMappings

protected LdapGroupProperties.Mappings getGroupMappings()

getGroupProperties

protected LdapGroupProperties getGroupProperties()

getDistinguishedNameProvider

protected DistinguishedNameProvider getDistinguishedNameProvider()

getQueryBase

protected String getQueryBase()

Specified by:

getQueryBase in class AbstractLdapQuery<PlatformGroupQuery,PlatformGroup>

getAttributesMapper

protected AttributesMapper<PlatformGroup> getAttributesMapper()

Specified by:

getAttributesMapper in class AbstractLdapQuery<PlatformGroupQuery,PlatformGroup>

getDistinguishedName

protected String getDistinguishedName()

Specified by:

getDistinguishedName in class AbstractLdapQuery<PlatformGroupQuery,PlatformGroup>

getSort

protected SortProperties getSort()

Specified by:

getSort in class AbstractLdapQuery<PlatformGroupQuery,PlatformGroup>

getSortProperty

protected String getSortProperty(String columnName)

Specified by:

getSortProperty in class AbstractLdapQuery<PlatformGroupQuery,PlatformGroup>

getSortAttributes

protected Collection<String> getSortAttributes(String sortProperty)

Specified by:

getSortAttributes in class AbstractLdapQuery<PlatformGroupQuery,PlatformGroup>

getThis

protected PlatformGroupQuery getThis()

Specified by:

getThis in class AbstractLdapQuery<PlatformGroupQuery,PlatformGroup>