org.infinispan.configuration.cache

Class AbstractStoreConfigurationBuilder<T extends StoreConfiguration,S extends AbstractStoreConfigurationBuilder<T,S>>

java.lang.Object

org.infinispan.configuration.cache.AbstractPersistenceConfigurationChildBuilder

org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<T,S>

All Implemented Interfaces:

Builder<T>, Self<S>, ConfigurationChildBuilder, PersistenceConfigurationChildBuilder, StoreConfigurationBuilder<T,S>, StoreConfigurationChildBuilder<S>

Direct Known Subclasses:

AbstractJdbcStoreConfigurationBuilder, Adaptor52xStoreConfigurationBuilder, CLInterfaceLoaderConfigurationBuilder, ClusterLoaderConfigurationBuilder, JCacheWriterAdapterConfigurationBuilder, JStoreAdapterConfigurationBuilder, LevelDBStoreConfigurationBuilder, LuceneLoaderConfigurationBuilder, RemoteEventStoreConfigurationBuilder, RemoteStoreConfigurationBuilder, RestStoreConfigurationBuilder, SingleFileStoreConfigurationBuilder

public abstract class AbstractStoreConfigurationBuilder<T extends StoreConfiguration,S extends AbstractStoreConfigurationBuilder<T,S>>
extends AbstractPersistenceConfigurationChildBuilder
implements StoreConfigurationBuilder<T,S>

Field Summary

Fields

Modifier and Type	Field and Description
protected AsyncStoreConfigurationBuilder<S>	async
protected boolean	fetchPersistentState
protected boolean	ignoreModifications
protected boolean	preload
protected Properties	properties
protected boolean	purgeOnStartup
protected boolean	shared
protected SingletonStoreConfigurationBuilder<S>	singletonStore

Constructor Summary

Constructors

Constructor and Description
AbstractStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)

Method Summary

Methods

Modifier and Type	Method and Description
S	addProperty(String key, String value) Defines a single property.
AsyncStoreConfigurationBuilder<S>	async() Configuration for the async cache store.
Configuration	build()
ClusteringConfigurationBuilder	clustering()
CompatibilityModeConfigurationBuilder	compatibility()
CustomInterceptorsConfigurationBuilder	customInterceptors()
DataContainerConfigurationBuilder	dataContainer()
DeadlockDetectionConfigurationBuilder	deadlockDetection()
EvictionConfigurationBuilder	eviction()
ExpirationConfigurationBuilder	expiration()
S	fetchPersistentState(boolean b) If true, fetch persistent state when joining a cluster.
protected ConfigurationBuilder	getBuilder()
S	ignoreModifications(boolean b) If true, any operation that modifies the cache (put, remove, clear, store...etc) won't be applied to the cache store.
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
JMXStatisticsConfigurationBuilder	jmxStatistics()
LockingConfigurationBuilder	locking()
PersistenceConfigurationBuilder	persistence()
S	preload(boolean b) If true, when the cache starts, data stored in the cache store will be pre-loaded into memory.
S	properties(Properties properties)
S	purgeOnStartup(boolean b) If true, purges this cache store when it starts up.
S	shared(boolean b) This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times.
SingletonStoreConfigurationBuilder<S>	singleton() SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.
SitesConfigurationBuilder	sites()
StoreAsBinaryConfigurationBuilder	storeAsBinary()
TransactionConfigurationBuilder	transaction()
UnsafeConfigurationBuilder	unsafe()
void	validate() Validate the data in this builder before building the configuration bean
VersioningConfigurationBuilder	versioning()
S	withProperties(Properties props) Properties passed to the cache store or loader

Methods inherited from class java.lang.Object

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

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

create, read

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder

build, clustering, compatibility, customInterceptors, dataContainer, deadlockDetection, eviction, expiration, indexing, invocationBatching, jmxStatistics, locking, persistence, sites, storeAsBinary, transaction, unsafe, versioning

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

self

Methods inherited from interface org.infinispan.configuration.cache.PersistenceConfigurationChildBuilder

persistence

Field Detail

async

protected final AsyncStoreConfigurationBuilder<S extends AbstractStoreConfigurationBuilder<T,S>> async

singletonStore

protected final SingletonStoreConfigurationBuilder<S extends AbstractStoreConfigurationBuilder<T,S>> singletonStore

fetchPersistentState

protected boolean fetchPersistentState

ignoreModifications

protected boolean ignoreModifications

purgeOnStartup

protected boolean purgeOnStartup

shared

protected boolean shared

preload

protected boolean preload

properties

protected Properties properties

Constructor Detail

AbstractStoreConfigurationBuilder

public AbstractStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)

Method Detail

async

public AsyncStoreConfigurationBuilder<S> async()

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

Specified by:

