com.atlassian.crowd.manager.application

Class AbstractInMemorySearchStrategy

java.lang.Object

com.atlassian.crowd.manager.application.AbstractInMemorySearchStrategy

All Implemented Interfaces:

SearchStrategy

Direct Known Subclasses:

InMemoryAggregatingSearchStrategy, InMemoryNonAggregatingSearchStrategy

public abstract class AbstractInMemorySearchStrategy
extends Object
implements SearchStrategy

An abstract SearchStrategy which searches across multiple directories in memory for users and groups

This is considered the worse case SearchStrategy to use as aggregation across multiple directories will be done in-memory, potentially consuming a lot of memory. This is the same (in spirit) as what Crowd 2.8 and earlier would do by default.

Since:

2.9

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Directory>	activeDirectories
protected DirectoryManager	directoryManager

Constructor Summary

Constructors

Constructor and Description
AbstractInMemorySearchStrategy(DirectoryManager directoryManager, List<Directory> activeDirectories)

Method Summary

Modifier and Type	Method and Description
protected <T> List<T>	doDirectDirectoryMembershipQuery(MembershipQuery<T> query, long directoryId) Searches for direct group relationships in a single directory.
protected <T> List<T>	doNestedDirectoryMembershipQuery(MembershipQuery<T> query, long directoryId) Searches for direct and indirect (nested) group relationships in a single directory.
protected static <T> com.google.common.base.Function<T,String>	getAggregatingAndSortingComparatorFor(Class<T> type) Returns a comparator for aggregating and sorting the results.
<T> List<T>	searchGroups(EntityQuery<T> query) Returns a List<Group> matching the search criteria defined in the query.
<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

Methods inherited from interface com.atlassian.crowd.manager.application.SearchStrategy

searchDirectGroupRelationships, searchNestedGroupRelationships

Field Detail

directoryManager

protected final DirectoryManager directoryManager

activeDirectories

protected final List<Directory> activeDirectories

Constructor Detail

AbstractInMemorySearchStrategy

public AbstractInMemorySearchStrategy(DirectoryManager directoryManager,
                                      List<Directory> activeDirectories)

Method Detail

searchUsers

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

Description copied from interface: SearchStrategy

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 SearchStrategy

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: SearchStrategy

Returns a List<Group> 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 SearchStrategy

Parameters:

query - the search query.

Returns:

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

doDirectDirectoryMembershipQuery

protected <T> List<T> doDirectDirectoryMembershipQuery(MembershipQuery<T> query,
                                                       long directoryId)

Searches for direct group relationships in a single directory.

Parameters:

query - membership query.

directoryId - Directory to search.

Returns:

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

doNestedDirectoryMembershipQuery

protected <T> List<T> doNestedDirectoryMembershipQuery(MembershipQuery<T> query,
                                                       long directoryId)

Searches for direct and indirect (nested) group relationships in a single directory.

Parameters:

query - membership query.

directoryId - Directory to search.

Returns:

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

getAggregatingAndSortingComparatorFor

protected static <T> com.google.common.base.Function<T,String> getAggregatingAndSortingComparatorFor(Class<T> type)

Returns a comparator for aggregating and sorting the results.

For:

• String: names are aggregated based on case-insensitive comparison.
• User: users are aggregated based on case-insensitive comparison and directoryId. Two users with the same name but from different directories are treated as different users.
• Group: groups are aggregated based on case-insensitive comparison. Two groups with the same name but from different directories are treated as the same group.

Parameters:

type - type we are aggregating.

Returns:

comparator for the type.