org.infinispan.config
Class CacheLoaderManagerConfig

java.lang.Object
  org.infinispan.config.AbstractConfigurationBean
      org.infinispan.config.AbstractNamedCacheConfigurationBean
          org.infinispan.config.CacheLoaderManagerConfig

All Implemented Interfaces:

Serializable, Cloneable, CloneableConfigurationComponent, FluentConfiguration.LoadersConfig, JAXBUnmarshallable

public class CacheLoaderManagerConfig
extends AbstractNamedCacheConfigurationBean
implements FluentConfiguration.LoadersConfig

Holds the configuration of the cache loader chain. All cache loaders should be defined using this class, adding individual cache loaders to the chain by calling addCacheLoaderConfig(org.infinispan.loaders.CacheLoaderConfig)

Since:

4.0

Author:

Manik Surtani (manik@jboss.org), Brian Stansberry, Vladimir Blagojevic, Galder Zamarreno

See Also:

Configuration reference, Serialized Form

Field Summary

protected List<CacheLoaderConfig>	cacheLoaderConfigs
protected Boolean	passivation
protected Boolean	preload
protected Boolean	shared

Fields inherited from class org.infinispan.config.AbstractNamedCacheConfigurationBean

cr

Fields inherited from class org.infinispan.config.AbstractConfigurationBean

overriddenConfigurationElements

Constructor Summary

CacheLoaderManagerConfig()

CacheLoaderManagerConfig(CacheLoaderConfig clc)

Method Summary

