com.atlassian.vcache.internal.guava

Class GuavaDirectExternalCache<V>

java.lang.Object

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

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

Type Parameters:

V - the value type.

All Implemented Interfaces:

DirectExternalCache<V>, ExternalCache<V>, ExternalWriteOperationsUnbuffered<V>, VCache

public class GuavaDirectExternalCache<V>
extends AbstractExternalCache<V>
implements DirectExternalCache<V>

Guava based implementation of DirectExternalCache.

Since:

1.0.0

Field Summary

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

lockTimeout, name

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected AbstractExternalCacheRequestContext<V>	ensureCacheContext() Returns the cache context for the current request.
CompletionStage<Optional<V>>	get(String internalKey) Returns a value that is associated with a specified key.
CompletionStage<V>	get(String internalKey, Supplier<V> supplier) Returns a value that may be associated with a specified key.
CompletionStage<Map<String,V>>	getBulk(Function<Set<String>,Map<String,V>> factory, Iterable<String> internalKeys) Returns the values that are associated with the specified keys.
CompletionStage<Map<String,Optional<V>>>	getBulk(Iterable<String> internalKeys) Returns the values that are associated with the specified keys.
CompletionStage<Map<String,Optional<IdentifiedValue<V>>>>	getBulkIdentified(Iterable<String> internalKeys) Returns the IdentifiedValue's that are associated with the specified keys.
CompletionStage<Optional<IdentifiedValue<V>>>	getIdentified(String internalKey) Returns an identified value that is associated with a specified key.
CompletionStage<IdentifiedValue<V>>	getIdentified(String internalKey, Supplier<V> supplier) Returns an identified value that is associated with a specified key.
protected org.slf4j.Logger	getLogger() Returns the logging instance for the implementation class.
protected ExternalCacheException	mapException(Exception ex) Maps a generic Exception to a corresponding ExternalCacheException.
CompletionStage<Boolean>	put(String internalKey, V value, PutPolicy policy) Puts the value under the specified key using the specified policy.
CompletionStage<Void>	remove(Iterable<String> internalKeys) Remove the entries with the specified keys.
CompletionStage<Void>	removeAll() Remove all entries in the cache.
CompletionStage<Boolean>	removeIf(String internalKey, CasIdentifier casId) Removes the specified entry, iff the specified CAS identifier matches.
CompletionStage<Boolean>	replaceIf(String internalKey, CasIdentifier casId, V newValue) Replaces the value for a specified entry, iff the specified CAS identifier matches.

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

getBulkIdentified

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

GuavaDirectExternalCache

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

Method Detail

get

public CompletionStage<Optional<V>> get(String internalKey)

Description copied from interface: ExternalCache

Returns a value that is associated with a specified key.

Specified by:

get in interface ExternalCache<V>

Parameters:

internalKey - the key to check.

Returns:

an Optional which may contain the value associated with the key.

get

public CompletionStage<V> get(String internalKey,
                              Supplier<V> supplier)

Description copied from interface: ExternalCache

Returns a value that may be associated with a specified key.

Notes:

• If no entry for the specified key exists, then the specified supplier is called. The value may be used to create an entry in the cache. However, the value returned may be that of the supplier to a concurrent call to this method, or that of the factory in a concurrent call to ExternalCache.getBulk(java.lang.String...). When the supplier is called, callers may not assume that the value returned from the supplier is returned by this method.
• The supplier implementation needs to be multi-thread safe as it may be called concurrently if multiple threads call this method.

Specified by:

get in interface ExternalCache<V>

Parameters:

internalKey - the key uniquely identifying the value to be retrieved

supplier - used to generate the value, if one does not exist already for the key. The supplier may not return null.

Returns:

the value associated with the key.

getIdentified

public CompletionStage<Optional<IdentifiedValue<V>>> getIdentified(String internalKey)

Description copied from interface: DirectExternalCache

Returns an identified value that is associated with a specified key. The IdentifiedValue.identifier() may be used in subsequent CAS operations, such as DirectExternalCache.removeIf(String, CasIdentifier) and DirectExternalCache.replaceIf(String, CasIdentifier, Object).

Specified by:

getIdentified in interface DirectExternalCache<V>

Parameters:

internalKey - the key to check.

Returns:

an Optional which may contain the identified value associated with the key.

getIdentified

public CompletionStage<IdentifiedValue<V>> getIdentified(String internalKey,
                                                         Supplier<V> supplier)

Description copied from interface: DirectExternalCache

