com.atlassian.confluence.cache.hazelcast

Interface LockingCacheManager

All Superinterfaces:

com.atlassian.cache.CacheFactory, com.atlassian.cache.CacheManager

All Known Implementing Classes:

ConfluenceHazelcastCacheManager

@Internal
public interface LockingCacheManager
extends com.atlassian.cache.CacheManager

An internal interface for confluence that allows the acquisition of LockingCache

This should only be used internal to confluence.

Method Summary

Modifier and Type	Method and Description
<K,V> LockingCache<K,V>	getLockingCache(String name, com.atlassian.cache.CacheLoader<K,V> loader, com.atlassian.cache.CacheSettings cacheSettings) This method allows a client to get a cache that support explicit locking methods.

Methods inherited from interface com.atlassian.cache.CacheManager

flushCaches, getCaches, getManagedCache, getManagedCaches, shutdown

Methods inherited from interface com.atlassian.cache.CacheFactory

getCache, getCache, getCache, getCache, getCache, getCachedReference, getCachedReference, getCachedReference, getCachedReference

Method Detail

getLockingCache

@Nonnull
<K,V> LockingCache<K,V> getLockingCache(@Nonnull
                                                 String name,
                                                 @Nullable
                                                 com.atlassian.cache.CacheLoader<K,V> loader,
                                                 @Nonnull
                                                 com.atlassian.cache.CacheSettings cacheSettings)

This method allows a client to get a cache that support explicit locking methods. We try to discourage this, and that's why this method is in it's own interface.

This method will also wrap the lockingCache in a confluence monitoring wrapper.

Type Parameters:

K - The key type of the cache

V - The value type of the cache

Parameters:

name - The name of the cache you are requesting

loader - A cacheLoader to populate cache entries

cacheSettings - A cacheSettings object describing the attributes of the cache

Returns:

An atlassian-cache cache with locking semantics