com.atlassian.crowd.integration.cache
Interface CacheManager

All Known Implementing Classes:

CacheManagerImpl

public interface CacheManager

The CacheManager is a central class for increasing the performance of the JIRA, Confluence and Bamboo integration with Crowd. The cache is used to store information that become redundant calls between request because security information does not change that often. The enabling and length of time the cache has is determined through the Crowd administration console.

Method Summary

void	cacheGroup(SOAPGroup group)
void	cacheGroupMemberships(String groupname, List memberships)
void	cacheGroupNames(List groupNames) Deprecated. use cacheGroups()
void	cacheGroupRelationship(SOAPNestableGroup nestableGroup) Given a group containing optional sub-groups, caches the group name along with the child->parent relationships.
void	cacheGroups(SOAPGroup[] groups)
void	cachePrincipal(SOAPPrincipal principal)
List	cachePrincipalMemberships(String username, List memberships)
void	cachePrincipalNames(List principalNames) Deprecated. use cachePrincipals
void	cachePrincipals(SOAPPrincipal[] principals)
void	flushCaches()
SOAPGroup	getGroup(String name)
List	getGroupMemberships(String groupname)
List	getGroupNames() Deprecated. use getGroups()
List	getGroups()
List	getParentGroups(String groupname) Given the name of a group, returns a list of groups for which it's a child.
SOAPPrincipal	getPrincipal(String name)
List	getPrincipalMemberships(String username)
List	getPrincipalNames() Deprecated. use getPrincipals()
List	getPrincipals()
boolean	isCacheEnabled()
void	removeGroup(String groupName)
void	removeGroupMemberships(String groupname)
void	removePrincipal(String username)
void	removePrincipalMemberships(String username)

Method Detail

isCacheEnabled

boolean isCacheEnabled()

cacheGroups

void cacheGroups(SOAPGroup[] groups)

getGroups

List getGroups()
               throws CacheException

Throws:

CacheException

cacheGroup

void cacheGroup(SOAPGroup group)

getGroup

SOAPGroup getGroup(String name)
                   throws CacheException

Throws:

CacheException

cacheGroupNames

void cacheGroupNames(List groupNames)

Deprecated. use cacheGroups()

Parameters:

groupNames -

getGroupNames

List getGroupNames()
                   throws CacheException

Deprecated. use getGroups()

Throws:

CacheException

cacheGroupMemberships

void cacheGroupMemberships(String groupname,
                           List memberships)

cacheGroupRelationship

void cacheGroupRelationship(SOAPNestableGroup nestableGroup)

Given a group containing optional sub-groups, caches the group name along with the child->parent relationships. Used in the atlassian-user integration.

Parameters:

nestableGroup - A group that may contain sub-groups

getParentGroups

List getParentGroups(String groupname)

Given the name of a group, returns a list of groups for which it's a child.

Parameters:

groupname -

Returns:

getGroupMemberships

List getGroupMemberships(String groupname)

cachePrincipal

void cachePrincipal(SOAPPrincipal principal)

getPrincipal

SOAPPrincipal getPrincipal(String name)
                           throws CacheException

Throws:

CacheException

cachePrincipals

void cachePrincipals(SOAPPrincipal[] principals)

getPrincipals

List getPrincipals()
                   throws CacheException

Throws:

CacheException

cachePrincipalNames

void cachePrincipalNames(List principalNames)

Deprecated. use cachePrincipals

Parameters:

principalNames -

getPrincipalNames

List getPrincipalNames()
                       throws CacheException

Deprecated. use getPrincipals()

Throws:

CacheException

cachePrincipalMemberships

List cachePrincipalMemberships(String username,
                               List memberships)

getPrincipalMemberships

List getPrincipalMemberships(String username)
                             throws CacheException

Throws:

CacheException

flushCaches

void flushCaches()

removeGroup

void removeGroup(String groupName)

removePrincipal

void removePrincipal(String username)

removePrincipalMemberships

void removePrincipalMemberships(String username)

removeGroupMemberships

void removeGroupMemberships(String groupname)