com.atlassian.vcache.internal.core.service

Class AbstractTransactionalExternalCache<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.AbstractTransactionalExternalCache<V>

Type Parameters:

V - the value type

All Implemented Interfaces:

ExternalCache<V>, ExternalWriteOperationsBuffered<V>, TransactionControl, TransactionalExternalCache<V>, VCache

Direct Known Subclasses:

GuavaTransactionalExternalCache

public abstract class AbstractTransactionalExternalCache<V>
extends AbstractNonDirectExternalCache<V>
implements TransactionalExternalCache<V>, TransactionControl

Provides operations common for TransactionalExternalCache instances.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected Supplier<RequestContext>	contextSupplier

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

Modifier	Constructor and Description
protected	AbstractTransactionalExternalCache(String name, Supplier<RequestContext> contextSupplier, MetricsRecorder metricsRecorder)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Optional<V>>	checkValuesRecorded(Iterable<String> internalKeys) Checks for values recorded for specified internal keys.
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.
void	put(String internalKey, V value, PutPolicy policy) Puts the value under the specified key using the specified policy.
void	remove(Iterable<String> internalKeys) Remove the entries with the specified keys.
void	removeAll() Remove all entries in the cache.
boolean	transactionDiscard() Discard any changes.

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

directGet, directGetBulk, get, get, getBulk, getBulk

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

ensureCacheContext, getLogger, getName, mapException, 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

get, get, getBulk, getBulk, getBulk, getBulk

Methods inherited from interface com.atlassian.vcache.VCache

getName

Methods inherited from interface com.atlassian.vcache.ExternalWriteOperationsBuffered

remove

Methods inherited from interface com.atlassian.vcache.internal.core.TransactionControl

transactionSync

Field Detail

contextSupplier

protected final Supplier<RequestContext> contextSupplier

Constructor Detail

AbstractTransactionalExternalCache

protected AbstractTransactionalExternalCache(String name,
                                             Supplier<RequestContext> contextSupplier,
                                             MetricsRecorder metricsRecorder)

Method Detail

put

public final void put(String internalKey,
                      V value,
                      PutPolicy policy)

Description copied from interface: ExternalWriteOperationsBuffered

Puts the value under the specified key using the specified policy.

Specified by:

put in interface ExternalWriteOperationsBuffered<V>

Parameters:

internalKey - the key to put the data under

value - the value to associate with the key.

policy - the policy to apply

remove

public final void remove(Iterable<String> internalKeys)

Description copied from interface: ExternalWriteOperationsBuffered

Remove the entries with the specified keys.

Specified by:

remove in interface ExternalWriteOperationsBuffered<V>

Parameters:

internalKeys - the keys of the entries to remove.

removeAll

public final void removeAll()

Description copied from interface: ExternalWriteOperationsBuffered

Remove all entries in the cache.

Specified by:

removeAll in interface ExternalWriteOperationsBuffered<V>

transactionDiscard

public final boolean transactionDiscard()

Description copied from interface: TransactionControl

Discard any changes.

Specified by:

transactionDiscard in interface TransactionControl

Returns:

whether any changes were discarded.

checkValuesRecorded

protected final Map<String,Optional<V>> checkValuesRecorded(Iterable<String> internalKeys)

Description copied from class: AbstractNonDirectExternalCache

Checks for values recorded for specified internal keys.

Specified by:

checkValuesRecorded in class AbstractNonDirectExternalCache<V>

handleCreation

protected final 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 final 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