async in interface StoreConfigurationChildBuilder<S extends AbstractStoreConfigurationBuilder<T,S>>

singleton

public SingletonStoreConfigurationBuilder<S> singleton()

SingletonStore is a delegating cache 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:

singleton in interface StoreConfigurationChildBuilder<S extends AbstractStoreConfigurationBuilder<T,S>>

fetchPersistentState

public S fetchPersistentState(boolean b)

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. Finally, setting it to true only makes sense if in a clustered environment, and only 'replication' and 'invalidation' cluster modes are supported.

Specified by:

fetchPersistentState in interface StoreConfigurationChildBuilder<S extends AbstractStoreConfigurationBuilder<T,S>>

ignoreModifications

public S ignoreModifications(boolean b)

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 StoreConfigurationChildBuilder<S extends AbstractStoreConfigurationBuilder<T,S>>

purgeOnStartup

public S purgeOnStartup(boolean b)

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

Specified by:

purgeOnStartup in interface StoreConfigurationChildBuilder<S extends AbstractStoreConfigurationBuilder<T,S>>

properties

public S properties(Properties properties)

addProperty

public S addProperty(String key,
            String value)

Defines a single property. Can be used multiple times to define all needed properties, but the full set is overridden by StoreConfigurationChildBuilder.withProperties(java.util.Properties).

These properties are passed directly to the cache store.

Specified by:

addProperty in interface StoreConfigurationChildBuilder<S extends AbstractStoreConfigurationBuilder<T,S>>

withProperties

public S withProperties(Properties props)

Properties passed to the cache store or loader

Specified by:

withProperties in interface StoreConfigurationChildBuilder<S extends AbstractStoreConfigurationBuilder<T,S>>

preload

public S preload(boolean b)

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

Specified by:

preload in interface StoreConfigurationChildBuilder<S extends AbstractStoreConfigurationBuilder<T,S>>

shared

public S shared(boolean b)

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store.

If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store. Note that this could be useful if each individual node has its own cache store - perhaps local on-disk.

Specified by:

shared in interface StoreConfigurationChildBuilder<S extends AbstractStoreConfigurationBuilder<T,S>>

validate

public void validate()

Description copied from interface: Builder

Validate the data in this builder before building the configuration bean

Specified by:

validate in interface Builder<T extends StoreConfiguration>

clustering

public ClusteringConfigurationBuilder clustering()

Specified by:

clustering in interface ConfigurationChildBuilder

customInterceptors

public CustomInterceptorsConfigurationBuilder customInterceptors()

Specified by:

customInterceptors in interface ConfigurationChildBuilder

dataContainer

public DataContainerConfigurationBuilder dataContainer()

Specified by:

dataContainer in interface ConfigurationChildBuilder

deadlockDetection

public DeadlockDetectionConfigurationBuilder deadlockDetection()

Specified by:

deadlockDetection in interface ConfigurationChildBuilder

eviction

public EvictionConfigurationBuilder eviction()

Specified by:

eviction in interface ConfigurationChildBuilder

expiration

public ExpirationConfigurationBuilder expiration()

Specified by:

expiration in interface ConfigurationChildBuilder

indexing

public IndexingConfigurationBuilder indexing()

Specified by:

indexing in interface ConfigurationChildBuilder

invocationBatching

public InvocationBatchingConfigurationBuilder invocationBatching()

Specified by:

invocationBatching in interface ConfigurationChildBuilder

jmxStatistics

public JMXStatisticsConfigurationBuilder jmxStatistics()

Specified by:

jmxStatistics in interface ConfigurationChildBuilder

persistence

public PersistenceConfigurationBuilder persistence()

Specified by:

persistence in interface ConfigurationChildBuilder

locking

public LockingConfigurationBuilder locking()

Specified by:

locking in interface ConfigurationChildBuilder

storeAsBinary

public StoreAsBinaryConfigurationBuilder storeAsBinary()

Specified by:

storeAsBinary in interface ConfigurationChildBuilder

transaction

public TransactionConfigurationBuilder transaction()

Specified by:

transaction in interface ConfigurationChildBuilder

versioning

public VersioningConfigurationBuilder versioning()

Specified by:

versioning in interface ConfigurationChildBuilder

unsafe

public UnsafeConfigurationBuilder unsafe()

Specified by:

unsafe in interface ConfigurationChildBuilder

sites

public SitesConfigurationBuilder sites()

Specified by:

sites in interface ConfigurationChildBuilder

compatibility

public CompatibilityModeConfigurationBuilder compatibility()

Specified by:

compatibility in interface ConfigurationChildBuilder

getBuilder

protected ConfigurationBuilder getBuilder()

build

public Configuration build()

Specified by:

build in interface ConfigurationChildBuilder