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, 0-9, ./-_$.
• The returned cache instances are multi-thread safe.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
<V> DirectExternalCache<V>	getDirectExternalCache(java.lang.String name, Marshaller<V> valueMarshaller, ExternalCacheSettings settings) Deprecated. since 1.5.0. Use getDirectExternalCache(String, MarshallingPair, ExternalCacheSettings)
<V> DirectExternalCache<V>	getDirectExternalCache(java.lang.String name, com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling, ExternalCacheSettings settings) Obtains a DirectExternalCache with the specified details.
<K,V> JvmCache<K,V>	getJvmCache(java.lang.String name, JvmCacheSettings settings) Obtains a JvmCache with the specified details.
default <K,V> RequestCache<K,V>	getRequestCache(java.lang.String name) Deprecated. Please use getRequestCache(String, RequestCacheSettings) instead.
<K,V> RequestCache<K,V>	getRequestCache(java.lang.String name, RequestCacheSettings settings) Obtains a RequestCache with the specified settings.
<V> StableReadExternalCache<V>	getStableReadExternalCache(java.lang.String name, Marshaller<V> valueMarshaller, ExternalCacheSettings settings) Deprecated. since 1.5.0. Use getStableReadExternalCache(String, MarshallingPair, ExternalCacheSettings)
<V> StableReadExternalCache<V>	getStableReadExternalCache(java.lang.String name, com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling, ExternalCacheSettings settings) Obtains a StableReadExternalCache with the specified details.
<V> TransactionalExternalCache<V>	getTransactionalExternalCache(java.lang.String name, Marshaller<V> valueMarshaller, ExternalCacheSettings settings) Deprecated. since 1.5.0. Use getTransactionalExternalCache(String, MarshallingPair, ExternalCacheSettings)
<V> TransactionalExternalCache<V>	getTransactionalExternalCache(java.lang.String name, com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling, ExternalCacheSettings settings) Obtains a TransactionalExternalCache with the specified details.

Method Detail

getJvmCache

<K,V> JvmCache<K,V> getJvmCache(java.lang.String name,
                                JvmCacheSettings settings)

Obtains a JvmCache with the specified details.

Note: multiple calls to this method will always return the instance created on the first invocation. As such, any changes in the supplied settings will be ignored.

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

@Deprecated
default <K,V> RequestCache<K,V> getRequestCache(java.lang.String name)

Deprecated. Please use getRequestCache(String, RequestCacheSettings) instead.

Obtains a RequestCache with the specified details.

Note: multiple calls to this method will always return the instance created on the first invocation. Simply calls getRequestCache(String, RequestCacheSettings) using the default settings.

Type Parameters:

K - the key type

V - the value type

Parameters:

name - the name of the cache

Returns:

RequestCache with the specified details

getRequestCache

<K,V> RequestCache<K,V> getRequestCache(java.lang.String name,
                                        RequestCacheSettings settings)

Obtains a RequestCache with the specified settings.

Type Parameters:

K - the key type.

V - the value type.

Parameters:

name - the name of the cache.

settings - the settings for this cache.

Returns:

RequestCache with the specified configuration.

getTransactionalExternalCache

@Deprecated
<V> TransactionalExternalCache<V> getTransactionalExternalCache(java.lang.String name,
                                                                            Marshaller<V> valueMarshaller,
                                                                            ExternalCacheSettings settings)

Deprecated. since 1.5.0. Use getTransactionalExternalCache(String, MarshallingPair, ExternalCacheSettings)

Obtains a TransactionalExternalCache with the specified details.

Note: each call to this method will return a new instance using the specified settings. However, the existing data stored in the external cache will remain. It is not expected in a production configuration that this method will be called multiple times, but is allowed is a development configuration.

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

getTransactionalExternalCache

<V> TransactionalExternalCache<V> getTransactionalExternalCache(java.lang.String name,
                                                                com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling,
                                                                ExternalCacheSettings settings)

Obtains a TransactionalExternalCache with the specified details.

Note: each call to this method will return a new instance using the specified settings. However, the existing data stored in the external cache will remain. It is not expected in a production configuration that this method will be called multiple times, but is allowed is a development configuration.

Type Parameters:

V - the value type

Parameters:

name - the name of the cache

valueMarshalling - the marshaller for the values.

settings - the settings for the cache

Returns:

TransactionalExternalCache with the specified details

getStableReadExternalCache

@Deprecated
<V> StableReadExternalCache<V> getStableReadExternalCache(java.lang.String name,
                                                                      Marshaller<V> valueMarshaller,
                                                                      ExternalCacheSettings settings)

Deprecated. since 1.5.0. Use getStableReadExternalCache(String, MarshallingPair, ExternalCacheSettings)

Obtains a StableReadExternalCache with the specified details.

Note: each call to this method will return a new instance using the specified settings. However, the existing data stored in the external cache will remain. It is not expected in a production configuration that this method will be called multiple times, but is allowed is a development configuration.

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

getStableReadExternalCache

<V> StableReadExternalCache<V> getStableReadExternalCache(java.lang.String name,
                                                          com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling,
                                                          ExternalCacheSettings settings)

Obtains a StableReadExternalCache with the specified details.

Note: each call to this method will return a new instance using the specified settings. However, the existing data stored in the external cache will remain. It is not expected in a production configuration that this method will be called multiple times, but is allowed is a development configuration.

Type Parameters:

V - the value type

Parameters:

name - the name of the cache

valueMarshalling - the marshalling pair for the values.

settings - the settings for the cache

Returns:

StableReadExternalCache with the specified details

getDirectExternalCache

@Deprecated
<V> DirectExternalCache<V> getDirectExternalCache(java.lang.String name,
                                                              Marshaller<V> valueMarshaller,
                                                              ExternalCacheSettings settings)

Deprecated. since 1.5.0. Use getDirectExternalCache(String, MarshallingPair, ExternalCacheSettings)

Obtains a DirectExternalCache with the specified details.

Note: each call to this method will return a new instance using the specified settings. However, the existing data stored in the external cache will remain. It is not expected in a production configuration that this method will be called multiple times, but is allowed is a development configuration.

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

getDirectExternalCache

<V> DirectExternalCache<V> getDirectExternalCache(java.lang.String name,
                                                  com.atlassian.marshalling.api.MarshallingPair<V> valueMarshalling,
                                                  ExternalCacheSettings settings)

Obtains a DirectExternalCache with the specified details.

Note: each call to this method will return a new instance using the specified settings. However, the existing data stored in the external cache will remain. It is not expected in a production configuration that this method will be called multiple times, but is allowed is a development configuration.

Type Parameters:

V - the value type

Parameters:

name - the name of the cache

valueMarshalling - the marshalling pair to be used for marshalling.

settings - the settings for the cache

Returns:

DirectExternalCache with the specified details