public final class

DefaultMembershipCache

extends Object
implements MembershipCache
java.lang.Object
   ↳ com.atlassian.confluence.user.crowd.DefaultMembershipCache

Class Overview

The cache maps a CachedCrowdMembershipCacheKey representing a user (or group) in a particular directory to a Map<String, String> where each entry in the map represents a group that the user (or group) is a member of. The key of each Map entry is the lowercase name of the user or child group. The value is the case-preserved actual name of the entity.

Summary

Public Constructors
DefaultMembershipCache(CacheFactory cacheFactory)
Public Methods
List<String> getGroupsForGroup(long directoryId, String groupName)
Returns the list of groups names which the named group is a member of in the specified directory.
List<String> getGroupsForUser(long directoryId, String userName)
Returns the list of groups names which the named user is a member of in the specified directory.
Boolean isGroupDirectMember(long directoryId, String groupName, String parentGroupName)
Returns true if the parentGroupName is in the cached list of parents of the child group, false if parentGroupName is not in the list, or null if there is no cached list for the child group.
Boolean isUserDirectMember(long directoryId, String userName, String groupName)
Returns true if the groupName is in the cached list of parents of the user, false if groupName is not in the list, or null if there is no cached list for the user.
void removeAllDirectoryMemberships(long directoryId)
Removes any entries in the cache which relate to the specified directory.
void removeAllGroupMemberships(long directoryId, String groupName)
Removes any entries in the cache which contain the groupName in the specified directory.
void removeAllUserMemberships(long directoryId, String userName)
Removes any entries in the cache which contain the userName in the specified directory.
void removeGroupGroupMemberships(long directoryId, String groupName)
Removes any cached list of group names which are members of the named group in the specified directory.
void removeUserGroupMemberships(long directoryId, String userName)
Removes any cached list of user names which are members of the named group in the specified directory.
void setGroupsForGroup(long directoryId, String groupName, Iterable<String> parentGroupNames)
Caches the list of parent groupNames for each membership for the named group in the specified directory.
void setGroupsForUser(long directoryId, String userName, Iterable<String> groupNames)
Caches the list of parent groupNames for each membership for the named user in the specified directory.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.user.crowd.MembershipCache

Public Constructors

public DefaultMembershipCache (CacheFactory cacheFactory)

Public Methods

public List<String> getGroupsForGroup (long directoryId, String groupName)

Returns the list of groups names which the named group is a member of in the specified directory. or null if there is no cached list.

public List<String> getGroupsForUser (long directoryId, String userName)

Returns the list of groups names which the named user is a member of in the specified directory. or null if there is no cached list.

public Boolean isGroupDirectMember (long directoryId, String groupName, String parentGroupName)

Returns true if the parentGroupName is in the cached list of parents of the child group, false if parentGroupName is not in the list, or null if there is no cached list for the child group.

public Boolean isUserDirectMember (long directoryId, String userName, String groupName)

Returns true if the groupName is in the cached list of parents of the user, false if groupName is not in the list, or null if there is no cached list for the user.

public void removeAllDirectoryMemberships (long directoryId)

Removes any entries in the cache which relate to the specified directory.

This can be a slow operation if the cache is large. This is a trade-off of the cache design, which is optimised for fast retrieval of all parent groups of a user or group.

public void removeAllGroupMemberships (long directoryId, String groupName)

Removes any entries in the cache which contain the groupName in the specified directory.

This can be a slow operation if the cache is large. This is a trade-off of the cache design, which is optimised for fast retrieval of all parent groups of a user or group.

Removes any GROUPS_FOR_GROUP entry in this cache for the passed in group. Removes any GROUPS_FOR_USER entry in this cache if it contains this group.

public void removeAllUserMemberships (long directoryId, String userName)

Removes any entries in the cache which contain the userName in the specified directory.

This can be a slow operation if the cache is large. This is a trade-off of the cache design, which is optimised for fast retrieval of all parent groups of a user or group.

Removes any GROUPS_FOR_USER entry in this cache if it contains this group.

public void removeGroupGroupMemberships (long directoryId, String groupName)

Removes any cached list of group names which are members of the named group in the specified directory. Does nothing if there is no corresponding entry in the cache.

public void removeUserGroupMemberships (long directoryId, String userName)

Removes any cached list of user names which are members of the named group in the specified directory. Does nothing if there is no corresponding entry in the cache.

public void setGroupsForGroup (long directoryId, String groupName, Iterable<String> parentGroupNames)

Caches the list of parent groupNames for each membership for the named group in the specified directory.

public void setGroupsForUser (long directoryId, String userName, Iterable<String> groupNames)

Caches the list of parent groupNames for each membership for the named user in the specified directory.