void	accept(ConfigurationBeanVisitor v)
FluentConfiguration.LoadersConfig	addCacheLoader(CacheLoaderConfig... configs)
FluentConfiguration.LoadersConfig	addCacheLoaderConfig(CacheLoaderConfig clc) Deprecated. use addCacheLoader(org.infinispan.loaders.CacheLoaderConfig...) instead
FluentConfiguration.AsyncConfig	async() Deprecated.
Configuration	build() Deprecated.
Configuration	build() Deprecated.
FluentConfiguration.TransactionConfig	cacheStopTimeout(Integer cacheStopTimeout) Deprecated.
CacheLoaderManagerConfig	clone()
FluentConfiguration.ClusteringConfig	clustering() Deprecated.
FluentConfiguration.ClusteringConfig	clustering() Deprecated.
FluentConfiguration.CustomInterceptorsConfig	customInterceptors() Deprecated.
FluentConfiguration.CustomInterceptorsConfig	customInterceptors() Deprecated.
FluentConfiguration.DataContainerConfig	dataContainer() Deprecated.
FluentConfiguration.DataContainerConfig	dataContainer() Deprecated.
FluentConfiguration.DeadlockDetectionConfig	deadlockDetection() Deprecated. This method allows configuration of the deadlock detection.
FluentConfiguration.DeadlockDetectionConfig	deadlockDetection() Deprecated. This method allows configuration of the deadlock detection.
FluentConfiguration.TransactionConfig	eagerLockSingleNode(Boolean eagerLockSingleNode) Deprecated.
boolean	equals(Object obj)
FluentConfiguration.EvictionConfig	eviction() Deprecated.
FluentConfiguration.EvictionConfig	eviction() Deprecated.
FluentConfiguration.ExpirationConfig	expiration() Deprecated.
FluentConfiguration.ExpirationConfig	expiration() Deprecated.
List<CacheLoaderConfig>	getCacheLoaderConfigs()
CacheLoaderConfig	getFirstCacheLoaderConfig()
FluentConfiguration.HashConfig	hash() Deprecated.
int	hashCode()
FluentConfiguration.IndexingConfig	indexing() Deprecated. This method allows configuration of the indexing subsystem.
FluentConfiguration.IndexingConfig	indexing() Deprecated. This method allows configuration of the indexing subsystem.
FluentConfiguration.InvocationBatchingConfig	invocationBatching() Deprecated. This method allows configuration of invocation batching.
FluentConfiguration.InvocationBatchingConfig	invocationBatching() Deprecated. This method allows configuration of invocation batching.
Boolean	isFetchPersistentState() Loops through all individual cache loader configs and checks if fetchPersistentState is set on any of them
Boolean	isPassivation()
Boolean	isPreload()
Boolean	isShared()
FluentConfiguration.JmxStatisticsConfig	jmxStatistics() Deprecated. This method allows configuration of jmx statistics.
FluentConfiguration.JmxStatisticsConfig	jmxStatistics() Deprecated. This method allows configuration of jmx statistics.
FluentConfiguration.L1Config	l1() Deprecated.
FluentConfiguration.LoadersConfig	loaders() Deprecated.
FluentConfiguration.LoadersConfig	loaders() Deprecated.
FluentConfiguration.LockingConfig	locking() Deprecated.
FluentConfiguration.LockingConfig	locking() Deprecated.
FluentConfiguration.ClusteringConfig	mode(Configuration.CacheMode mode) Deprecated.
FluentConfiguration.LoadersConfig	passivation(Boolean passivation) If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'.
FluentConfiguration.LoadersConfig	preload(Boolean preload) If true, when the cache starts, data stored in the cache store will be pre-loaded into memory.
FluentConfiguration.RecoveryConfig	recovery() Deprecated.
FluentConfiguration.LoadersConfig	setCacheLoaderConfigs(List<CacheLoaderConfig> configs) Deprecated. The visibility of this method will be reduced and XMLElement definition is likely to move to the getCacheLoaderConfigs().
protected CacheLoaderManagerConfig	setConfiguration(Configuration config)
void	setPassivation(Boolean passivation) Deprecated. The visibility of this method will be reduced. Use passivation(Boolean) instead.
void	setPreload(Boolean preload) Deprecated. The visibility of this method will be reduced. Use preload(Boolean) instead.
void	setShared(Boolean shared) Deprecated. The visibility of this method will be reduced. Use shared(Boolean) instead.
FluentConfiguration.LoadersConfig	shared(Boolean shared) 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.
FluentConfiguration.StateRetrievalConfig	stateRetrieval() Deprecated.
FluentConfiguration.StoreAsBinaryConfig	storeAsBinary() Deprecated. This method allows configuration of lazy deserialization.
FluentConfiguration.StoreAsBinaryConfig	storeAsBinary() Deprecated. This method allows configuration of lazy deserialization.
FluentConfiguration.SyncConfig	sync() Deprecated.
FluentConfiguration.TransactionConfig	syncCommitPhase(Boolean syncCommitPhase) Deprecated.
FluentConfiguration.TransactionConfig	syncRollbackPhase(Boolean syncRollbackPhase) Deprecated.
String	toString()
FluentConfiguration.TransactionConfig	transaction() Deprecated.
FluentConfiguration.TransactionConfig	transaction() Deprecated.
FluentConfiguration.TransactionConfig	transactionManagerLookup(TransactionManagerLookup transactionManagerLookup) Deprecated.
FluentConfiguration.TransactionConfig	transactionManagerLookupClass(Class<? extends TransactionManagerLookup> transactionManagerLookupClass) Deprecated.
FluentConfiguration.TransactionConfig	transactionSynchronizationRegistryLookup(TransactionSynchronizationRegistryLookup transactionSynchronizationRegistryLookup) Deprecated.
FluentConfiguration.UnsafeConfig	unsafe() Deprecated.
FluentConfiguration.UnsafeConfig	unsafe() Deprecated.
FluentConfiguration.TransactionConfig	useEagerLocking(Boolean useEagerLocking) Deprecated.
FluentConfiguration.TransactionConfig	useSynchronization(Boolean useSynchronization) Deprecated.
boolean	usingChainingCacheLoader()
FluentConfiguration.VersioningConfig	versioning() Deprecated.
FluentConfiguration.VersioningConfig	versioning() Deprecated.

Methods inherited from class org.infinispan.config.AbstractNamedCacheConfigurationBean

hasComponentStarted, inject

Methods inherited from class org.infinispan.config.AbstractConfigurationBean

testImmutability, toTypedProperties, toTypedProperties, uc, willUnmarshall

Methods inherited from class java.lang.Object

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

Field Detail

passivation

protected Boolean passivation

preload

protected Boolean preload

shared

protected Boolean shared

cacheLoaderConfigs

protected List<CacheLoaderConfig> cacheLoaderConfigs

Constructor Detail

CacheLoaderManagerConfig

public CacheLoaderManagerConfig()

CacheLoaderManagerConfig

public CacheLoaderManagerConfig(CacheLoaderConfig clc)

Method Detail

isPreload

public Boolean isPreload()

preload

public FluentConfiguration.LoadersConfig preload(Boolean preload)

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 FluentConfiguration.LoadersConfig

Parameters:

preload -

setPreload

