com.atlassian.crowd.directory

Interface MultiValuesQueriesSupport

All Known Subinterfaces:

InternalRemoteDirectory

All Known Implementing Classes:

AbstractInternalDirectory, CachingDirectory, DbCachingRemoteDirectory, DelegatedAuthenticationDirectory, InternalDirectory, InternalDirectoryForDelegation, MockMembershipSearcher

public interface MultiValuesQueriesSupport

Interface supporting searches with multiple values to match.

Method Summary

Modifier and Type	Method and Description
<T> List<T>	searchGroupRelationships(MembershipQuery<T> query) Searches for membership information.
<T> com.google.common.collect.ListMultimap<String,T>	searchGroupRelationshipsGroupedByName(MembershipQuery<T> query) Searches for groups that match the supplied query criteria.

Method Detail

searchGroupRelationships

@Nonnull
<T> List<T> searchGroupRelationships(MembershipQuery<T> query)
                                       throws OperationFailedException

Searches for membership information. Similar to RemoteDirectory.searchGroupRelationships(MembershipQuery), but guarantees that multiple MembershipQuery.getEntityNamesToMatch() are supported.

Parameters:

query - query for memberships.

Returns:

a List of Users or Groups or Strings depending on the query criteria. An empty List if there are no results. Results are ordered by entity name, case-insensitive.

Throws:

OperationFailedException - underlying directory implementation failed to execute the operation.

IllegalArgumentException - if the query is not a valid membership query

searchGroupRelationshipsGroupedByName

<T> com.google.common.collect.ListMultimap<String,T> searchGroupRelationshipsGroupedByName(MembershipQuery<T> query)

Searches for groups that match the supplied query criteria. This method is similar to searchGroupRelationships(MembershipQuery), but it additionally groups results by elements of MembershipQuery.getEntityNamesToMatch().

Parameters:

query - EntityQuery for Entity.GROUP.

Returns:

ListMultimap<String, Group> or ListMultimap<String, String> of groups/groupnames matching the search criteria, grouped by MembershipQuery.getEntityNamesToMatch(). Results are ordered by entity name, case-insensitive. An empty ListMultimap will be returned if no groups matching the criteria are found.

Throws:

OperationFailedException - if the underlying directory implementation failed to execute the operation

IllegalArgumentException - if the query is not a valid group query