javax.cache.configuration

Class Configuration<K,V>

java.lang.Object

javax.cache.configuration.Configuration<K,V>

Type Parameters:

K - the type of keys maintained the cache

V - the type of cached values

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MutableConfiguration

public abstract class Configuration<K,V>
extends Object
implements Serializable

A read-only representation of a Cache configuration.

The properties provided by instances of this interface are used by CacheManagers to configure Caches.

Implementations of this interface must override Object.hashCode() and Object.equals(Object) as Configurations are often compared at runtime.

Since:

1.0

Author:

Greg Luck, Yannis Cosmadopoulos, Brian Oliver

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Configuration()

Method Summary

Methods

Modifier and Type	Method and Description
abstract List<CacheEntryListenerConfiguration<K,V>>	getCacheEntryListenerConfigurations() Obtains the CacheEntryListenerConfigurations for CacheEntryListeners to be configured on a Cache.
abstract Factory<CacheLoader<K,V>>	getCacheLoaderFactory() Gets the Factory for the CacheLoader, if any.
abstract Factory<CacheWriter<? super K,? super V>>	getCacheWriterFactory() Gets the Factory for the CacheWriter, if any.
abstract Factory<ExpiryPolicy<? super K>>	getExpiryPolicyFactory() Gets the Factory for the ExpiryPolicy to be used for caches.
abstract Class<K>	getKeyType() Determines the required type of keys for Caches configured with this Configuration.
abstract IsolationLevel	getTransactionIsolationLevel() Gets the transaction isolation level.
abstract Mode	getTransactionMode() Gets the transaction mode.
abstract Class<V>	getValueType() Determines the required type of values for Caches configured with this Configuration.
abstract boolean	isManagementEnabled() Checks whether management is enabled on this cache.
abstract boolean	isReadThrough() Determines if a Cache should operate in read-through mode.
abstract boolean	isStatisticsEnabled() Checks whether statistics collection is enabled in this cache.
abstract boolean	isStoreByValue() Whether storeByValue (true) or storeByReference (false).
abstract boolean	isTransactionsEnabled() Checks whether transactions are enabled for this cache.
abstract boolean	isWriteThrough() Determines if a Cache should operate in write-through mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration()

Method Detail

getKeyType

public abstract Class<K> getKeyType()

Determines the required type of keys for Caches configured with this Configuration.

Returns:

the key type or Object.class if the type is undefined

getValueType

public abstract Class<V> getValueType()

Determines the required type of values for Caches configured with this Configuration.

Returns:

the value type or Object.class if the type is undefined

isReadThrough

public abstract boolean isReadThrough()

Determines if a Cache should operate in read-through mode.

When in "read-through" mode, cache misses that occur due to cache entries not existing as a result of performing a "get" will appropriately cause the configured CacheLoader to be invoked.

The default value is false.

Returns:

true when a Cache is in "read-through" mode.

See Also:

getCacheLoaderFactory()

isWriteThrough

public abstract boolean isWriteThrough()

Determines if a Cache should operate in write-through mode.

When in "write-through" mode, cache updates that occur as a result of performing "put" operations called via one of Cache.put(Object, Object), Cache.getAndRemove(Object), Cache.removeAll(), Cache.getAndPut(Object, Object) Cache.getAndRemove(Object), Cache.getAndReplace(Object, Object), Cache.invoke(Object, javax.cache.processor.EntryProcessor, Object...), Cache.invokeAll(java.util.Set, javax.cache.processor.EntryProcessor, Object...) will appropriately cause the configured CacheWriter to be invoked.

The default value is false.

Returns:

true when a Cache is in "write-through" mode.

See Also:

getCacheWriterFactory()

isStoreByValue

public abstract boolean isStoreByValue()

Whether storeByValue (true) or storeByReference (false). When true, both keys and values are stored by value.

When false, both keys and values are stored by reference. Caches stored by reference are capable of mutation by any threads holding the reference. The effects are:

• if the key is mutated, then the key may not be retrievable or removable
• if the value is mutated, then all threads in the JVM can potentially observe those mutations, subject to the normal Java Memory Model rules.

Storage by reference only applies to the local heap. If an entry is moved off heap it will need to be transformed into a representation. Any mutations that occur after transformation may not be reflected in the cache.

Additionally Store-By-Reference is only supported for non-transactional caches. Attempts to configure a cache using both transactions and Store-By-Reference will result in an in a CacheException.

When a cache is storeByValue, any mutation to the key or value does not affect the key of value stored in the cache.

The default value is true.

Returns:

true if the cache is store by value

isStatisticsEnabled

public abstract boolean isStatisticsEnabled()

Checks whether statistics collection is enabled in this cache.

The default value is false.

Returns:

true if statistics collection is enabled

isManagementEnabled

public abstract boolean isManagementEnabled()

Checks whether management is enabled on this cache.

The default value is false.

Returns:

true if management is enabled

isTransactionsEnabled

public abstract boolean isTransactionsEnabled()

Checks whether transactions are enabled for this cache.

Note that in a transactional cache, entries being mutated within a transaction cannot be expired by the cache.

The default value is false.

Returns:

true if transaction are enabled

getTransactionIsolationLevel

public abstract IsolationLevel getTransactionIsolationLevel()

Gets the transaction isolation level.

The default value is IsolationLevel.NONE.

Returns:

the isolation level.

getTransactionMode

public abstract Mode getTransactionMode()

Gets the transaction mode.

The default value is Mode.NONE.

Returns:

the mode of the cache.

getCacheEntryListenerConfigurations

public abstract List<CacheEntryListenerConfiguration<K,V>> getCacheEntryListenerConfigurations()

Obtains the CacheEntryListenerConfigurations for CacheEntryListeners to be configured on a Cache.

Returns:

an Iterable over the CacheEntryListenerConfigurations

getCacheLoaderFactory

public abstract Factory<CacheLoader<K,V>> getCacheLoaderFactory()

Gets the Factory for the CacheLoader, if any.

A CacheLoader should be configured for "Read Through" caches to load values when a cache miss occurs using either the Cache.get(Object) and/or Cache.getAll(java.util.Set) methods.

The default value is null.

Returns:

the Factory for the CacheLoader or null if none has been set.

getCacheWriterFactory

public abstract Factory<CacheWriter<? super K,? super V>> getCacheWriterFactory()

Gets the Factory for the CacheWriter, if any.

The default value is null.

Returns:

the Factory for the CacheWriter or null if none has been set.

getExpiryPolicyFactory

public abstract Factory<ExpiryPolicy<? super K>> getExpiryPolicyFactory()

Gets the Factory for the ExpiryPolicy to be used for caches.

The default value is a Factory that will produce a EternalExpiryPolicy instance.

Returns:

the Factory for ExpiryPolicy (must not be null)