@Deprecated
public void setPreload(Boolean preload)

Deprecated. The visibility of this method will be reduced. Use preload(Boolean) instead.

passivation

public FluentConfiguration.LoadersConfig passivation(Boolean passivation)

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. This gives you the ability to 'overflow' to disk, similar to swapping in an operating system.

If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

Specified by:

passivation in interface FluentConfiguration.LoadersConfig

Parameters:

passivation -

setPassivation

@Deprecated
public void setPassivation(Boolean passivation)

Deprecated. The visibility of this method will be reduced. Use passivation(Boolean) instead.

isPassivation

public Boolean isPassivation()

shared

public FluentConfiguration.LoadersConfig shared(Boolean shared)

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 FluentConfiguration.LoadersConfig

Parameters:

shared -

addCacheLoader

public FluentConfiguration.LoadersConfig addCacheLoader(CacheLoaderConfig... configs)

Specified by:

addCacheLoader in interface FluentConfiguration.LoadersConfig

setShared

@Deprecated
public void setShared(Boolean shared)

Deprecated. The visibility of this method will be reduced. Use shared(Boolean) instead.

isShared

public Boolean isShared()

addCacheLoaderConfig

@Deprecated
public FluentConfiguration.LoadersConfig addCacheLoaderConfig(CacheLoaderConfig clc)

Deprecated. use addCacheLoader(org.infinispan.loaders.CacheLoaderConfig...) instead

Parameters:

clc -

Returns:

getCacheLoaderConfigs

public List<CacheLoaderConfig> getCacheLoaderConfigs()

setCacheLoaderConfigs

@Deprecated
public FluentConfiguration.LoadersConfig setCacheLoaderConfigs(List<CacheLoaderConfig> configs)

Deprecated. The visibility of this method will be reduced and XMLElement definition is likely to move to the getCacheLoaderConfigs().

getFirstCacheLoaderConfig

public CacheLoaderConfig getFirstCacheLoaderConfig()

isFetchPersistentState

public Boolean isFetchPersistentState()

Loops through all individual cache loader configs and checks if fetchPersistentState is set on any of them

setConfiguration

protected CacheLoaderManagerConfig setConfiguration(Configuration config)

usingChainingCacheLoader

public boolean usingChainingCacheLoader()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

accept

public void accept(ConfigurationBeanVisitor v)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CacheLoaderManagerConfig clone()
                               throws CloneNotSupportedException

Specified by:

clone in interface CloneableConfigurationComponent

Overrides:

clone in class AbstractNamedCacheConfigurationBean

Throws:

CloneNotSupportedException

locking

public FluentConfiguration.LockingConfig locking()

Deprecated.

loaders

public FluentConfiguration.LoadersConfig loaders()

Deprecated.

transaction

public FluentConfiguration.TransactionConfig transaction()

Deprecated.

deadlockDetection

public FluentConfiguration.DeadlockDetectionConfig deadlockDetection()

Deprecated.

This method allows configuration of the deadlock detection. When this method is called, it automatically enables deadlock detection. So, if you want it to be disabled, make sure you call FluentConfiguration.DeadlockDetectionConfig.disable()

customInterceptors

public FluentConfiguration.CustomInterceptorsConfig customInterceptors()

Deprecated.

eviction

public FluentConfiguration.EvictionConfig eviction()

Deprecated.

expiration

public FluentConfiguration.ExpirationConfig expiration()

Deprecated.

clustering

public FluentConfiguration.ClusteringConfig clustering()

Deprecated.

indexing

public FluentConfiguration.IndexingConfig indexing()

Deprecated.

This method allows configuration of the indexing subsystem. When this method is called, it automatically enables indexing. So, if you want it to be disabled, make sure you call FluentConfiguration.IndexingConfig.disable()

dataContainer

public FluentConfiguration.DataContainerConfig dataContainer()

Deprecated.

unsafe

public FluentConfiguration.UnsafeConfig unsafe()

Deprecated.

jmxStatistics

public FluentConfiguration.JmxStatisticsConfig jmxStatistics()

Deprecated.

This method allows configuration of jmx statistics. When this method is called, it automatically enables jmx statistics.

storeAsBinary

public FluentConfiguration.StoreAsBinaryConfig storeAsBinary()

Deprecated.

This method allows configuration of lazy deserialization. When this method is called, it automatically enables lazy deserialization.

invocationBatching

public FluentConfiguration.InvocationBatchingConfig invocationBatching()

