com.atlassian.crowd.dao.membership.cache

Class MembershipCache

java.lang.Object

com.atlassian.crowd.dao.membership.cache.MembershipCache

public class MembershipCache
extends Object

Membership cache implementation. Internally there are multiple caches created - 1 per directory and query type pair.

Constructor Summary

Constructors

Constructor and Description
MembershipCache(CacheFactory cacheFactory, Set<QueryType> cacheableTypes, Duration cacheTtl, int groupMembershipCacheMax, int queryTypeInvalidationThreshold, DirectoryEntityResolver entityResolver, ScheduledExecutorService cleanupPool)

Method Summary

Modifier and Type	Method and Description
int	cacheCount()
void	clear()
void	clear(long directoryId)
<T> List<T>	get(long directoryId, QueryType queryType, String key, Class<T> returnType)
Set<QueryType>	getCacheableTypes()
protected CacheInvalidations	getCacheInvalidation()
List<String>	getNames(long directoryId, QueryType queryType, String key)
protected com.atlassian.cache.Cache<String,List<String>>	getOrCreateCache(com.atlassian.crowd.dao.membership.cache.QueryTypeCacheKey cacheKey)
void	invalidateCache(long directoryId)
void	invalidateCache(long directoryId, QueryType queryType)
void	invalidateCache(long directoryId, QueryType queryType, String key)
protected boolean	isInvalidated(com.atlassian.crowd.dao.membership.cache.QueryTypeCacheKey cacheKey, String key)
protected void	processInvalidations(CacheInvalidations invalidations)
<T> void	put(long directoryId, QueryType queryType, String key, List<T> data)
boolean	supports(Class<?> resultClass)

Methods inherited from class java.lang.Object

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

Constructor Detail

MembershipCache

public MembershipCache(CacheFactory cacheFactory,
                       Set<QueryType> cacheableTypes,
                       Duration cacheTtl,
                       int groupMembershipCacheMax,
                       int queryTypeInvalidationThreshold,
                       @Nullable
                       DirectoryEntityResolver entityResolver,
                       ScheduledExecutorService cleanupPool)

Parameters:

cacheFactory - factory which will be used to create caches - 1 per directory and query type pair

cacheableTypes - set of query types that should be cached

cacheTtl - time for which entries are valid after write

groupMembershipCacheMax - maximum cache size (per directory and query type pair)

queryTypeInvalidationThreshold - when number of invalidated keys goes above this threshold then all entries for the given query type will be invalidated; this allows to limit the number of invalidation messages sent to the cluster

entityResolver - implementation of DirectoryEntityResolver to translate entity names to entities; there are following options:

• Providing null will result in only names caching. Entity query results will never be returned from cache, however the names of the results of such query will be cached.
• Providing LocallyCachedDirectoryEntityResolver. The cache does not expire entities on modifications, so it may return stale data.
• Providing custom implementation of DirectoryEntityResolver. This is especially useful if product already caches entities by name.

cleanupPool - thread pool for cache cleanup task

Method Detail

getCacheableTypes

public Set<QueryType> getCacheableTypes()

invalidateCache

public void invalidateCache(long directoryId)

invalidateCache

public void invalidateCache(long directoryId,
                            QueryType queryType)

invalidateCache

public void invalidateCache(long directoryId,
                            QueryType queryType,
                            String key)

put

public <T> void put(long directoryId,
                    QueryType queryType,
                    String key,
                    List<T> data)

get

@Nullable
public <T> List<T> get(long directoryId,
                                 QueryType queryType,
                                 String key,
                                 Class<T> returnType)

getNames

@Nullable
public List<String> getNames(long directoryId,
                                       QueryType queryType,
                                       String key)

processInvalidations

protected void processInvalidations(CacheInvalidations invalidations)

getOrCreateCache

protected com.atlassian.cache.Cache<String,List<String>> getOrCreateCache(com.atlassian.crowd.dao.membership.cache.QueryTypeCacheKey cacheKey)

getCacheInvalidation

protected CacheInvalidations getCacheInvalidation()

isInvalidated

protected boolean isInvalidated(com.atlassian.crowd.dao.membership.cache.QueryTypeCacheKey cacheKey,
                                String key)

clear

public void clear()

clear

public void clear(long directoryId)

cacheCount

public int cacheCount()

supports

public boolean supports(Class<?> resultClass)