Package org.infinispan.configuration.cache

Class PersistenceConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.PersistenceConfigurationBuilder

All Implemented Interfaces:

Builder<PersistenceConfiguration>, ConfigurationChildBuilder

public class PersistenceConfigurationBuilder
extends Object
implements Builder<PersistenceConfiguration>

Configuration for cache stores.

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConfigurationBuilder	builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PersistenceConfigurationBuilder(ConfigurationBuilder builder)

Method Summary

Modifier and Type	Method	Description
ClusterLoaderConfigurationBuilder	addClusterLoader()	Deprecated, for removal: This API element is subject to removal in a future version. since 11.0.
SingleFileStoreConfigurationBuilder	addSingleFileStore()	Deprecated, for removal: This API element is subject to removal in a future version. since 13.0.
SoftIndexFileStoreConfigurationBuilder	addSoftIndexFileStore()	Adds a soft index file cache store.
<T extends StoreConfigurationBuilder<?, ?>> T	addStore(Class<T> klass)	Adds a cache loader that uses the specified builder class to build its configuration.
StoreConfigurationBuilder<?,?>	addStore(StoreConfigurationBuilder<?,?> builder)	Adds a cache loader that uses the specified builder instance to build its configuration.
ConfigurationBuilder	aliases(String... aliases)
AttributeSet	attributes()
PersistenceConfigurationBuilder	availabilityInterval(int interval)
PersistenceConfigurationBuilder	availabilityInterval(String interval)	Same as availabilityInterval(int) but supporting time units
Configuration	build()
PersistenceConfigurationBuilder	clearStores()	Removes any configured stores from this builder.
ClusteringConfigurationBuilder	clustering()
PersistenceConfigurationBuilder	connectionAttempts(int attempts)
PersistenceConfigurationBuilder	connectionInterval(int interval)	Deprecated, for removal: This API element is subject to removal in a future version.
PersistenceConfiguration	create()	Create the configuration bean
EncodingConfigurationBuilder	encoding()
ExpirationConfigurationBuilder	expiration()
protected ConfigurationBuilder	getBuilder()
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
LockingConfigurationBuilder	locking()
MemoryConfigurationBuilder	memory()
PersistenceConfigurationBuilder	passivation(boolean b)
PersistenceConfigurationBuilder	persistence()
QueryConfigurationBuilder	query()
PersistenceConfigurationBuilder	read(PersistenceConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
SecurityConfigurationBuilder	security()
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
SitesConfigurationBuilder	sites()
StatisticsConfigurationBuilder	statistics()
List<StoreConfigurationBuilder<?,?>>	stores()
ConfigurationChildBuilder	template(boolean template)
String	toString()
TracingConfigurationBuilder	tracing()
TransactionConfigurationBuilder	transaction()
UnsafeConfigurationBuilder	unsafe()
void	validate()	Validate the data in this builder before building the configuration bean
void	validate(GlobalConfiguration globalConfig)

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

read, reset

Field Details

builder

protected final ConfigurationBuilder builder

Constructor Details

PersistenceConfigurationBuilder

protected PersistenceConfigurationBuilder(ConfigurationBuilder builder)

Method Details

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<PersistenceConfiguration>

passivation

public PersistenceConfigurationBuilder passivation(boolean b)

availabilityInterval

public PersistenceConfigurationBuilder availabilityInterval(int interval)

Parameters:

interval - The time, in milliseconds, between availability checks to determine if the PersistenceManager is available. In other words, this interval sets how often stores/loaders are polled via their `org.infinispan.persistence.spi.CacheWriter#isAvailable` or `org.infinispan.persistence.spi.CacheLoader#isAvailable` implementation. If a single store/loader is not available, an exception is thrown during cache operations.

availabilityInterval

public PersistenceConfigurationBuilder availabilityInterval(String interval)

Same as availabilityInterval(int) but supporting time units

connectionAttempts

public PersistenceConfigurationBuilder connectionAttempts(int attempts)

Parameters:

attempts - The maximum number of unsuccessful attempts to start each of the configured CacheWriter/CacheLoader before an exception is thrown and the cache fails to start.

connectionInterval

@Deprecated(forRemoval=true)
public PersistenceConfigurationBuilder connectionInterval(int interval)

Deprecated, for removal: This API element is subject to removal in a future version.

Parameters:

interval - The time, in milliseconds, to wait between subsequent connection attempts on startup. A negative or zero value means no wait between connection attempts.

addStore

public <T extends StoreConfigurationBuilder<?,
?>>
T addStore(Class<T> klass)

Adds a cache loader that uses the specified builder class to build its configuration.

addStore

public StoreConfigurationBuilder<?,?> addStore(StoreConfigurationBuilder<?,?> builder)

Adds a cache loader that uses the specified builder instance to build its configuration.

Parameters:

builder - is an instance of StoreConfigurationBuilder.

addClusterLoader

@Deprecated(forRemoval=true,
            since="11.0")
public ClusterLoaderConfigurationBuilder addClusterLoader()

Deprecated, for removal: This API element is subject to removal in a future version.

since 11.0. To be removed in 14.0 ISPN-11864 with no direct replacement.

Adds a cluster cache loader.

addSingleFileStore

@Deprecated(forRemoval=true,
            since="13.0")
public SingleFileStoreConfigurationBuilder addSingleFileStore()

Deprecated, for removal: This API element is subject to removal in a future version.

since 13.0. To be removed in 16.0 has been replaced by addSoftIndexFileStore()

Adds a single file cache store.

addSoftIndexFileStore

public SoftIndexFileStoreConfigurationBuilder addSoftIndexFileStore()

Adds a soft index file cache store.

Returns:

the configuration for a soft index file store

clearStores

public PersistenceConfigurationBuilder clearStores()

Removes any configured stores from this builder.

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

validate

public void validate(GlobalConfiguration globalConfig)

Specified by:

validate in interface ConfigurationChildBuilder

create

public PersistenceConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<PersistenceConfiguration>

Returns:

read

public PersistenceConfigurationBuilder read(PersistenceConfiguration template,
 Combine combine)

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

Parameters:

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

combine - the way attributes and children of this instance and the template should be combined.

stores

public List<StoreConfigurationBuilder<?,?>> stores()

toString

public String toString()

Overrides:

toString in class Object

aliases

public ConfigurationBuilder aliases(String... aliases)

Specified by:

aliases in interface ConfigurationChildBuilder

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

encoding

public EncodingConfigurationBuilder encoding()

Specified by:

encoding in interface ConfigurationChildBuilder

expiration

public ExpirationConfigurationBuilder expiration()

Specified by:

expiration in interface ConfigurationChildBuilder

query

public QueryConfigurationBuilder query()

Specified by:

query in interface ConfigurationChildBuilder

indexing

public IndexingConfigurationBuilder indexing()

Specified by:

indexing in interface ConfigurationChildBuilder

tracing

public TracingConfigurationBuilder tracing()

Specified by:

tracing 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