Class GraphUserQuery
java.lang.Object
org.flowable.common.engine.impl.db.ListQueryParameterObject
org.flowable.common.engine.impl.query.AbstractQuery<PlatformUserQuery,PlatformUser>
com.flowable.microsoft.graph.impl.AbstractGraphQuery<PlatformUserQuery,PlatformUser>
com.flowable.idm.engine.microsoft.graph.GraphUserQuery
- All Implemented Interfaces:
PlatformUserQuery,Serializable,org.flowable.common.engine.api.query.Query<PlatformUserQuery,,PlatformUser> org.flowable.common.engine.impl.interceptor.Command<Object>,org.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
public class GraphUserQuery
extends AbstractGraphQuery<PlatformUserQuery,PlatformUser>
implements PlatformUserQuery
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.flowable.microsoft.graph.impl.AbstractGraphQuery
AbstractGraphQuery.GraphQuery, AbstractGraphQuery.GraphQueryPath, AbstractGraphQuery.QueryResult<R>Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
org.flowable.common.engine.impl.db.ListQueryParameterObject.OrderBy, org.flowable.common.engine.impl.db.ListQueryParameterObject.ResultTypeNested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query
org.flowable.common.engine.api.query.Query.NullHandlingOnOrder -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final org.flowable.common.engine.api.query.QueryPropertyprotected static final org.flowable.common.engine.api.query.QueryPropertyprotected GraphConfigurationApiprotected final GraphIdmIdentityServiceprotected booleanprotected static final org.flowable.common.engine.api.query.QueryPropertyprotected Stringprotected Stringprotected Collection<String> protected Collection<String> protected Collection<String> protected static final Collection<String> The supported sort properties as defined in the Microsoft Graph Documentationprotected Stringprotected static final org.flowable.common.engine.api.query.QueryPropertyprotected Stringprotected Collection<String> Fields inherited from class com.flowable.microsoft.graph.impl.AbstractGraphQuery
baseUrl, filtersMap, lastCount, logger, objectMapper, searchMapFields inherited from class org.flowable.common.engine.impl.query.AbstractQuery
commandContext, commandExecutorFields inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
databaseType, DEFAULT_ORDER_BY, defaultOrderBy, firstResult, ignoreOrderBy, maxResults, nullHandlingColumn, nullHandlingOnOrder, orderByCollection, orderProperty, parameter, resultType, SORTORDER_ASC, SORTORDER_DESC -
Constructor Summary
ConstructorsConstructorDescriptionGraphUserQuery(GraphConfigurationApi graphConfigurationApi, GraphIdmIdentityService identityService, com.fasterxml.jackson.databind.ObjectMapper objectMapper, String baseUrl) -
Method Summary
Modifier and TypeMethodDescriptionaccessibleByUser(String userId) Query all users that are accessible by the user with the provideduserId.accessibleByUserWithUserDefinitionKey(String userId, String userDefinitionKey) Query all users that are accessible by the user with the provideduserIdanduserDefinitionKey.active()createAfter(Date createdAfter) createdBefore(Date createdBefore) protected Stringprotected Stringprotected intprotected Stringprotected org.flowable.http.common.api.client.FlowableHttpClientprotected GraphGroupIdsProviderprotected StringgetId(PlatformUser entity) protected Collection<String> protected Collection<String> getSortAttributes(String sortProperty) protected StringgetSortProperty(String columnName) protected Collection<String> protected PlatformUserQuerygetThis()protected GraphUserProperties.Mappingsprotected GraphUserPropertiesprotected Function<com.fasterxml.jackson.databind.JsonNode, PlatformUser> protected Function<com.fasterxml.jackson.databind.JsonNode, PlatformUser> Query the user including the extra identity info.infoEquals(String name, Object value) Checks for a user with the given info name and value.infoEqualsIgnoreCase(String name, String value) Checks for a user with the given info name and value ignoring the case of the value.infoValueLike(String name, String valueLike) Checks for a user with the given info name and value like.infoValueLikeIgnoreCase(String name, String valueLikeIgnoreCase) Checks for a user with the given info name and value like ignoring the case of the value.protected PlatformUsermapGraphUser(com.fasterxml.jackson.databind.JsonNode valueNode) protected PlatformUsermapWithDbInfos(com.fasterxml.jackson.databind.JsonNode valueNode) memberOfGroup(String groupId) memberOfGroupKey(String groupKey) Only selectPlatformUsers that belong to the group with the given key.memberOfGroupKeys(Collection<String> groupKeys) Only selectPlatformUsers that belong to the groups with the given keys.memberOfGroups(List<String> groupIds) protected AbstractGraphQuery.GraphQueryPathmembersOfGroupPath(String groupId) protected StringmembersOfGroupPathString(String groupId) protected Collection<AbstractGraphQuery.GraphQueryPath> membersOfGroupsPath(Collection<String> groupIds) protected AbstractGraphQuery.GraphQueryQuery for users with the given presence status.Query for users of the given typeuserDefinitionKey(String userDefinitionKey) userDisplayName(String displayName) userDisplayNameLike(String displayNameLike) userDisplayNameLikeIgnoreCase(String displayNameLikeIgnoreCase) userEmailLike(String emailLike) userFirstName(String firstName) userFirstNameLike(String firstNameLike) userFirstNameLikeIgnoreCase(String firstNameLikeIgnoreCase) userFullNameLike(String fullNameLike) protected PlatformUserQueryuserFullNameLike(String filterKey, String fullNameLike) userFullNameLikeIgnoreCase(String fullNameLikeIgnoreCase) userIdsNotIn(List<String> ids) userIdsOrMemberOfGroupKeys(Collection<String> userIds, Collection<String> groupKeys) Only selectPlatformUsers with the given user ids or that belong to the groups with the given keys.userLastName(String lastName) userLastNameLike(String lastNameLike) userLastNameLikeIgnoreCase(String lastNameLikeIgnoreCase) protected <V> PlatformUserQuerywith(String filterKey, Collection<String> attributeNames, V value, BiFunction<String, V, Filter> filterCreator) protected PlatformUserQuerywithInfo(String filterKey, String infoName, String value, BiFunction<String, String, Filter> filterCreator) Query only users belonging to no tenant.protected PlatformUserQuerywithSearch(String searchKey, Collection<String> attributeNames, String value) Methods inherited from class com.flowable.microsoft.graph.impl.AbstractGraphQuery
addToUriBuilder, countByPath, createFilter, createHttpRequest, createOrderByClauses, createSearch, executeCount, executeList, executeRemoteQuery, handleInvalidStatusException, queryByPath, readResponseBodyAsJson, withFilter, withSearchMethods inherited from class org.flowable.common.engine.impl.query.AbstractQuery
asc, checkQueryOk, count, desc, direction, execute, executeSingleResult, getSafeList, list, listPage, orderBy, orderBy, setCommandExecutor, singleResultMethods 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, setIgnoreOrderBy, setMaxResults, setNullHandlingColumn, setParameterMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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 org.flowable.common.engine.api.query.QueryProperty USER_ID -
FIRST_NAME
protected static final org.flowable.common.engine.api.query.QueryProperty FIRST_NAME -
LAST_NAME
protected static final org.flowable.common.engine.api.query.QueryProperty LAST_NAME -
EMAIL
protected static final org.flowable.common.engine.api.query.QueryProperty EMAIL -
COLUMN_TO_PROPERTY_MAPPING
-
SUPPORTED_SORT_PROPERTIES
The supported sort properties as defined in the Microsoft Graph Documentation -
identityService
-
includeIdentityInfo
protected boolean includeIdentityInfo -
memberOfGroup
-
memberOfGroups
-
memberOfGroupKey
-
memberOfGroupKeys
-
userIdsForOr
-
memberOfGroupKeysForOr
-
userDefinitionKey
-
tenantId
-
graphConfigurationApi
-
-
Constructor Details
-
GraphUserQuery
public GraphUserQuery(GraphConfigurationApi graphConfigurationApi, GraphIdmIdentityService identityService, com.fasterxml.jackson.databind.ObjectMapper objectMapper, String baseUrl)
-
-
Method Details
-
mapWithDbInfos
-
mapGraphUser
-
getFlowableHttpClient
protected org.flowable.http.common.api.client.FlowableHttpClient getFlowableHttpClient()- Specified by:
getFlowableHttpClientin classAbstractGraphQuery<PlatformUserQuery,PlatformUser>
-
getAccessToken
- Specified by:
getAccessTokenin classAbstractGraphQuery<PlatformUserQuery,PlatformUser>
-
prepareGraphQuery
- Specified by:
prepareGraphQueryin classAbstractGraphQuery<PlatformUserQuery,PlatformUser>
-
getBaseQueryPath
-
membersOfGroupPathString
-
membersOfGroupPath
-
membersOfGroupsPath
protected Collection<AbstractGraphQuery.GraphQueryPath> membersOfGroupsPath(Collection<String> groupIds) -
includeIdentityInfo
Description copied from interface:PlatformUserQueryQuery the user including the extra identity info. Implementations are allowed to include the identity info even without explicitly invoking this.- Specified by:
includeIdentityInfoin interfacePlatformUserQuery
-
userDisplayName
- Specified by:
userDisplayNamein interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
userDisplayNameLike
- Specified by:
userDisplayNameLikein interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
userDisplayNameLikeIgnoreCase
- Specified by:
userDisplayNameLikeIgnoreCasein interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
accessibleByUser
Description copied from interface:PlatformUserQueryQuery all users that are accessible by the user with the provideduserId.- Specified by:
accessibleByUserin interfacePlatformUserQuery- 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:PlatformUserQueryQuery all users that are accessible by the user with the provideduserIdanduserDefinitionKey.- Specified by:
accessibleByUserWithUserDefinitionKeyin interfacePlatformUserQuery- Parameters:
userId- the id of the user for which users should be querieduserDefinitionKey- the user definition key for the user for which users should be queried
-
active
- Specified by:
activein interfacePlatformUserQuery
-
state
- Specified by:
statein interfacePlatformUserQuery
-
subState
- Specified by:
subStatein interfacePlatformUserQuery
-
userIdsNotIn
- Specified by:
userIdsNotInin interfacePlatformUserQuery
-
userDefinitionKey
- Specified by:
userDefinitionKeyin interfacePlatformUserQuery
-
type
Description copied from interface:PlatformUserQueryQuery for users of the given type- Specified by:
typein interfacePlatformUserQuery- See Also:
-
subType
- Specified by:
subTypein interfacePlatformUserQuery
-
presence
Description copied from interface:PlatformUserQueryQuery for users with the given presence status.- Specified by:
presencein interfacePlatformUserQuery- See Also:
-
infoEquals
Description copied from interface:PlatformUserQueryChecks for a user with the given info name and value.- Specified by:
infoEqualsin interfacePlatformUserQuery- Parameters:
name- the name of the infovalue- the value that the info should have
-
infoEqualsIgnoreCase
Description copied from interface:PlatformUserQueryChecks for a user with the given info name and value ignoring the case of the value.- Specified by:
infoEqualsIgnoreCasein interfacePlatformUserQuery- Parameters:
name- the name of the infovalue- the value that the info should have
-
infoValueLike
Description copied from interface:PlatformUserQueryChecks for a user with the given info name and value like.- Specified by:
infoValueLikein interfacePlatformUserQuery- Parameters:
name- the name of the infovalueLike- the value like the info should have ('%' has to be added by the caller itself)
-
infoValueLikeIgnoreCase
Description copied from interface:PlatformUserQueryChecks for a user with the given info name and value like ignoring the case of the value.- Specified by:
infoValueLikeIgnoreCasein interfacePlatformUserQuery- Parameters:
name- the name of the infovalueLikeIgnoreCase- the value like the info should have ('%' has to be added by the caller itself)
-
createdBefore
- Specified by:
createdBeforein interfacePlatformUserQuery
-
createAfter
- Specified by:
createAfterin interfacePlatformUserQuery
-
tenantId
- Specified by:
tenantIdin interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
withoutTenantId
Description copied from interface:PlatformUserQueryQuery only users belonging to no tenant.- Specified by:
withoutTenantIdin interfacePlatformUserQuery
-
memberOfGroupKey
Description copied from interface:PlatformUserQueryOnly selectPlatformUsers that belong to the group with the given key.- Specified by:
memberOfGroupKeyin interfacePlatformUserQuery
-
memberOfGroupKeys
Description copied from interface:PlatformUserQueryOnly selectPlatformUsers that belong to the groups with the given keys.- Specified by:
memberOfGroupKeysin interfacePlatformUserQuery
-
userId
- Specified by:
userIdin interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
userIds
- Specified by:
userIdsin interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
userIdIgnoreCase
- Specified by:
userIdIgnoreCasein interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
userFirstName
- Specified by:
userFirstNamein interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
userFirstNameLike
- Specified by:
userFirstNameLikein interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
userFirstNameLikeIgnoreCase
- Specified by:
userFirstNameLikeIgnoreCasein interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
userLastName
- Specified by:
userLastNamein interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
userLastNameLike
- Specified by:
userLastNameLikein interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
userLastNameLikeIgnoreCase
- Specified by:
userLastNameLikeIgnoreCasein interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
userFullNameLike
- Specified by:
userFullNameLikein interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
userFullNameLikeIgnoreCase
- Specified by:
userFullNameLikeIgnoreCasein interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
userFullNameLike
-
userEmail
- Specified by:
userEmailin interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
userEmailLike
- Specified by:
userEmailLikein interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
memberOfGroup
- Specified by:
memberOfGroupin interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
memberOfGroups
- Specified by:
memberOfGroupsin interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
userIdsOrMemberOfGroupKeys
public PlatformUserQuery userIdsOrMemberOfGroupKeys(Collection<String> userIds, Collection<String> groupKeys) Description copied from interface:PlatformUserQueryOnly selectPlatformUsers with the given user ids or that belong to the groups with the given keys.- Specified by:
userIdsOrMemberOfGroupKeysin interfacePlatformUserQuery
-
orderByUserId
- Specified by:
orderByUserIdin interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
orderByUserFirstName
- Specified by:
orderByUserFirstNamein interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
orderByUserLastName
- Specified by:
orderByUserLastNamein interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
orderByUserEmail
- Specified by:
orderByUserEmailin interfaceorg.flowable.idm.api.UserBaseQuery<PlatformUserQuery,PlatformUser>
-
withInfo
protected PlatformUserQuery withInfo(String filterKey, String infoName, String value, BiFunction<String, String, Filter> filterCreator) -
with
protected <V> PlatformUserQuery with(String filterKey, Collection<String> attributeNames, V value, BiFunction<String, V, Filter> filterCreator) -
withSearch
protected PlatformUserQuery withSearch(String searchKey, Collection<String> attributeNames, String value) -
getUserMappings
-
getUserProperties
-
getUserValueMapper
-
getGraphGroupIdsProvider
-
getValueMapper
- Specified by:
getValueMapperin classAbstractGraphQuery<PlatformUserQuery,PlatformUser>
-
getId
- Specified by:
getIdin classAbstractGraphQuery<PlatformUserQuery,PlatformUser>
-
getSortProperty
- Specified by:
getSortPropertyin classAbstractGraphQuery<PlatformUserQuery,PlatformUser>
-
getSortAttributes
- Specified by:
getSortAttributesin classAbstractGraphQuery<PlatformUserQuery,PlatformUser>
-
getSupportedSortAttributes
- Specified by:
getSupportedSortAttributesin classAbstractGraphQuery<PlatformUserQuery,PlatformUser>
-
getSelectAttributes
- Specified by:
getSelectAttributesin classAbstractGraphQuery<PlatformUserQuery,PlatformUser>
-
getExpand
- Specified by:
getExpandin classAbstractGraphQuery<PlatformUserQuery,PlatformUser>
-
getComplexQueryMaxResultsLimit
protected int getComplexQueryMaxResultsLimit()- Specified by:
getComplexQueryMaxResultsLimitin classAbstractGraphQuery<PlatformUserQuery,PlatformUser>
-
getThis
- Specified by:
getThisin classAbstractGraphQuery<PlatformUserQuery,PlatformUser>
-