com.atlassian.crowd.manager.application

Class InMemoryAggregatingSearchStrategy

java.lang.Object

com.atlassian.crowd.manager.application.AbstractInMemorySearchStrategy

com.atlassian.crowd.manager.application.InMemoryAggregatingSearchStrategy

All Implemented Interfaces:

SearchStrategy

public class InMemoryAggregatingSearchStrategy
extends AbstractInMemorySearchStrategy

An in-memory SearchStrategy which aggregates memberships across multiple directories.

This is considered the worse case SearchStrategy to use as searching 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

See Also:

Application.isMembershipAggregationEnabled()

Field Summary

Fields inherited from class com.atlassian.crowd.manager.application.AbstractInMemorySearchStrategy

activeDirectories, directoryManager

Constructor Summary

Constructors

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

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>	searchNestedGroupRelationships(MembershipQuery<T> query) Searches for direct and indirect (nested) group relationships in any of the application's active assigned directories.

Methods inherited from class com.atlassian.crowd.manager.application.AbstractInMemorySearchStrategy

doDirectDirectoryMembershipQuery, doNestedDirectoryMembershipQuery, getAggregatingAndSortingComparatorFor, searchGroups, searchUsers

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryAggregatingSearchStrategy

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

Method Detail

searchDirectGroupRelationships

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

Description copied from interface: SearchStrategy

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.

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

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.

Parameters:

query - membership query.

Returns:

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