com.atlassian.vcache.internal.core.service

Class AbstractExternalCacheRequestContext<V>

java.lang.Object

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

Type Parameters:

V - the value type

Direct Known Subclasses:

UnversionedExternalCacheRequestContext, VersionedExternalCacheRequestContext

public abstract class AbstractExternalCacheRequestContext<V>
extends Object

Represents the request context for an ExternalCache.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractExternalCacheRequestContext.DeferredOperation<V> Represents a deferred operation.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractExternalCacheRequestContext(ExternalCacheKeyGenerator keyGenerator, String name, Supplier<String> partitionSupplier, Duration lockTimeout)

Method Summary

Modifier and Type	Method and Description
protected abstract long	cacheVersion()
protected void	clearKeyMaps()
String	externalEntryKeyFor(String internalKey)
void	forgetAll()
void	forgetAllValues()
void	forgetValue(String internalKey)
VCacheLock	getGlobalLock()
Set<Map.Entry<String,AbstractExternalCacheRequestContext.DeferredOperation<V>>>	getKeyedOperations()
Optional<Optional<V>>	getValueRecorded(String internalKey)
boolean	hasPendingOperations()
boolean	hasRemoveAll()
String	internalEntryKeyFor(String externalKey) Returns the internal key for a supplied external key.
void	recordPut(String internalKey, V value, PutPolicy policy) Saves a new value in the value map and adds the put policy for this operation.
void	recordPutPolicy(String internalKey, V value, PutPolicy policy) Stores the policy for the recordPut().
void	recordRemove(Iterable<String> internalKeys)
void	recordRemoveAll()
void	recordValue(String internalKey, Optional<V> outcome)
void	recordValues(Map<String,V> knownValues)

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final String name

Constructor Detail

AbstractExternalCacheRequestContext

protected AbstractExternalCacheRequestContext(ExternalCacheKeyGenerator keyGenerator,
                                              String name,
                                              Supplier<String> partitionSupplier,
                                              Duration lockTimeout)

Method Detail

cacheVersion

protected abstract long cacheVersion()

clearKeyMaps

protected void clearKeyMaps()

getGlobalLock

public VCacheLock getGlobalLock()

externalEntryKeyFor

public String externalEntryKeyFor(String internalKey)

internalEntryKeyFor

public String internalEntryKeyFor(String externalKey)

Returns the internal key for a supplied external key. The externalEntryKeyFor(String) must have returned the value now being specified, in the current request.

Parameters:

externalKey - the external key previously returned by externalEntryKeyFor(String)

Returns:

the internal key

getValueRecorded

public Optional<Optional<V>> getValueRecorded(String internalKey)

recordValue

public void recordValue(String internalKey,
                        Optional<V> outcome)

recordValues

public void recordValues(Map<String,V> knownValues)

forgetValue

public void forgetValue(String internalKey)

forgetAllValues

public void forgetAllValues()

recordPut

public void recordPut(String internalKey,
                      V value,
                      PutPolicy policy)

Saves a new value in the value map and adds the put policy for this operation.

Parameters:

internalKey - The internal key.

value - The value to record.

policy - The PutPolicy used to record this value.

recordPutPolicy

public void recordPutPolicy(String internalKey,
                            V value,
                            PutPolicy policy)

Stores the policy for the recordPut().

Parameters:

internalKey - The internal key

value - The value saved.

policy - The PutPolicy used to record this value.

recordRemove

public void recordRemove(Iterable<String> internalKeys)

recordRemoveAll

public void recordRemoveAll()

hasRemoveAll

public boolean hasRemoveAll()

forgetAll

public void forgetAll()

getKeyedOperations

public Set<Map.Entry<String,AbstractExternalCacheRequestContext.DeferredOperation<V>>> getKeyedOperations()

hasPendingOperations

public boolean hasPendingOperations()