com.atlassian.vcache.internal.core.service

Class AbstractVCacheService

java.lang.Object

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

All Implemented Interfaces:

VCacheLifecycleManager, VCacheManagement, VCacheFactory

Direct Known Subclasses:

GuavaVCacheService, LegacyVCacheService, MemcachedVCacheService, RedisVCacheService

public abstract class AbstractVCacheService
extends Object
implements VCacheFactory, VCacheManagement, VCacheLifecycleManager

Base implementation of a service.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected ExternalCacheKeyGenerator	externalCacheKeyGenerator
protected MetricsCollector	metricsCollector
protected Supplier<RequestContext>	threadLocalContextSupplier
protected TransactionControlManager	transactionControlManager
protected Supplier<RequestContext>	workContextContextSupplier

Constructor Summary

Constructors

Constructor and Description
AbstractVCacheService(Supplier<RequestContext> threadLocalContextSupplier, Supplier<RequestContext> workContextContextSupplier, VCacheSettingsDefaultsProvider defaultsProvider, VCacheCreationHandler creationHandler, MetricsCollector metricsCollector, ExternalCacheKeyGenerator externalCacheKeyGenerator, BegunTransactionalActivityHandler begunTransactionalActivityHandler)

Method Summary

Modifier and Type	Method and Description
Map<String,ExternalCacheDetails>	allExternalCacheDetails()
Map<String,JvmCacheDetails>	allJvmCacheDetails()
Map<String,RequestCacheDetails>	allRequestCacheDetails()
protected abstract <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 abstract <K,V> JvmCache<K,V>	createJvmCache(String name, JvmCacheSettings settings) Creates a JvmCache with the supplied parameters.
protected abstract <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 abstract <V> TransactionalExternalCache<V>	createTransactionalExternalCache(String name, ExternalCacheSettings settings, com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling, boolean valueSerializable) Creates a TransactionalExternalCache with the supplied parameters.
<V> DirectExternalCache<V>	getDirectExternalCache(String name, Marshaller<V> valueMarshaller, ExternalCacheSettings settings) Obtains a DirectExternalCache with the specified details.
<V> DirectExternalCache<V>	getDirectExternalCache(String name, com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling, ExternalCacheSettings settings) Obtains a DirectExternalCache with the specified details.
<K,V> JvmCache<K,V>	getJvmCache(String name, JvmCacheSettings settings) Obtains a JvmCache with the specified details.
<K,V> RequestCache<K,V>	getRequestCache(String name) Obtains a RequestCache with the specified details.
<V> StableReadExternalCache<V>	getStableReadExternalCache(String name, Marshaller<V> valueMarshaller, ExternalCacheSettings settings) Obtains a StableReadExternalCache with the specified details.
<V> StableReadExternalCache<V>	getStableReadExternalCache(String name, com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling, ExternalCacheSettings settings) Obtains a StableReadExternalCache with the specified details.
<V> TransactionalExternalCache<V>	getTransactionalExternalCache(String name, Marshaller<V> valueMarshaller, ExternalCacheSettings settings) Obtains a TransactionalExternalCache with the specified details.
<V> TransactionalExternalCache<V>	getTransactionalExternalCache(String name, com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling, ExternalCacheSettings settings) Obtains a TransactionalExternalCache with the specified details.
protected abstract org.slf4j.Logger	log() Returns the logger for the implementation service.
RequestMetrics	metrics(RequestContext context) Return the cache metrics for the supplied context.
Set<String>	transactionDiscard(RequestContext context) Discard the TransactionalExternalCache's that are associated with the supplied context.
void	transactionSync(RequestContext context) Synchronise the TransactionalExternalCache's that are associated with the supplied context.

Methods inherited from class java.lang.Object

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

Field Detail

workContextContextSupplier

protected final Supplier<RequestContext> workContextContextSupplier

threadLocalContextSupplier

protected final Supplier<RequestContext> threadLocalContextSupplier

transactionControlManager

protected final TransactionControlManager transactionControlManager

metricsCollector

protected final MetricsCollector metricsCollector

externalCacheKeyGenerator

protected final ExternalCacheKeyGenerator externalCacheKeyGenerator

Constructor Detail

AbstractVCacheService

