com.atlassian.vcache.internal.core.service

Class AbstractExternalCache<V>

java.lang.Object

com.atlassian.vcache.internal.core.service.AbstractExternalCache<V>

Type Parameters:

V - the value type

All Implemented Interfaces:

ExternalCache<V>, VCache

Direct Known Subclasses:

AbstractStableReadExternalCache, AbstractTransactionalExternalCache, GuavaDirectExternalCache

public abstract class AbstractExternalCache<V>
extends Object
implements ExternalCache<V>

Provides common operations for ExternalCache instances.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected Duration	lockTimeout
protected String	name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractExternalCache(String name, Duration lockTimeout, ExternalCacheExceptionListener externalCacheExceptionListener)

Method Summary

Modifier and Type	Method and Description
protected abstract AbstractExternalCacheRequestContext<V>	ensureCacheContext() Returns the cache context for the current request.
protected abstract org.slf4j.Logger	getLogger() Returns the logging instance for the implementation class.
String	getName() The name of the cache, uniquely identifies this cache.
protected abstract ExternalCacheException	mapException(Exception ex) Maps a generic Exception to a corresponding ExternalCacheException.
protected <T> CompletionStage<T>	perform(Callable<T> txn) Performs a transaction and handles all the standard exceptions that may occur.
protected <T> CompletionStage<T>	perform(Callable<T> txn, Consumer<T> successHandler) Performs a transaction and handles all the standard exceptions that may occur.

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.ExternalCache

get, get, getBulk, getBulk, getBulk, getBulk

Field Detail

name

protected final String name

lockTimeout

protected final Duration lockTimeout

Constructor Detail

AbstractExternalCache

protected AbstractExternalCache(String name,
                                Duration lockTimeout,
                                ExternalCacheExceptionListener externalCacheExceptionListener)

Method Detail

ensureCacheContext

protected abstract AbstractExternalCacheRequestContext<V> ensureCacheContext()

Returns the cache context for the current request.

Returns:

the cache context for the current request.

getLogger

protected abstract org.slf4j.Logger getLogger()

Returns the logging instance for the implementation class.

Returns:

the logging instance for the implementation class.

mapException

protected abstract ExternalCacheException mapException(Exception ex)

Maps a generic Exception to a corresponding ExternalCacheException.

getName

public final String getName()

Description copied from interface: VCache

The name of the cache, uniquely identifies this cache.

Specified by:

getName in interface VCache

Returns:

the name of the cache

perform

protected <T> CompletionStage<T> perform(Callable<T> txn)

Performs a transaction and handles all the standard exceptions that may occur.

Type Parameters:

T - the return type

Parameters:

txn - the transaction the perform

Returns:

A CompletionStage representing the outcome of performing the transaction.

perform

protected <T> CompletionStage<T> perform(Callable<T> txn,
                                         Consumer<T> successHandler)

Performs a transaction and handles all the standard exceptions that may occur.

Type Parameters:

T - the return type

Parameters:

txn - the transaction the perform

successHandler - called if the txn is successful

Returns:

A CompletionStage representing the outcome of performing the transaction.