Deprecated.

This method allows configuration of invocation batching. When this method is called, it automatically enables invocation batching.

versioning

public FluentConfiguration.VersioningConfig versioning()

Deprecated.

build

public Configuration build()

Deprecated.

locking

public FluentConfiguration.LockingConfig locking()

Deprecated.

loaders

public FluentConfiguration.LoadersConfig loaders()

Deprecated.

transaction

public FluentConfiguration.TransactionConfig transaction()

Deprecated.

deadlockDetection

public FluentConfiguration.DeadlockDetectionConfig deadlockDetection()

Deprecated.

This method allows configuration of the deadlock detection. When this method is called, it automatically enables deadlock detection. So, if you want it to be disabled, make sure you call FluentConfiguration.DeadlockDetectionConfig.disable()

customInterceptors

public FluentConfiguration.CustomInterceptorsConfig customInterceptors()

Deprecated.

eviction

public FluentConfiguration.EvictionConfig eviction()

Deprecated.

expiration

public FluentConfiguration.ExpirationConfig expiration()

Deprecated.

clustering

public FluentConfiguration.ClusteringConfig clustering()

Deprecated.

indexing

public FluentConfiguration.IndexingConfig indexing()

Deprecated.

This method allows configuration of the indexing subsystem. When this method is called, it automatically enables indexing. So, if you want it to be disabled, make sure you call FluentConfiguration.IndexingConfig.disable()

dataContainer

public FluentConfiguration.DataContainerConfig dataContainer()

Deprecated.

unsafe

public FluentConfiguration.UnsafeConfig unsafe()

Deprecated.

jmxStatistics

public FluentConfiguration.JmxStatisticsConfig jmxStatistics()

Deprecated.

This method allows configuration of jmx statistics. When this method is called, it automatically enables jmx statistics.

storeAsBinary

public FluentConfiguration.StoreAsBinaryConfig storeAsBinary()

Deprecated.

This method allows configuration of lazy deserialization. When this method is called, it automatically enables lazy deserialization.

versioning

public FluentConfiguration.VersioningConfig versioning()

Deprecated.

invocationBatching

public FluentConfiguration.InvocationBatchingConfig invocationBatching()

Deprecated.

This method allows configuration of invocation batching. When this method is called, it automatically enables invocation batching.

async

public FluentConfiguration.AsyncConfig async()

Deprecated.

sync

public FluentConfiguration.SyncConfig sync()

Deprecated.

stateRetrieval

public FluentConfiguration.StateRetrievalConfig stateRetrieval()

Deprecated.

l1

public FluentConfiguration.L1Config l1()

Deprecated.

hash

public FluentConfiguration.HashConfig hash()

Deprecated.

mode

public FluentConfiguration.ClusteringConfig mode(Configuration.CacheMode mode)

Deprecated.

transactionManagerLookupClass

public FluentConfiguration.TransactionConfig transactionManagerLookupClass(Class<? extends TransactionManagerLookup> transactionManagerLookupClass)

Deprecated.

transactionManagerLookup

public FluentConfiguration.TransactionConfig transactionManagerLookup(TransactionManagerLookup transactionManagerLookup)

Deprecated.

transactionSynchronizationRegistryLookup

public FluentConfiguration.TransactionConfig transactionSynchronizationRegistryLookup(TransactionSynchronizationRegistryLookup transactionSynchronizationRegistryLookup)

Deprecated.

syncCommitPhase

public FluentConfiguration.TransactionConfig syncCommitPhase(Boolean syncCommitPhase)

Deprecated.

syncRollbackPhase

public FluentConfiguration.TransactionConfig syncRollbackPhase(Boolean syncRollbackPhase)

Deprecated.

useEagerLocking

public FluentConfiguration.TransactionConfig useEagerLocking(Boolean useEagerLocking)

Deprecated.

eagerLockSingleNode

public FluentConfiguration.TransactionConfig eagerLockSingleNode(Boolean eagerLockSingleNode)

Deprecated.

cacheStopTimeout

public FluentConfiguration.TransactionConfig cacheStopTimeout(Integer cacheStopTimeout)

Deprecated.

useSynchronization

public FluentConfiguration.TransactionConfig useSynchronization(Boolean useSynchronization)

Deprecated.

recovery

public FluentConfiguration.RecoveryConfig recovery()

Deprecated.

build

public Configuration build()

Deprecated.