public AbstractVCacheService(Supplier<RequestContext> threadLocalContextSupplier,
                             Supplier<RequestContext> workContextContextSupplier,
                             VCacheSettingsDefaultsProvider defaultsProvider,
                             VCacheCreationHandler creationHandler,
                             MetricsCollector metricsCollector,
                             ExternalCacheKeyGenerator externalCacheKeyGenerator,
                             BegunTransactionalActivityHandler begunTransactionalActivityHandler)

Method Detail

log

protected abstract org.slf4j.Logger log()

Returns the logger for the implementation service.

Returns:

the logger for the implementation service.

createJvmCache

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

Creates a JvmCache with the supplied parameters.

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 abstract <V> TransactionalExternalCache<V> createTransactionalExternalCache(String name,
                                                                                      ExternalCacheSettings settings,
                                                                                      com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling,
                                                                                      boolean valueSerializable)

Creates a TransactionalExternalCache with the supplied parameters.

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 abstract <V> StableReadExternalCache<V> createStableReadExternalCache(String name,
                                                                                ExternalCacheSettings settings,
                                                                                com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling,
                                                                                boolean valueSerializable)

Creates a StableReadExternalCache with the supplied parameters.

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 abstract <V> DirectExternalCache<V> createDirectExternalCache(String name,
                                                                        ExternalCacheSettings settings,
                                                                        com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling,
                                                                        boolean valueSerializable)

Creates a DirectExternalCache with the supplied parameters.

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

getJvmCache

public <K,V> JvmCache<K,V> getJvmCache(String name,
                                       JvmCacheSettings settings)

Description copied from interface: VCacheFactory

Obtains a JvmCache with the specified details.

Note: multiple calls to this method will always return the instance created on the first invocation. As such, any changes in the supplied settings will be ignored.

Specified by:

getJvmCache in interface VCacheFactory

Type Parameters:

K - the key type

V - the value type

Parameters:

name - the name of the cache

settings - the settings for the cache

Returns:

JvmCache with the specified details

getRequestCache

public <K,V> RequestCache<K,V> getRequestCache(String name)

Description copied from interface: VCacheFactory

Obtains a RequestCache with the specified details.

Note: multiple calls to this method will always return the instance created on the first invocation.

Specified by:

getRequestCache in interface VCacheFactory

Type Parameters:

K - the key type

V - the value type

Parameters:

name - the name of the cache

Returns:

RequestCache with the specified details

getTransactionalExternalCache

public <V> TransactionalExternalCache<V> getTransactionalExternalCache(String name,
                                                                       com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling,
                                                                       ExternalCacheSettings settings)

Description copied from interface: VCacheFactory

Obtains a TransactionalExternalCache with the specified details.

Note: each call to this method will return a new instance using the specified settings. However, the existing data stored in the external cache will remain. It is not expected in a production configuration that this method will be called multiple times, but is allowed is a development configuration.

Specified by:

getTransactionalExternalCache in interface VCacheFactory

Type Parameters:

V - the value type

Parameters:

name - the name of the cache

valueMarshalling - the marshaller for the values.

settings - the settings for the cache

Returns:

TransactionalExternalCache with the specified details

getTransactionalExternalCache

public <V> TransactionalExternalCache<V> getTransactionalExternalCache(String name,
                                                                       Marshaller<V> valueMarshaller,
                                                                       ExternalCacheSettings settings)

Description copied from interface: VCacheFactory

Obtains a TransactionalExternalCache with the specified details.

Note: each call to this method will return a new instance using the specified settings. However, the existing data stored in the external cache will remain. It is not expected in a production configuration that this method will be called multiple times, but is allowed is a development configuration.

Specified by:

getTransactionalExternalCache in interface VCacheFactory

Type Parameters:

V - the value type

Parameters:

name - the name of the cache

valueMarshaller - the marshaller for the values. See MarshallerFactory for provided implementations.

settings - the settings for the cache

Returns:

TransactionalExternalCache with the specified details

getStableReadExternalCache

public <V> StableReadExternalCache<V> getStableReadExternalCache(String name,
                                                                 com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling,
                                                                 ExternalCacheSettings settings)

Description copied from interface: VCacheFactory

