com.atlassian.vcache.internal.guava

Class GuavaStableReadExternalCache<V>

java.lang.Object

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

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

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

com.atlassian.vcache.internal.guava.GuavaStableReadExternalCache<V>

Type Parameters:

V - the value type

All Implemented Interfaces:

ExternalCache<V>, ExternalWriteOperationsUnbuffered<V>, StableReadExternalCache<V>, VCache

public class GuavaStableReadExternalCache<V>
extends AbstractStableReadExternalCache<V>

Guava implementation of StableReadExternalCache.

Since:

1.0.0

Field Summary

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

metricsRecorder

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

name

Constructor Summary

Constructors

Constructor and Description
GuavaStableReadExternalCache(String name, com.google.common.cache.Cache<String,IdentifiedData> delegate, Supplier<RequestContext> contextSupplier, ExternalCacheKeyGenerator keyGenerator, Optional<com.atlassian.marshalling.api.MarshallingPair<V>> valueMarshalling, MetricsRecorder metricsRecorder)

Method Summary

Modifier and Type	Method and Description
protected Optional<V>	directGet(String externalKey) Performs a direct get operation against the external cache using the supplied external key.
protected Map<String,Optional<V>>	directGetBulk(Set<String> externalKeys) Performs a direct bulk get operation against the external cache using the supplied external keys.
protected AbstractExternalCacheRequestContext<V>	ensureCacheContext() Returns the cache context for the current request.
protected org.slf4j.Logger	getLogger() Returns the logging instance for the implementation class.
protected Map<String,V>	handleCreation(Function<Set<String>,Map<String,V>> factory, Set<String> externalKeys) Handles the creation of a number of entries
protected V	handleCreation(String internalKey, Supplier<V> supplier) Handles the creation of an entry, if required.
protected CompletionStage<Boolean>	internalPut(String internalKey, V value, PutPolicy policy)
protected CompletionStage<Void>	internalRemove(Iterable<String> internalKeys)
protected CompletionStage<Void>	internalRemoveAll()
protected ExternalCacheException	mapException(Exception ex) Maps a generic Exception to a corresponding ExternalCacheException.

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

checkValuesRecorded, get, get, getBulk, getBulk, put, remove, removeAll

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

getName, perform, perform

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

getBulk, getBulk

Methods inherited from interface com.atlassian.vcache.VCache

getName

Methods inherited from interface com.atlassian.vcache.ExternalWriteOperationsUnbuffered

remove

Constructor Detail

GuavaStableReadExternalCache

public GuavaStableReadExternalCache(String name,
                                    com.google.common.cache.Cache<String,IdentifiedData> delegate,
                                    Supplier<RequestContext> contextSupplier,
                                    ExternalCacheKeyGenerator keyGenerator,
                                    Optional<com.atlassian.marshalling.api.MarshallingPair<V>> valueMarshalling,
                                    MetricsRecorder metricsRecorder)

Method Detail

internalPut

protected CompletionStage<Boolean> internalPut(String internalKey,
                                               V value,
                                               PutPolicy policy)

Specified by:

internalPut in class AbstractStableReadExternalCache<V>

internalRemove

protected CompletionStage<Void> internalRemove(Iterable<String> internalKeys)

Specified by:

internalRemove in class AbstractStableReadExternalCache<V>

internalRemoveAll

protected CompletionStage<Void> internalRemoveAll()

Specified by:

internalRemoveAll in class AbstractStableReadExternalCache<V>

getLogger

protected org.slf4j.Logger getLogger()

Description copied from class: AbstractExternalCache

Returns the logging instance for the implementation class.

Specified by:

getLogger in class AbstractExternalCache<V>

Returns:

the logging instance for the implementation class.

ensureCacheContext

protected AbstractExternalCacheRequestContext<V> ensureCacheContext()

Description copied from class: AbstractExternalCache

Returns the cache context for the current request.

Specified by:

ensureCacheContext in class AbstractExternalCache<V>

Returns:

the cache context for the current request.

handleCreation

protected V handleCreation(String internalKey,
                           Supplier<V> supplier)
                    throws ExecutionException,
                           InterruptedException

Description copied from class: AbstractNonDirectExternalCache

Handles the creation of an entry, if required.

Specified by:

handleCreation in class AbstractNonDirectExternalCache<V>

Parameters:

internalKey - the internal key for the entry.

supplier - called to create the value, if required

Returns:

the value associated with the key.

Throws:

ExecutionException

InterruptedException

handleCreation

protected Map<String,V> handleCreation(Function<Set<String>,Map<String,V>> factory,
                                       Set<String> externalKeys)
                                throws ExecutionException,
                                       InterruptedException

Description copied from class: AbstractNonDirectExternalCache

Handles the creation of a number of entries

Specified by:

handleCreation in class AbstractNonDirectExternalCache<V>

Parameters:

factory - called to create the required values.

externalKeys - the external keys for the entries.

Returns:

the values associated with the supplied keys (mapped on internal key)

Throws:

ExecutionException

InterruptedException

mapException

protected final ExternalCacheException mapException(Exception ex)

Description copied from class: AbstractExternalCache

Maps a generic Exception to a corresponding ExternalCacheException.

Specified by:

mapException in class AbstractExternalCache<V>

directGet

protected final Optional<V> directGet(String externalKey)

Description copied from class: AbstractNonDirectExternalCache

Performs a direct get operation against the external cache using the supplied external key.

Specified by:

directGet in class AbstractNonDirectExternalCache<V>

directGetBulk

protected final Map<String,Optional<V>> directGetBulk(Set<String> externalKeys)

Description copied from class: AbstractNonDirectExternalCache

Performs a direct bulk get operation against the external cache using the supplied external keys.

Specified by:

directGetBulk in class AbstractNonDirectExternalCache<V>