com.atlassian.crowd.directory.query

Class MicrosoftGraphQueryTranslator

java.lang.Object

com.atlassian.crowd.directory.query.MicrosoftGraphQueryTranslator

public class MicrosoftGraphQueryTranslator
extends Object

Translates Crowd queries into filters used by Microsoft Graph.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMA_SEPARATED_DELTA_QUERY_GROUP_PROPERTIES
static String	COMMA_SEPARATED_GROUP_PROPERTIES
static String	COMMA_SEPARATED_MINIMAL_GROUP_PROPERTIES
static String	COMMA_SEPARATED_MINIMAL_USER_AND_GROUP_PROPERTIES
static String	COMMA_SEPARATED_MINIMAL_USER_PROPERTIES
static String	COMMA_SEPARATED_NAME_PROPERTIES
static String	COMMA_SEPARATED_USER_AND_GROUP_PROPERTIES
static String	COMMA_SEPARATED_USER_PROPERTIES
static Set<String>	DELTA_QUERY_GROUP_PROPERTIES
static Set<String>	GROUP_PROPERTIES
static String	GROUPNAME
static String	ID
static Set<String>	MINIMAL_GROUP_PROPERTIES
static Set<String>	MINIMAL_USER_PROPERTIES
static Set<String>	NAME_PROPERTIES
static Set<String>	USER_PROPERTIES
static String	USERNAME

Constructor Summary

Constructors

Constructor and Description
MicrosoftGraphQueryTranslator()

Method Summary

Modifier and Type	Method and Description
GraphQuery	convert(EntityQuery query) Converts a Crowd EntityQuery to a GraphQuery that should be used to fetch the first page of results.
ODataSelect	resolveAzureAdColumnsForSingleEntityTypeQuery(EntityDescriptor entity, Class<?> returnType)
ODataSelect	resolveAzureAdColumnsForSingleEntityTypeQuery(EntityDescriptor entity, FetchMode fetchMode)
ODataExpand	resolveAzureAdNavigationPropertiesForSingleEntityTypeQuery(EntityDescriptor entity, FetchMode fetchMode)
ODataSelect	translateColumnsForUsersAndGroupsQuery(FetchMode fetchMode)
ODataFilter	translateSearchRestriction(EntityDescriptor entityDescriptor, SearchRestriction restriction) Converts a search restriction to an ODataFilter, which can be used in a graph query

Methods inherited from class java.lang.Object

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

Field Detail

USERNAME

public static final String USERNAME

See Also:

Constant Field Values

ID

public static final String ID

See Also:

Constant Field Values

USER_PROPERTIES

public static final Set<String> USER_PROPERTIES

MINIMAL_USER_PROPERTIES

public static final Set<String> MINIMAL_USER_PROPERTIES

COMMA_SEPARATED_MINIMAL_USER_PROPERTIES

public static final String COMMA_SEPARATED_MINIMAL_USER_PROPERTIES

COMMA_SEPARATED_USER_PROPERTIES

public static final String COMMA_SEPARATED_USER_PROPERTIES

GROUPNAME

public static final String GROUPNAME

See Also:

Constant Field Values

GROUP_PROPERTIES

public static final Set<String> GROUP_PROPERTIES

DELTA_QUERY_GROUP_PROPERTIES

public static final Set<String> DELTA_QUERY_GROUP_PROPERTIES

MINIMAL_GROUP_PROPERTIES

public static final Set<String> MINIMAL_GROUP_PROPERTIES

COMMA_SEPARATED_MINIMAL_GROUP_PROPERTIES

public static final String COMMA_SEPARATED_MINIMAL_GROUP_PROPERTIES

COMMA_SEPARATED_GROUP_PROPERTIES

public static final String COMMA_SEPARATED_GROUP_PROPERTIES

COMMA_SEPARATED_DELTA_QUERY_GROUP_PROPERTIES

public static final String COMMA_SEPARATED_DELTA_QUERY_GROUP_PROPERTIES

NAME_PROPERTIES

public static final Set<String> NAME_PROPERTIES

COMMA_SEPARATED_NAME_PROPERTIES

public static final String COMMA_SEPARATED_NAME_PROPERTIES

COMMA_SEPARATED_USER_AND_GROUP_PROPERTIES

public static final String COMMA_SEPARATED_USER_AND_GROUP_PROPERTIES

COMMA_SEPARATED_MINIMAL_USER_AND_GROUP_PROPERTIES

public static final String COMMA_SEPARATED_MINIMAL_USER_AND_GROUP_PROPERTIES

Constructor Detail

MicrosoftGraphQueryTranslator

public MicrosoftGraphQueryTranslator()

Method Detail

convert

public GraphQuery convert(EntityQuery query)

Converts a Crowd EntityQuery to a GraphQuery that should be used to fetch the first page of results. This will map the search restrictions, the columns to fetch, the start index and the amount of results to fetch

Parameters:

query - the Crowd query to convert

Returns:

a GraphQuery for fetching the first page of results

resolveAzureAdColumnsForSingleEntityTypeQuery

public ODataSelect resolveAzureAdColumnsForSingleEntityTypeQuery(EntityDescriptor entity,
                                                                 Class<?> returnType)

Parameters:

entity - the entity for which we're querying

returnType - the return type of the Crowd query

Returns:

an ODataSelect with the columns appropriate for the given entity and return type

translateSearchRestriction

public ODataFilter translateSearchRestriction(EntityDescriptor entityDescriptor,
                                              SearchRestriction restriction)

Converts a search restriction to an ODataFilter, which can be used in a graph query

Parameters:

entityDescriptor - the entityDescriptor of the entity that will be queried for

restriction - the restriction to translate

Returns:

the translated filter

resolveAzureAdColumnsForSingleEntityTypeQuery

public ODataSelect resolveAzureAdColumnsForSingleEntityTypeQuery(EntityDescriptor entity,
                                                                 FetchMode fetchMode)

Parameters:

entity - the entity for which we're querying

fetchMode - the types of columns that should be fetched

Returns:

an ODataSelect with the columns appropriate for the given entity and fetch mode

resolveAzureAdNavigationPropertiesForSingleEntityTypeQuery

public ODataExpand resolveAzureAdNavigationPropertiesForSingleEntityTypeQuery(EntityDescriptor entity,
                                                                              FetchMode fetchMode)

Parameters:

entity - the entity for which we're querying

fetchMode - the types of navigation properties that should be fetched

Returns:

an ODataExpand with the navigation properties appropriate for the given entity and fetch mode

translateColumnsForUsersAndGroupsQuery

public ODataSelect translateColumnsForUsersAndGroupsQuery(FetchMode fetchMode)

Parameters:

fetchMode - the types of columns that should be fetched

Returns:

an ODataSelect with the columns appropriate for a query that will fetch both users and groups and the specified fetch mode