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.

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

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