com.atlassian.jira.cache

Class JiraVCacheServiceCreator

java.lang.Object

com.atlassian.jira.cache.JiraVCacheServiceCreator

public class JiraVCacheServiceCreator
extends Object

Creates and configures implementation of AbstractVCacheService based on configuration properties. Currently the following properties are supported:

• com.atlassian.vcache.max_ttl_secs - maximum ttl in seconds. Defaults to 24 hours if not specified.
• com.atlassian.vcache.max_entries - maximum number of entries that can be stored in the cache. Defaults to Integer.MAX_VALUE if not specified.
• com.atlassian.vcache.force_vcache_backend - if defined it forces creation of a given vcache backed. Supported values are: legacy, redis (not implemented yet), memcached.
• com.atlassian.vcache.memcached.host - memcached host
• com.atlassian.vcache.memcached.port - memcached port
• com.atlassian.vcache.warn_no_context - if defined warning will be logged every time VCache is accessed from uninitialised context
• CacheStatisticsMonitor.JIRA_CACHE_INSTRUMENTATION - if defined vcache statistics will be collected.

Since:

v7.1

Constructor Summary

Constructors

Constructor and Description
JiraVCacheServiceCreator(JiraProperties jiraProperties, Optional<com.atlassian.cache.CacheFactory> cacheFactory, boolean avoidCasOps) Constructs JiraVCacheServiceCreator.

Method Summary

Modifier and Type	Method and Description
io.atlassian.fugue.Pair<JiraVCacheRequestContextSupplier,com.atlassian.vcache.internal.core.service.AbstractVCacheService>	createVCacheService() Instantiates and configures appropriate implementation of AbstractVCacheService and JiraVCacheRequestContextSupplier based on JIRA environment and properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

JiraVCacheServiceCreator

public JiraVCacheServiceCreator(JiraProperties jiraProperties,
                                Optional<com.atlassian.cache.CacheFactory> cacheFactory,
                                boolean avoidCasOps)

Constructs JiraVCacheServiceCreator.

Parameters:

jiraProperties - that would be used to get properties that determine cache type that should be created.

cacheFactory - required if cache to be created is of type LegacyVCacheService.

avoidCasOps - if set to true vcache would try to avoid calling CAS operations on underlying cache backend. It is required for certain types of caches (e.g. ehcache) that do not support CAS.

Method Detail

createVCacheService

@Nonnull
public io.atlassian.fugue.Pair<JiraVCacheRequestContextSupplier,com.atlassian.vcache.internal.core.service.AbstractVCacheService> createVCacheService()

Instantiates and configures appropriate implementation of AbstractVCacheService and JiraVCacheRequestContextSupplier based on JIRA environment and properties.

Returns:

Pair of configured instances of JiraVCacheRequestContextSupplier and AbstractVCacheService.