Returns an identified value that is associated with a specified key. The IdentifiedValue.identifier() may be used in subsequent CAS operations, such as DirectExternalCache.removeIf(String, CasIdentifier) and DirectExternalCache.replaceIf(String, CasIdentifier, Object).

Specified by:

getIdentified in interface DirectExternalCache<V>

Parameters:

internalKey - the key to check.

supplier - used to generate the value, if one does not exist already for the key. The supplier may not return null.

Returns:

an Optional which may contain the identified value associated with the key.

getBulk

public CompletionStage<Map<String,Optional<V>>> getBulk(Iterable<String> internalKeys)

Description copied from interface: ExternalCache

Returns the values that are associated with the specified keys.

Specified by:

getBulk in interface ExternalCache<V>

Parameters:

internalKeys - the keys to check.

Returns:

A Map that is keyed on the keys specified. Each entry in the Map will have Optional which may contain the value associated with the key.

getBulk

public CompletionStage<Map<String,V>> getBulk(Function<Set<String>,Map<String,V>> factory,
                                              Iterable<String> internalKeys)

Description copied from interface: ExternalCache

Returns the values that are associated with the specified keys.

Notes:

• If no entry for a specified key (or keys) exists, then the specified factory is called. The values may be used to create entries in the cache. However, the values returned may be that of the factory to a concurrent call to this method, or that of the supplier in a concurrent call to ExternalCache.get(String, Supplier). When the factory is called, callers may not assume that the values returned from the factory is returned by this method.

Specified by:

getBulk in interface ExternalCache<V>

Parameters:

factory - used to generate the values for the keys that do not have entries. The factory must return a map containing a non-null entry for each supplied key.

internalKeys - the keys to retrieve

Returns:

A Map that is keyed on the keys specified. Each entry in the Map will have the value associated with the key.

getBulkIdentified

public CompletionStage<Map<String,Optional<IdentifiedValue<V>>>> getBulkIdentified(Iterable<String> internalKeys)

Description copied from interface: DirectExternalCache

Returns the IdentifiedValue's that are associated with the specified keys.

Specified by:

getBulkIdentified in interface DirectExternalCache<V>

Parameters:

internalKeys - the keys to check.

Returns:

A Map that is keyed on the keys specified. Each entry in the Map will have Optional which may contain the IdentifiedValue associated with the key.

put

public CompletionStage<Boolean> put(String internalKey,
                                    V value,
                                    PutPolicy policy)

Description copied from interface: ExternalWriteOperationsUnbuffered

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

Specified by:

put in interface ExternalWriteOperationsUnbuffered<V>

Parameters:

internalKey - the key to put the data under

value - the value to associate with the key.

policy - the policy to apply

Returns:

whether the entry was put into the cache.

removeIf

public CompletionStage<Boolean> removeIf(String internalKey,
                                         CasIdentifier casId)

Description copied from interface: DirectExternalCache

Removes the specified entry, iff the specified CAS identifier matches.

Specified by:

removeIf in interface DirectExternalCache<V>

Parameters:

internalKey - the key of the entry to remove

casId - the CAS identifier to match

Returns:

whether the entry was removed

replaceIf

public CompletionStage<Boolean> replaceIf(String internalKey,
                                          CasIdentifier casId,
                                          V newValue)

Description copied from interface: DirectExternalCache

Replaces the value for a specified entry, iff the specified CAS identifier matches.

Specified by:

replaceIf in interface DirectExternalCache<V>

Parameters:

internalKey - the key of the entry to replace it's value

casId - the CAS identifier to match

newValue - the new value to replace with

Returns:

whether the value was replaced

remove

public CompletionStage<Void> remove(Iterable<String> internalKeys)

Description copied from interface: ExternalWriteOperationsUnbuffered

Remove the entries with the specified keys.

Specified by:

remove in interface ExternalWriteOperationsUnbuffered<V>

Parameters:

internalKeys - the keys of the entries to remove.

Returns:

no indication is given as to whether the entries existed before they were deleted

removeAll

public CompletionStage<Void> removeAll()

Description copied from interface: ExternalWriteOperationsUnbuffered

Remove all entries in the cache.

Specified by:

removeAll in interface ExternalWriteOperationsUnbuffered<V>

Returns:

no indication is given as to whether entries existed before they were deleted

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.

mapException

protected ExternalCacheException mapException(Exception ex)

Description copied from class: AbstractExternalCache

Maps a generic Exception to a corresponding ExternalCacheException.

Specified by:

mapException in class AbstractExternalCache<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.