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:

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

Direct Known Subclasses:

ClusterLoaderConfigurationBuilder, CustomStoreConfigurationBuilder, SingleFileStoreConfigurationBuilder

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

Field Summary

Fields

Modifier and Type	Field and Description
protected AsyncStoreConfigurationBuilder<S>	async
protected AttributeSet	attributes
protected ConfigurationBuilder	builder

Constructor Summary

Constructors

Constructor and Description
AbstractStoreConfigurationBuilder(PersistenceConfigurationBuilder builder, AttributeSet attributes)

Method Summary

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.
AttributeSet	attributes()
Configuration	build()
ClusteringConfigurationBuilder	clustering()
CustomInterceptorsConfigurationBuilder	customInterceptors() Deprecated. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
EncodingConfigurationBuilder	encoding()
ExpirationConfigurationBuilder	expiration()
S	fetchPersistentState(boolean b) If true, fetch persistent state when joining a cluster.
protected ConfigurationBuilder	getBuilder()
Collection<ConfigurationBuilderInfo>	getChildrenInfo()
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()
LockingConfigurationBuilder	locking()
S	maxBatchSize(int maxBatchSize) The maximum size of a batch to be inserted/deleted from the store.
MemoryConfigurationBuilder	memory()
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.
Builder<?>	read(T template) Reads the configuration from an already created configuration bean into this builder.
SecurityConfigurationBuilder	security()
S	segmented(boolean b) If true this store should either be non shared (segmenting can be done automatically for non shared stores) or the shared store must implement the SegmentedAdvancedLoadWriteStore interface.
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.
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
SitesConfigurationBuilder	sites()
StatisticsConfigurationBuilder	statistics()
ConfigurationChildBuilder	template(boolean template)
String	toString()
TransactionConfigurationBuilder	transaction()
S	transactional(boolean b) This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized.
UnsafeConfigurationBuilder	unsafe()
void	validate() Validate the data in this builder before building the configuration bean
protected void	validate(boolean skipClassChecks)
void	validate(GlobalConfiguration globalConfig)
S	withProperties(Properties props) Properties passed to the cache store or loader
S	writeOnly(boolean b) If true, this cache store will be only used to write entries.

Methods inherited from class java.lang.Object

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

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

create

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

build, clustering, customInterceptors, encoding, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, persistence, security, simpleCache, simpleCache, sites, statistics, template, transaction, unsafe

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

self

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

getBuilderInfo, getNewBuilderInfo

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

getElementDefinition

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

persistence

Field Detail

attributes

protected final AttributeSet attributes

async

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

builder

protected final ConfigurationBuilder builder

Constructor Detail

AbstractStoreConfigurationBuilder

public AbstractStoreConfigurationBuilder(PersistenceConfigurationBuilder builder,
                                         AttributeSet attributes)

Method Detail

getChildrenInfo

public Collection<ConfigurationBuilderInfo> getChildrenInfo()

Specified by:

getChildrenInfo in interface ConfigurationBuilderInfo

Returns:

a collection of ConfigurationBuilderInfo for the sub-elements of the builder.

attributes

public AttributeSet attributes()

Specified by:

attributes in interface BaseConfigurationInfo

Returns:

the AttributeSet declared by the configuration.

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>>

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.

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>>

writeOnly

public S writeOnly(boolean b)

Description copied from interface: StoreConfigurationChildBuilder

If true, this cache store will be only used to write entries.

Specified by:

writeOnly 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. If multiple cache stores are chained, only one of them can have this property enabled. 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>>

transactional

public S transactional(boolean b)

This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and the cache's transaction rollingback.

If enabled and this store is shared, then writes to this store will be performed at prepare time of the Infinispan Tx. If an exception is encountered by the store during prepare time, then this will result in the global Tx being rolledback along with this stores writes, otherwise writes to this store will be committed during the commit phase of 2PC. If this is not enabled, then writes to the cache store are performed during the commit phase of a Tx.

Note that this requires StoreConfigurationChildBuilder.shared(boolean) to be set to true.

Specified by:

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

maxBatchSize

public S maxBatchSize(int maxBatchSize)

Description copied from interface: StoreConfigurationChildBuilder

The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

Specified by:

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

segmented

public S segmented(boolean b)

Description copied from interface: StoreConfigurationChildBuilder

If true this store should either be non shared (segmenting can be done automatically for non shared stores) or the shared store must implement the SegmentedAdvancedLoadWriteStore interface. Segmented stores help performance for things that require viewing the entire contents of the store (eg. iteration, stream processing, state transfer, mass indexer). If the store doesn't provide constant time operations for methods such as CacheLoader.loadEntry(Object) or CacheWriter.write(MarshallableEntry) than segmenting this store could also improve performance of those operations.

Specified by:

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

Parameters:

b - whether this store should be segmented

Returns:

this

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>

validate

protected void validate(boolean skipClassChecks)

validate

public void validate(GlobalConfiguration globalConfig)

Specified by:

validate in interface ConfigurationChildBuilder

read

public Builder<?> read(T template)

Description copied from interface: Builder

Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration

Specified by:

read in interface Builder<T extends StoreConfiguration>

Parameters:

template - the configuration from which to "clone" this config if needed.

toString

public String toString()

Overrides:

toString in class Object

template

public ConfigurationChildBuilder template(boolean template)

Specified by:

template in interface ConfigurationChildBuilder

simpleCache

public ConfigurationChildBuilder simpleCache(boolean simpleCache)

Specified by:

simpleCache in interface ConfigurationChildBuilder

simpleCache

public boolean simpleCache()

Specified by:

simpleCache in interface ConfigurationChildBuilder

clustering

public ClusteringConfigurationBuilder clustering()

Specified by:

clustering in interface ConfigurationChildBuilder

customInterceptors

@Deprecated
public CustomInterceptorsConfigurationBuilder customInterceptors()

Deprecated. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors

Specified by:

customInterceptors in interface ConfigurationChildBuilder

encoding

public EncodingConfigurationBuilder encoding()

Specified by:

encoding 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

statistics

public StatisticsConfigurationBuilder statistics()

Specified by:

statistics in interface ConfigurationChildBuilder

persistence

public PersistenceConfigurationBuilder persistence()

Specified by:

persistence in interface ConfigurationChildBuilder

locking

public LockingConfigurationBuilder locking()

Specified by:

locking in interface ConfigurationChildBuilder

security

public SecurityConfigurationBuilder security()

Specified by:

security in interface ConfigurationChildBuilder

transaction

public TransactionConfigurationBuilder transaction()

Specified by:

transaction in interface ConfigurationChildBuilder

unsafe

public UnsafeConfigurationBuilder unsafe()

Specified by:

unsafe in interface ConfigurationChildBuilder

sites

public SitesConfigurationBuilder sites()

Specified by:

sites in interface ConfigurationChildBuilder

memory

public MemoryConfigurationBuilder memory()

Specified by:

memory in interface ConfigurationChildBuilder

getBuilder

protected ConfigurationBuilder getBuilder()

build

public Configuration build()

Specified by:

build in interface ConfigurationChildBuilder