com.atlassian.jira.component.pico.registrar

Class CacheManagerRegistrar

java.lang.Object

com.atlassian.jira.component.pico.registrar.CacheManagerRegistrar

public class CacheManagerRegistrar
extends Object

Registers the CacheManager with the Pico container.

Since:

6.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISABLE_DEFERRED_CACHE_REPLICATION If set to true deferred replication of remote cache will be disabled.
static String	EHCACHE_CONFIGURATION The name of the system property which if set provides the URL of the Ehcache XML configuration file (overriding the built-in ehcache.xml file).
static String	ENABLE_EHCACHE_STATISTICS The name of the system property which if set to "true" enables the use of ehcache statistics by default.
static String	ENABLE_JMX The name of the system property which if set to "true" enables JMX monitoring of atlassian-cache (which MBeans are available depends upon the atlassian-cache implementation).
static String	ENABLE_SERIALIZATION_CHECK If set to true, every value stored in the cache will be checked for serializability.
static String	ENABLE_SLOMO Decorates every single cache such that every operation (whether get or remove) takes at least the specified number of milliseconds.
static String	ENABLE_STATISTICS The name of the system property which if set to "true" enables the use of memory-cache statistics by default.
static String	FORCE_EHCACHE The name of the system property which if set to "true" forces the use of Ehcache.
static String	SERIALIZATION_RECORDING_FILE If set, non-simple keys from all caches and values from fully-replicated caches are recorded to this file.

Constructor Summary

Constructors

Constructor and Description
CacheManagerRegistrar()

Method Summary

Modifier and Type	Method and Description
static void	registerCacheManager(ComponentContainer container, MBeanServer mBeanServer) Registers the CacheManager with the given container.
static void	shutDownCacheManager(ComponentContainer container, MBeanServer mBeanServer)

Methods inherited from class java.lang.Object

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

Field Detail

EHCACHE_CONFIGURATION

public static final String EHCACHE_CONFIGURATION

The name of the system property which if set provides the URL of the Ehcache XML configuration file (overriding the built-in ehcache.xml file). If this URL begins with "/", it will be resolved relative to the classpath.

See Also:

Constant Field Values

ENABLE_JMX

public static final String ENABLE_JMX

The name of the system property which if set to "true" enables JMX monitoring of atlassian-cache (which MBeans are available depends upon the atlassian-cache implementation).

See Also:

Constant Field Values

FORCE_EHCACHE

public static final String FORCE_EHCACHE

The name of the system property which if set to "true" forces the use of Ehcache.

See Also:

Constant Field Values

ENABLE_STATISTICS

public static final String ENABLE_STATISTICS

The name of the system property which if set to "true" enables the use of memory-cache statistics by default.

See Also:

Constant Field Values

ENABLE_EHCACHE_STATISTICS

public static final String ENABLE_EHCACHE_STATISTICS

The name of the system property which if set to "true" enables the use of ehcache statistics by default.

See Also:

Constant Field Values

ENABLE_SLOMO

public static final String ENABLE_SLOMO

Decorates every single cache such that every operation (whether get or remove) takes at least the specified number of milliseconds. Non-positive values disable this. Values larger than a few milliseconds would probably make the cache slower than just going to the database, so there probably isn't much point in that. Consider using something in the neighborhood of 5 to 10.

See Also:

Constant Field Values

ENABLE_SERIALIZATION_CHECK

public static final String ENABLE_SERIALIZATION_CHECK

If set to true, every value stored in the cache will be checked for serializability. This incurs a performance penalty.

Since:

7.2.0

See Also:

Constant Field Values

SERIALIZATION_RECORDING_FILE

public static final String SERIALIZATION_RECORDING_FILE

If set, non-simple keys from all caches and values from fully-replicated caches are recorded to this file. This incurs a performance penalty.

Since:

7.4.0

See Also:

Constant Field Values

DISABLE_DEFERRED_CACHE_REPLICATION

public static final String DISABLE_DEFERRED_CACHE_REPLICATION

If set to true deferred replication of remote cache will be disabled. Valid only for EhCache.

Since:

7.2.12

See Also:

Constant Field Values

Constructor Detail

CacheManagerRegistrar

public CacheManagerRegistrar()

Method Detail

registerCacheManager

public static void registerCacheManager(ComponentContainer container,
                                        MBeanServer mBeanServer)

Registers the CacheManager with the given container.

Parameters:

container - the container to receive the CacheManager (required)

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

shutDownCacheManager

public static void shutDownCacheManager(ComponentContainer container,
                                        MBeanServer mBeanServer)