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	ACCOUNT_ENABLED
static ODataSelect	DELTA_QUERY_GROUP_SELECT
static String	DISPLAY_NAME
static String	FIRST_NAME
static ODataSelect	GROUP_SELECT
static ODataSelect	GROUPNAME_SELECT
static String	ID
static String	LAST_NAME
static String	MAIL
static ODataExpand	MEMBERS_EXPAND
static ODataSelect	USER_SELECT
static String	USERNAME

Constructor Summary

Constructors

Constructor and Description
MicrosoftGraphQueryTranslator()

Method Summary

Modifier and Type	Method and Description
GraphQuery	convert(EntityQuery query, String usernameAttribute) 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, String usernameAttribute) 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

FIRST_NAME

public static final String FIRST_NAME

See Also:

Constant Field Values

LAST_NAME

public static final String LAST_NAME

See Also:

Constant Field Values

DISPLAY_NAME

public static final String DISPLAY_NAME

See Also:

Constant Field Values

MAIL

public static final String MAIL

See Also:

Constant Field Values

ID

public static final String ID

See Also:

Constant Field Values

ACCOUNT_ENABLED

public static final String ACCOUNT_ENABLED

See Also:

Constant Field Values

USER_SELECT

public static final ODataSelect USER_SELECT

MEMBERS_EXPAND

public static final ODataExpand MEMBERS_EXPAND

GROUPNAME_SELECT

public static final ODataSelect GROUPNAME_SELECT

GROUP_SELECT

public static final ODataSelect GROUP_SELECT

DELTA_QUERY_GROUP_SELECT

public static final ODataSelect DELTA_QUERY_GROUP_SELECT

Constructor Detail

MicrosoftGraphQueryTranslator

public MicrosoftGraphQueryTranslator()

Method Detail

convert

public GraphQuery convert(EntityQuery query,
                          String usernameAttribute)

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

usernameAttribute - name of the attribute that username restriction should be matched to

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,
                                              String usernameAttribute)

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

usernameAttribute - name of the attribute that username restriction should be matched to

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