com.atlassian.cache.ehcache

Class EhCacheManager

java.lang.Object

com.atlassian.cache.impl.AbstractCacheManager

com.atlassian.cache.ehcache.EhCacheManager

All Implemented Interfaces:

CacheFactory, CacheManager, MBeanRegistrar

@ParametersAreNonnullByDefault
public class EhCacheManager
extends AbstractCacheManager
implements MBeanRegistrar

Maintains a mapping of name -> Cache and provides factory methods for creating ad getting caches.

Since:

2.0

Field Summary

Fields inherited from class com.atlassian.cache.impl.AbstractCacheManager

cacheCreationLocks, caches, cacheSettingsDefaultsProvider

Constructor Summary

Constructors

Constructor and Description
EhCacheManager() Deprecated. Since 5.6.9 Use EhCacheManager(CacheManager, EhCacheReplicatorConfigFactory, CacheSettingsDefaultsProvider)
EhCacheManager(net.sf.ehcache.CacheManager delegate, CacheSettingsDefaultsProvider cacheSettingsDefaultsProvider) Deprecated. since 2.6.0 Use EhCacheManager(CacheManager, EhCacheReplicatorConfigFactory, CacheSettingsDefaultsProvider)
EhCacheManager(net.sf.ehcache.CacheManager delegate, EhCacheReplicatorConfigFactory replicatorConfigFactory, CacheSettingsDefaultsProvider cacheSettingsDefaultsProvider) Creates an instance backed by the provided instance of CacheManager.
EhCacheManager(net.sf.ehcache.CacheManager delegate, EhCacheReplicatorConfigFactory replicatorConfigFactory, CacheSettingsDefaultsProvider cacheSettingsDefaultsProvider, ValueProcessor valueProcessor) Creates an instance backed by the provided instance of CacheManager.

Method Summary

Modifier and Type	Method and Description
protected <K,V> ManagedCache	createComputingCache(String name, CacheSettings settings, CacheLoader<K,V> loader) Creates a cache that upon a miss is able to populate itself using the loader.
protected ManagedCache	createSimpleCache(String name, CacheSettings settings) Creates a cache with no loader, i.e.
<V> CachedReference<V>	getCachedReference(String name, Supplier<V> supplier, CacheSettings settings) Returns a Cached Reference, creating it if necessary.
boolean	isStatisticsEnabled()
void	registerMBeans(MBeanServer mBeanServer) Tells this object to register its JMX MBeans with the given server.
void	setStatisticsEnabled(boolean statisticsEnabled)
void	shutdown() Shuts down and clean all data of the current instance and its all caches.
void	unregisterMBeans(MBeanServer mBeanServer) Tells this object to deregister its JMX MBeans from the given server.

Methods inherited from class com.atlassian.cache.impl.AbstractCacheManager

flushCaches, getCache, getCache, getCache, getCache, getCache, getCachedReference, getCachedReference, getCachedReference, getCaches, getManagedCache, getManagedCaches, mergeSettings

Methods inherited from class java.lang.Object

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

Constructor Detail

EhCacheManager

@Deprecated
public EhCacheManager()

Deprecated. Since 5.6.9 Use EhCacheManager(CacheManager, EhCacheReplicatorConfigFactory, CacheSettingsDefaultsProvider)

Creates an instance backed by a new instance of CacheManager and a RMICacheReplicatorConfigFactory.

EhCacheManager

@Deprecated
public EhCacheManager(net.sf.ehcache.CacheManager delegate,
                                  @Nullable
                                  CacheSettingsDefaultsProvider cacheSettingsDefaultsProvider)

Deprecated. since 2.6.0 Use EhCacheManager(CacheManager, EhCacheReplicatorConfigFactory, CacheSettingsDefaultsProvider)

Creates an instance backed by the provided instance of CacheManager and a RMICacheReplicatorConfigFactory.

Parameters:

delegate - an Ehcache's cache manager

EhCacheManager

public EhCacheManager(net.sf.ehcache.CacheManager delegate,
                      @Nullable
                      EhCacheReplicatorConfigFactory replicatorConfigFactory,
                      @Nullable
                      CacheSettingsDefaultsProvider cacheSettingsDefaultsProvider)

Creates an instance backed by the provided instance of CacheManager.

Parameters:

delegate - an Ehcache's cache manager

EhCacheManager

public EhCacheManager(net.sf.ehcache.CacheManager delegate,
                      @Nullable
                      EhCacheReplicatorConfigFactory replicatorConfigFactory,
                      @Nullable
                      CacheSettingsDefaultsProvider cacheSettingsDefaultsProvider,
                      @Nullable
                      ValueProcessor valueProcessor)

Creates an instance backed by the provided instance of CacheManager.

Parameters:

delegate - an Ehcache's cache manager

Method Detail

isStatisticsEnabled

public boolean isStatisticsEnabled()

setStatisticsEnabled

public void setStatisticsEnabled(boolean statisticsEnabled)

getCachedReference

@Nonnull
public <V> CachedReference<V> getCachedReference(@Nonnull
                                                          String name,
                                                          @Nonnull
                                                          Supplier<V> supplier,
                                                          @Nonnull
                                                          CacheSettings settings)

Description copied from interface: CacheFactory

Returns a Cached Reference, creating it if necessary.

Specified by:

getCachedReference in interface CacheFactory

Parameters:

name - the name of the Cached Reference

supplier - the supplier for value to be cached, called if the value needs to be generated

settings - specifies the required cache settings

Returns:

the Cached Reference

createSimpleCache

protected ManagedCache createSimpleCache(@Nonnull
                                         String name,
                                         @Nonnull
                                         CacheSettings settings)

Description copied from class: AbstractCacheManager

Creates a cache with no loader, i.e. one populated via explicit puts.

Specified by:

createSimpleCache in class AbstractCacheManager

Parameters:

name - the name to give the cache (required)

Returns:

a non-null cache

createComputingCache

protected <K,V> ManagedCache createComputingCache(@Nonnull
                                                  String name,
                                                  @Nonnull
                                                  CacheSettings settings,
                                                  CacheLoader<K,V> loader)

Description copied from class: AbstractCacheManager

Creates a cache that upon a miss is able to populate itself using the loader.

Specified by:

createComputingCache in class AbstractCacheManager

Returns:

a non-null cache

shutdown

public void shutdown()

Description copied from interface: CacheManager

Shuts down and clean all data of the current instance and its all caches.

Specified by:

shutdown in interface CacheManager

Overrides:

shutdown in class AbstractCacheManager

registerMBeans

public void registerMBeans(@Nullable
                           MBeanServer mBeanServer)

Description copied from interface: MBeanRegistrar

Tells this object to register its JMX MBeans with the given server. What beans are registered, if any, is up to the implementation.

Specified by:

registerMBeans in interface MBeanRegistrar

Parameters:

mBeanServer - the server with which to register the MBeans (ignored if null)

unregisterMBeans

public void unregisterMBeans(@Nullable
                             MBeanServer mBeanServer)

Description copied from interface: MBeanRegistrar

Tells this object to deregister its JMX MBeans from the given server. All previously registered beans should be deregistered.

Specified by:

unregisterMBeans in interface MBeanRegistrar

Parameters:

mBeanServer - the server with which to deregister the MBeans (ignored if null)