com.atlassian.vcache

Interface VCacheFactory

@PublicApi
public interface VCacheFactory

Represents the factory for creating caches.

Notes:

• JvmCache's and RequestCache's are identified by their name and cache type. I.e. A JvmCache called 'Williams' and a RequestCache called 'Williams' are considered to be separate caches.
• ExternalCache's are identified by their name and cache type.
• A cache name may only contain the characters A-Z, a-z, ./-_$.
• The returned cache instances are multi-thread safe.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
<V> DirectExternalCache<V>	getDirectExternalCache(String name, Marshaller<V> valueMarshaller, ExternalCacheSettings settings) Obtains a DirectExternalCache with the specified details.
<K,V> JvmCache<K,V>	getJvmCache(String name, JvmCacheSettings settings) Obtains a JvmCache with the specified details.
<K,V> RequestCache<K,V>	getRequestCache(String name) Obtains a RequestCache with the specified details.
<V> StableReadExternalCache<V>	getStableReadExternalCache(String name, Marshaller<V> valueMarshaller, ExternalCacheSettings settings) Obtains a StableReadExternalCache with the specified details.
<V> TransactionalExternalCache<V>	getTransactionalExternalCache(String name, Marshaller<V> valueMarshaller, ExternalCacheSettings settings) Obtains a TransactionalExternalCache with the specified details.

Method Detail

getJvmCache

@Nonnull
<K,V> JvmCache<K,V> getJvmCache(String name,
                                         JvmCacheSettings settings)

Obtains a JvmCache with the specified details.

Type Parameters:

K - the key type

V - the value type

Parameters:

name - the name of the cache

settings - the settings for the cache

Returns:

JvmCache with the specified details

getRequestCache

@Nonnull
<K,V> RequestCache<K,V> getRequestCache(String name)

Obtains a RequestCache with the specified details.

Type Parameters:

K - the key type

V - the value type

Parameters:

name - the name of the cache

Returns:

RequestCache with the specified details

getTransactionalExternalCache

@Nonnull
<V> TransactionalExternalCache<V> getTransactionalExternalCache(String name,
                                                                         Marshaller<V> valueMarshaller,
                                                                         ExternalCacheSettings settings)

Obtains a TransactionalExternalCache with the specified details.

Type Parameters:

V - the value type

Parameters:

name - the name of the cache

valueMarshaller - the marshaller for the values. See MarshallerFactory for provided implementations.

settings - the settings for the cache

Returns:

TransactionalExternalCache with the specified details

getStableReadExternalCache

@Nonnull
<V> StableReadExternalCache<V> getStableReadExternalCache(String name,
                                                                   Marshaller<V> valueMarshaller,
                                                                   ExternalCacheSettings settings)

Obtains a StableReadExternalCache with the specified details.

Type Parameters:

V - the value type

Parameters:

name - the name of the cache

valueMarshaller - the marshaller for the values. See MarshallerFactory for provided implementations.

settings - the settings for the cache

Returns:

StableReadExternalCache with the specified details

getDirectExternalCache

@Nonnull
<V> DirectExternalCache<V> getDirectExternalCache(String name,
                                                           Marshaller<V> valueMarshaller,
                                                           ExternalCacheSettings settings)

Obtains a DirectExternalCache with the specified details.

Type Parameters:

V - the value type

Parameters:

name - the name of the cache

valueMarshaller - the marshaller for the values. See MarshallerFactory for provided implementations.

settings - the settings for the cache

Returns:

DirectExternalCache with the specified details