com.atlassian.crowd.manager.application

Class CanonicalityChecker

java.lang.Object

com.atlassian.crowd.manager.application.CanonicalityChecker

public class CanonicalityChecker
extends Object

Helper class for checking canonicality of users and groups.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	BATCH_SIZE

Constructor Summary

Constructors

Constructor and Description
CanonicalityChecker(DirectoryManager directoryManager, List<Directory> directories, boolean queryForAllEntities)

Method Summary

Modifier and Type	Method and Description
List<Directory>	getDirectories()
void	removeNonCanonicalEntities(com.google.common.collect.Multimap<Long,String> allNames, EntityDescriptor entity) Given a username is duplicated in several user directories under the same application.

Methods inherited from class java.lang.Object

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

Field Detail

BATCH_SIZE

protected static final int BATCH_SIZE

See Also:

Constant Field Values

Constructor Detail

CanonicalityChecker

public CanonicalityChecker(DirectoryManager directoryManager,
                           List<Directory> directories,
                           boolean queryForAllEntities)

Parameters:

directoryManager -

directories -

queryForAllEntities - Whether it's allowed to query for all directory entities. This setting has strong performance impact and makes sense to set it to true only if this object will be used for multiple checks.

Method Detail

removeNonCanonicalEntities

public void removeNonCanonicalEntities(com.google.common.collect.Multimap<Long,String> allNames,
                                       EntityDescriptor entity)

Given a username is duplicated in several user directories under the same application.

The user in the first directory, according to directory ordering is considered to be the canonical user for the given username, and the other users are shadowed and thus not to be returned from searches.

This method removes all entities which were found for a given directory, but were not canonical in it (they existed in a preceding directory, not necessarily in the allEntities map). The allEntities map will be mutated in the process. For example: Given the following directories and entities:

• Directory 1 - Users A, B, C
• Directory 2 - Users C, D, E

At this point users A, B and C are known as canonical in the Directory 1 and will be removed from the succeeding directories. This will leave users D and E in Directory 2. However their canonicality in Directory 2 is uncertain as they may exist in Directory 1, but may have not been matched by the query that was used to retrieve the users. Because of this Directory 1 will be queried for users D and E and the results that were found will be removed from all succeeding directories. If user D is found in Directory 1 this will give us the following result:

• Directory 1 - Users A, B, C
• Directory 2 - User E

User D was not included in the result set due to being canonical in Directory 1, but not matching the query used to retrieve the entities.

Parameters:

allNames - a directoryId to list of entities map containing the entities to check for canonicality.

entity - the EntityDescriptor used to look up the entities that will be determined as canonical

getDirectories

public List<Directory> getDirectories()