com.atlassian.vcache.internal.redis

Class RedisVCacheService

java.lang.Object

com.atlassian.vcache.internal.core.service.AbstractVCacheService

com.atlassian.vcache.internal.redis.RedisVCacheService

All Implemented Interfaces:

VCacheLifecycleManager, VCacheManagement, VCacheFactory

public class RedisVCacheService
extends AbstractVCacheService

Main service that is backed by Redis.

Since:

1.0.0

Field Summary

Fields inherited from class com.atlassian.vcache.internal.core.service.AbstractVCacheService

externalCacheKeyGenerator, lockTimeout, metricsCollector, threadLocalContextSupplier, transactionControlManager, workContextContextSupplier

Constructor Summary

Constructors

Constructor and Description
RedisVCacheService(String productIdentifier, Supplier<redis.clients.jedis.Jedis> clientSupplier, Supplier<RequestContext> threadLocalContextSupplier, Supplier<RequestContext> workContextContextSupplier, VCacheSettingsDefaultsProvider defaultsProvider, VCacheCreationHandler creationHandler, MetricsCollector metricsCollector, BegunTransactionalActivityHandler begunTransactionalActivityHandler, Duration lockTimeout) Creates an instance, with the default ExternalCacheKeyGenerator.
RedisVCacheService(Supplier<redis.clients.jedis.Jedis> clientSupplier, Supplier<RequestContext> threadLocalContextSupplier, Supplier<RequestContext> workContextContextSupplier, VCacheSettingsDefaultsProvider defaultsProvider, VCacheCreationHandler creationHandler, MetricsCollector metricsCollector, ExternalCacheKeyGenerator externalCacheKeyGenerator, BegunTransactionalActivityHandler begunTransactionalActivityHandler, Duration lockTimeout) Creates an instance, with a supplied ExternalCacheKeyGenerator.

Method Summary

Modifier and Type	Method and Description
protected <V> DirectExternalCache<V>	createDirectExternalCache(String name, ExternalCacheSettings settings, com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling, boolean valueSerializable) Creates a DirectExternalCache with the supplied parameters.
protected <K,V> JvmCache<K,V>	createJvmCache(String name, JvmCacheSettings settings) Creates a JvmCache with the supplied parameters.
protected <V> StableReadExternalCache<V>	createStableReadExternalCache(String name, ExternalCacheSettings settings, com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling, boolean valueSerializable) Creates a StableReadExternalCache with the supplied parameters.
protected <V> TransactionalExternalCache<V>	createTransactionalExternalCache(String name, ExternalCacheSettings settings, com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling, boolean valueSerializable) Creates a TransactionalExternalCache with the supplied parameters.
protected org.slf4j.Logger	log() Returns the logger for the implementation service.

Methods inherited from class com.atlassian.vcache.internal.core.service.AbstractVCacheService

allExternalCacheDetails, allJvmCacheDetails, allRequestCacheDetails, getDirectExternalCache, getDirectExternalCache, getJvmCache, getRequestCache, getStableReadExternalCache, getStableReadExternalCache, getTransactionalExternalCache, getTransactionalExternalCache, metrics, transactionDiscard, transactionSync

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.vcache.VCacheFactory

getRequestCache

Constructor Detail

RedisVCacheService

public RedisVCacheService(String productIdentifier,
                          Supplier<redis.clients.jedis.Jedis> clientSupplier,
                          Supplier<RequestContext> threadLocalContextSupplier,
                          Supplier<RequestContext> workContextContextSupplier,
                          VCacheSettingsDefaultsProvider defaultsProvider,
                          VCacheCreationHandler creationHandler,
                          MetricsCollector metricsCollector,
                          BegunTransactionalActivityHandler begunTransactionalActivityHandler,
                          Duration lockTimeout)

Creates an instance, with the default ExternalCacheKeyGenerator.

Parameters:

productIdentifier - the unique product identifier, such as jira or confluence

clientSupplier - the supplier for the Memcached client

threadLocalContextSupplier - the supplier for the request context.

workContextContextSupplier - A supplier of a thread safe request context.

defaultsProvider - the cache defaults provider

creationHandler - the handler called when caches are being created.

metricsCollector - the collector for gathering metrics.

RedisVCacheService

public RedisVCacheService(Supplier<redis.clients.jedis.Jedis> clientSupplier,
                          Supplier<RequestContext> threadLocalContextSupplier,
                          Supplier<RequestContext> workContextContextSupplier,
                          VCacheSettingsDefaultsProvider defaultsProvider,
                          VCacheCreationHandler creationHandler,
                          MetricsCollector metricsCollector,
                          ExternalCacheKeyGenerator externalCacheKeyGenerator,
                          BegunTransactionalActivityHandler begunTransactionalActivityHandler,
                          Duration lockTimeout)

Creates an instance, with a supplied ExternalCacheKeyGenerator.

Parameters:

clientSupplier - the supplier for the Memcached client

threadLocalContextSupplier - the supplier for the request context.

workContextContextSupplier - A supplier of a thread safe request context.

defaultsProvider - the cache defaults provider

creationHandler - the handler called when caches are being created.

metricsCollector - the collector for gathering metrics.

Method Detail

log

protected org.slf4j.Logger log()

Description copied from class: AbstractVCacheService

Returns the logger for the implementation service.

Specified by:

log in class AbstractVCacheService

Returns:

the logger for the implementation service.

createJvmCache

protected <K,V> JvmCache<K,V> createJvmCache(String name,
                                             JvmCacheSettings settings)

Description copied from class: AbstractVCacheService

Creates a JvmCache with the supplied parameters.

Specified by:

createJvmCache in class AbstractVCacheService

Type Parameters:

K - the key type

V - the value type

Parameters:

name - the name of the cache

settings - the setting for the cache

Returns:

a freshly minted JvmCache

createTransactionalExternalCache

protected <V> TransactionalExternalCache<V> createTransactionalExternalCache(String name,
                                                                             ExternalCacheSettings settings,
                                                                             com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling,
                                                                             boolean valueSerializable)

Description copied from class: AbstractVCacheService

Creates a TransactionalExternalCache with the supplied parameters.

Specified by:

createTransactionalExternalCache in class AbstractVCacheService

Type Parameters:

V - the value type

Parameters:

name - the name of the cache

settings - the settings for the cache

valueMarshalling - the marshalling pair for values

valueSerializable - whether the values are Serializable

Returns:

a freshly minted TransactionalExternalCache

createStableReadExternalCache

protected <V> StableReadExternalCache<V> createStableReadExternalCache(String name,
                                                                       ExternalCacheSettings settings,
                                                                       com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling,
                                                                       boolean valueSerializable)

Description copied from class: AbstractVCacheService

Creates a StableReadExternalCache with the supplied parameters.

Specified by:

createStableReadExternalCache in class AbstractVCacheService

Type Parameters:

V - the value type

Parameters:

name - the name of the cache

settings - the settings for the cache

valueMarshalling - the marshalling pair for values

valueSerializable - whether the values are Serializable

Returns:

a freshly minted StableReadExternalCache

createDirectExternalCache

protected <V> DirectExternalCache<V> createDirectExternalCache(String name,
                                                               ExternalCacheSettings settings,
                                                               com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling,
                                                               boolean valueSerializable)

Description copied from class: AbstractVCacheService

Creates a DirectExternalCache with the supplied parameters.

Specified by:

createDirectExternalCache in class AbstractVCacheService

Type Parameters:

V - the value type

Parameters:

name - the name of the cache

settings - the settings for the cache

valueMarshalling - the marshalling pair for values

valueSerializable - whether the values are Serializable

Returns:

a freshly minted DirectExternalCache