com.atlassian.crowd.manager.application

Class SingleDirectorySearchStrategy

java.lang.Object

com.atlassian.crowd.manager.application.SingleDirectorySearchStrategy

All Implemented Interfaces:

GroupSearchStrategy, MembershipSearchStrategy, UserSearchStrategy

public class SingleDirectorySearchStrategy
extends Object
implements UserSearchStrategy, GroupSearchStrategy, MembershipSearchStrategy

A SearchStrategy optimized for a single directory

Since:

2.9

Constructor Summary

Constructors

Constructor and Description
SingleDirectorySearchStrategy(DirectoryManager directoryManager, long directoryId)

Method Summary

Modifier and Type	Method and Description
<T> List<T>	searchDirectGroupRelationships(MembershipQuery<T> query) Searches for direct group relationships in any of the application's active assigned directories.
<T> List<T>	searchGroups(EntityQuery<T> query) Returns a List<Group> or List<String> groupnames matching the search criteria defined in the query.
<T> List<T>	searchNestedGroupRelationships(MembershipQuery<T> query) Searches for direct and indirect (nested) group relationships in any of the application's active assigned directories.
<T> List<T>	searchUsers(EntityQuery<T> query) Returns a List<User> or List<String> matching the search criteria defined in the query.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleDirectorySearchStrategy

public SingleDirectorySearchStrategy(DirectoryManager directoryManager,
                                     long directoryId)

Method Detail

searchUsers

public <T> List<T> searchUsers(EntityQuery<T> query)

Description copied from interface: UserSearchStrategy

Returns a List<User> or List<String> matching the search criteria defined in the query.

The users will be returned in a stable order including across pagination boundaries (excluding modification).

Specified by:

searchUsers in interface UserSearchStrategy

Parameters:

query - the search query.

Returns:

List<User> user objects or List<String> usernames, depending on the query.

searchGroups

public <T> List<T> searchGroups(EntityQuery<T> query)

Description copied from interface: GroupSearchStrategy

Returns a List<Group> or List<String> groupnames matching the search criteria defined in the query.

The groups will be returned in a stable order including across pagination boundaries (excluding modification).

Specified by:

searchGroups in interface GroupSearchStrategy

Parameters:

query - the search query.

Returns:

List<Group> group objects or List<String> groupnames, depending on the query.

searchDirectGroupRelationships

public <T> List<T> searchDirectGroupRelationships(MembershipQuery<T> query)

Description copied from interface: MembershipSearchStrategy

Searches for direct group relationships in any of the application's active assigned directories.

When searching for the groups an entity is a member of, the membership aggregation semantic will determine whether only the owning directory (when false) or all directories (when true) will be searched.

Specified by:

searchDirectGroupRelationships in interface MembershipSearchStrategy

Parameters:

query - membership query.

Returns:

List of User entities, Group entities, String usernames or String group names matching the query criteria.

searchNestedGroupRelationships

public <T> List<T> searchNestedGroupRelationships(MembershipQuery<T> query)

Description copied from interface: MembershipSearchStrategy

Searches for direct and indirect (nested) group relationships in any of the application's active assigned directories.

If the directory does not support nested groups, this call will be equivalent to DirectoryManager.searchDirectGroupRelationships(long, com.atlassian.crowd.search.query.membership.MembershipQuery).

WARNING: this method could be very slow if the underlying RemoteDirectory does not employ caching.

When searching for the groups a user is a member of only the directory of the user (as determined by findUserByName) is searched. When searching for memberships of a group or groups a group is a member of all directories are searched and the results amalgamated.

Specified by:

searchNestedGroupRelationships in interface MembershipSearchStrategy

Parameters:

query - membership query.

Returns:

List of User entities, Group entities, String usernames or String group names matching the query criteria.