Obtains a StableReadExternalCache with the specified details.

Note: each call to this method will return a new instance using the specified settings. However, the existing data stored in the external cache will remain. It is not expected in a production configuration that this method will be called multiple times, but is allowed is a development configuration.

Specified by:

getStableReadExternalCache in interface VCacheFactory

Type Parameters:

V - the value type

Parameters:

name - the name of the cache

valueMarshalling - the marshalling pair for the values.

settings - the settings for the cache

Returns:

StableReadExternalCache with the specified details

getStableReadExternalCache

public <V> StableReadExternalCache<V> getStableReadExternalCache(String name,
                                                                 Marshaller<V> valueMarshaller,
                                                                 ExternalCacheSettings settings)

Description copied from interface: VCacheFactory

Obtains a StableReadExternalCache with the specified details.

Note: each call to this method will return a new instance using the specified settings. However, the existing data stored in the external cache will remain. It is not expected in a production configuration that this method will be called multiple times, but is allowed is a development configuration.

Specified by:

getStableReadExternalCache in interface VCacheFactory

Type Parameters:

V - the value type

Parameters:

name - the name of the cache

valueMarshaller - the marshaller for the values. See MarshallerFactory for provided implementations.

settings - the settings for the cache

Returns:

StableReadExternalCache with the specified details

getDirectExternalCache

public <V> DirectExternalCache<V> getDirectExternalCache(String name,
                                                         com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling,
                                                         ExternalCacheSettings settings)

Description copied from interface: VCacheFactory

Obtains a DirectExternalCache with the specified details.

Note: each call to this method will return a new instance using the specified settings. However, the existing data stored in the external cache will remain. It is not expected in a production configuration that this method will be called multiple times, but is allowed is a development configuration.

Specified by:

getDirectExternalCache in interface VCacheFactory

Type Parameters:

V - the value type

Parameters:

name - the name of the cache

valueMarshalling - the marshalling pair to be used for marshalling.

settings - the settings for the cache

Returns:

DirectExternalCache with the specified details

getDirectExternalCache

public <V> DirectExternalCache<V> getDirectExternalCache(String name,
                                                         Marshaller<V> valueMarshaller,
                                                         ExternalCacheSettings settings)

Description copied from interface: VCacheFactory

Obtains a DirectExternalCache with the specified details.

Note: each call to this method will return a new instance using the specified settings. However, the existing data stored in the external cache will remain. It is not expected in a production configuration that this method will be called multiple times, but is allowed is a development configuration.

Specified by:

getDirectExternalCache in interface VCacheFactory

Type Parameters:

V - the value type

Parameters:

name - the name of the cache

valueMarshaller - the marshaller for the values. See MarshallerFactory for provided implementations.

settings - the settings for the cache

Returns:

DirectExternalCache with the specified details

transactionSync

public void transactionSync(RequestContext context)

Description copied from interface: VCacheLifecycleManager

Synchronise the TransactionalExternalCache's that are associated with the supplied context.

Specified by:

transactionSync in interface VCacheLifecycleManager

Parameters:

context - the request context to synchronise.

transactionDiscard

public Set<String> transactionDiscard(RequestContext context)

Description copied from interface: VCacheLifecycleManager

Discard the TransactionalExternalCache's that are associated with the supplied context.

Specified by:

transactionDiscard in interface VCacheLifecycleManager

Parameters:

context - the request context to discard.

Returns:

names of the caches that have operations being discarded.

metrics

public RequestMetrics metrics(RequestContext context)

Description copied from interface: VCacheLifecycleManager

Return the cache metrics for the supplied context.

Specified by:

metrics in interface VCacheLifecycleManager

Parameters:

context - the request context to obtain metrics for.

Returns:

the cache metrics for the request

allJvmCacheDetails

public Map<String,JvmCacheDetails> allJvmCacheDetails()

Specified by:

allJvmCacheDetails in interface VCacheManagement

allRequestCacheDetails

public Map<String,RequestCacheDetails> allRequestCacheDetails()

Specified by:

allRequestCacheDetails in interface VCacheManagement

allExternalCacheDetails

public Map<String,ExternalCacheDetails> allExternalCacheDetails()

Specified by:

allExternalCacheDetails in interface VCacheManagement