org.infinispan.configuration.cache

Class AbstractStoreConfiguration

java.lang.Object

org.infinispan.configuration.cache.AbstractStoreConfiguration

All Implemented Interfaces:

BaseConfigurationInfo, ConfigurationInfo, StoreConfiguration

Direct Known Subclasses:

AbstractJdbcStoreConfiguration, AbstractSegmentedStoreConfiguration, ClusterLoaderConfiguration, CustomStoreConfiguration, JpaStoreConfiguration, RemoteStoreConfiguration, RestStoreConfiguration, RocksDBStoreConfiguration

public class AbstractStoreConfiguration
extends java.lang.Object
implements StoreConfiguration, ConfigurationInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected AttributeSet	attributes
static AttributeDefinition<java.lang.Boolean>	FETCH_PERSISTENT_STATE
static AttributeDefinition<java.lang.Boolean>	IGNORE_MODIFICATIONS
static AttributeDefinition<java.lang.Integer>	MAX_BATCH_SIZE
static AttributeDefinition<java.lang.Boolean>	PRELOAD
static AttributeDefinition<TypedProperties>	PROPERTIES
static AttributeDefinition<java.lang.Boolean>	PURGE_ON_STARTUP
static AttributeDefinition<java.lang.Boolean>	SEGMENTED
static AttributeDefinition<java.lang.Boolean>	SHARED
static AttributeDefinition<java.lang.Boolean>	TRANSACTIONAL

Constructor Summary

Constructors

Constructor and Description
AbstractStoreConfiguration(AttributeSet attributes, AsyncStoreConfiguration async, SingletonStoreConfiguration singletonStore)
AbstractStoreConfiguration(boolean purgeOnStartup, boolean fetchPersistentState, boolean ignoreModifications, AsyncStoreConfiguration async, SingletonStoreConfiguration singletonStore, boolean preload, boolean shared, java.util.Properties properties) Deprecated. Use {@link AbstractStoreConfiguration#AbstractStoreConfiguration(AttributeSet, AsyncStoreConfiguration, SingletonStoreConfiguration) instead

Method Summary

Modifier and Type	Method and Description
AsyncStoreConfiguration	async() Configuration for the async cache loader.
static AttributeSet	attributeDefinitionSet()
AttributeSet	attributes()
boolean	equals(java.lang.Object obj)
boolean	fetchPersistentState() If true, fetch persistent state when joining a cluster.
int	hashCode()
boolean	ignoreModifications() If true, any operation that modifies the cache (put, remove, clear, store...etc) won't be applied to the cache store.
int	maxBatchSize()
boolean	preload()
java.util.Properties	properties()
boolean	purgeOnStartup() If true, purges this cache store when it starts up.
boolean	segmented() Whether or not this store is configured to be segmented.
boolean	shared()
SingletonStoreConfiguration	singletonStore() SingletonStore is a delegating store used for situations when only one instance in a cluster should interact with the underlying store.
java.util.List<ConfigurationInfo>	subElements()
java.lang.String	toString()
boolean	transactional()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.infinispan.commons.configuration.BaseConfigurationInfo

getElementDefinition

Field Detail

FETCH_PERSISTENT_STATE

public static final AttributeDefinition<java.lang.Boolean> FETCH_PERSISTENT_STATE

PURGE_ON_STARTUP

public static final AttributeDefinition<java.lang.Boolean> PURGE_ON_STARTUP

IGNORE_MODIFICATIONS

public static final AttributeDefinition<java.lang.Boolean> IGNORE_MODIFICATIONS

PRELOAD

public static final AttributeDefinition<java.lang.Boolean> PRELOAD

SHARED

public static final AttributeDefinition<java.lang.Boolean> SHARED

TRANSACTIONAL

public static final AttributeDefinition<java.lang.Boolean> TRANSACTIONAL

MAX_BATCH_SIZE

public static final AttributeDefinition<java.lang.Integer> MAX_BATCH_SIZE

SEGMENTED

public static final AttributeDefinition<java.lang.Boolean> SEGMENTED

PROPERTIES

public static final AttributeDefinition<TypedProperties> PROPERTIES

attributes

protected final AttributeSet attributes

Constructor Detail

AbstractStoreConfiguration

@Deprecated
public AbstractStoreConfiguration(boolean purgeOnStartup,
                                              boolean fetchPersistentState,
                                              boolean ignoreModifications,
                                              AsyncStoreConfiguration async,
                                              SingletonStoreConfiguration singletonStore,
                                              boolean preload,
                                              boolean shared,
                                              java.util.Properties properties)

Deprecated. Use {@link AbstractStoreConfiguration#AbstractStoreConfiguration(AttributeSet, AsyncStoreConfiguration, SingletonStoreConfiguration) instead

AbstractStoreConfiguration

public AbstractStoreConfiguration(AttributeSet attributes,
                                  AsyncStoreConfiguration async,
                                  SingletonStoreConfiguration singletonStore)

Method Detail

attributeDefinitionSet

public static AttributeSet attributeDefinitionSet()

subElements

public java.util.List<ConfigurationInfo> subElements()

Specified by:

subElements in interface ConfigurationInfo

Returns:

the list of sub elements.

async

public AsyncStoreConfiguration async()

Configuration for the async cache loader. If enabled, this provides you with asynchronous writes to the cache store, giving you 'write-behind' caching.

Specified by:

async in interface StoreConfiguration

singletonStore

public SingletonStoreConfiguration singletonStore()

SingletonStore is a delegating store used for situations when only one instance in a cluster should interact with the underlying store. The coordinator of the cluster will be responsible for the underlying CacheStore. SingletonStore is a simply facade to a real CacheStore implementation. It always delegates reads to the real CacheStore.

Specified by:

singletonStore in interface StoreConfiguration

purgeOnStartup

public boolean purgeOnStartup()

If true, purges this cache store when it starts up.

Specified by:

purgeOnStartup in interface StoreConfiguration

shared

public boolean shared()

Specified by:

shared in interface StoreConfiguration

transactional

public boolean transactional()

Specified by:

transactional in interface StoreConfiguration

maxBatchSize

public int maxBatchSize()

Specified by:

maxBatchSize in interface StoreConfiguration

segmented

public boolean segmented()

Description copied from interface: StoreConfiguration

Whether or not this store is configured to be segmented. For a non shared store this means there will be a separate instance of each store for each segment. For shared stores normally this means the store is able to do some optimizations based on the segment (ie. select * from table where segment = $1)

Specified by:

segmented in interface StoreConfiguration

Returns:

whether this store is configured to be segmented

fetchPersistentState

public boolean fetchPersistentState()

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled. Persistent state transfer with a shared cache store does not make sense, as the same persistent store that provides the data will just end up receiving it. Therefore, if a shared cache store is used, the cache will not allow a persistent state transfer even if a cache store has this property set to true.

Specified by:

fetchPersistentState in interface StoreConfiguration

ignoreModifications

public boolean ignoreModifications()

If true, any operation that modifies the cache (put, remove, clear, store...etc) won't be applied to the cache store. This means that the cache store could become out of sync with the cache.

Specified by:

ignoreModifications in interface StoreConfiguration

preload

public boolean preload()

Specified by:

preload in interface StoreConfiguration

properties

public java.util.Properties properties()

Specified by:

properties in interface StoreConfiguration

attributes

public AttributeSet attributes()

Specified by:

attributes in interface BaseConfigurationInfo

Returns:

the AttributeSet declared by the configuration.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object