Package com.atlassian.crowd.manager.application.search

Class AbstractInMemoryMembershipSearchStrategy

java.lang.Object

com.atlassian.crowd.manager.application.search.AbstractInMemoryMembershipSearchStrategy

All Implemented Interfaces:

MembershipSearchStrategy

Direct Known Subclasses:

InMemoryAggregatingMembershipSearchStrategy, InMemoryNonAggregatingMembershipSearchStrategy

public abstract class AbstractInMemoryMembershipSearchStrategy
extends Object
implements MembershipSearchStrategy

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

This is considered the worse case MembershipSearchStrategy 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	Description
protected final AccessFilter	accessFilter
protected final List<Directory>	directories
protected final List<Long>	directoryIds
protected final DirectoryManagerSearchWrapper	directoryManagerSearchWrapper

Constructor Summary

Constructors

Constructor	Description
AbstractInMemoryMembershipSearchStrategy(DirectoryManager directoryManager, List<Directory> directories, AccessFilter accessFilter)

Method Summary

Modifier and Type	Method	Description
protected abstract CanonicalityChecker	getCanonicalityCheckerIfNeeded(MembershipQuery<?> query)
protected abstract <T> BiFunction<Directory,MembershipQuery<T>,MembershipQuery<T>>	getQueryTransformer(MembershipQuery<T> original)
<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.
protected <T> List<T>	searchGroupRelationships(MembershipQuery<T> query, boolean nested)
<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 java.lang.Object

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

Field Details

directoryManagerSearchWrapper

protected final DirectoryManagerSearchWrapper directoryManagerSearchWrapper

directories

protected final List<Directory> directories

directoryIds

protected final List<Long> directoryIds

accessFilter

protected final AccessFilter accessFilter

Constructor Details

AbstractInMemoryMembershipSearchStrategy

public AbstractInMemoryMembershipSearchStrategy(DirectoryManager directoryManager,
 List<Directory> directories,
 AccessFilter accessFilter)

Method Details

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.

searchGroupRelationships

protected <T> List<T> searchGroupRelationships(MembershipQuery<T> query,
 boolean nested)

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.

getCanonicalityCheckerIfNeeded

protected abstract CanonicalityChecker getCanonicalityCheckerIfNeeded(MembershipQuery<?> query)

getQueryTransformer

protected abstract <T>
BiFunction<Directory,MembershipQuery<T>,MembershipQuery<T>> getQueryTransformer(MembershipQuery<T> original)