com.atlassian.crowd.manager.application.search

Enum NoDirectorySearchStrategy

java.lang.Object

java.lang.Enum<NoDirectorySearchStrategy>

com.atlassian.crowd.manager.application.search.NoDirectorySearchStrategy

All Implemented Interfaces:

GroupSearchStrategy, MembershipSearchStrategy, UserSearchStrategy, Serializable, Comparable<NoDirectorySearchStrategy>

public enum NoDirectorySearchStrategy
extends Enum<NoDirectorySearchStrategy>
implements UserSearchStrategy, GroupSearchStrategy, MembershipSearchStrategy

A MembershipSearchStrategy for an application with no active directories associated.

Since:

2.9

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

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> com.google.common.collect.ListMultimap<String,T>	searchDirectGroupRelationshipsGroupedByName(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.
static NoDirectorySearchStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static NoDirectorySearchStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final NoDirectorySearchStrategy INSTANCE

Method Detail

values

public static NoDirectorySearchStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NoDirectorySearchStrategy c : NoDirectorySearchStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NoDirectorySearchStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

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.

searchDirectGroupRelationshipsGroupedByName

public <T> com.google.common.collect.ListMultimap<String,T> searchDirectGroupRelationshipsGroupedByName(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:

searchDirectGroupRelationshipsGroupedByName in interface MembershipSearchStrategy

Parameters:

query - membership query.

Returns:

ListMultimap where keys are elements of MembershipQuery.getEntityNamesToMatch() and values are List of User entities, Group entities, String usernames or String group names matching the query criteria for the given key.