Package org.infinispan.configuration.cache

Class ClusteringConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.ClusteringConfigurationBuilder

All Implemented Interfaces:

Builder<ClusteringConfiguration>, ClusteringConfigurationChildBuilder, ConfigurationChildBuilder

public class ClusteringConfigurationBuilder
extends Object
implements ClusteringConfigurationChildBuilder, Builder<ClusteringConfiguration>

Defines clustered characteristics of the cache.

Author:

pmuir

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConfigurationBuilder	builder

Method Summary

Modifier and Type	Method	Description
AttributeSet	attributes()
ClusteringConfigurationBuilder	biasAcquisition(BiasAcquisition biasAcquisition)	Used in scattered cache.
ClusteringConfigurationBuilder	biasLifespan(long l, TimeUnit unit)	Used in scattered cache.
Configuration	build()
CacheMode	cacheMode()
ClusteringConfigurationBuilder	cacheMode(CacheMode cacheMode)	Cache mode.
ClusteringConfigurationBuilder	cacheSync(boolean sync)
ClusteringConfigurationBuilder	cacheType(CacheType type)
ClusteringConfigurationBuilder	clustering()
ClusteringConfiguration	create()	Create the configuration bean
CustomInterceptorsConfigurationBuilder	customInterceptors()	Deprecated, for removal: This API element is subject to removal in a future version. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
EncodingConfigurationBuilder	encoding()
ExpirationConfigurationBuilder	expiration()
protected ConfigurationBuilder	getBuilder()
HashConfigurationBuilder	hash()	Configure hash sub element
IndexingConfigurationBuilder	indexing()
ClusteringConfigurationBuilder	invalidationBatchSize(int size)	For scattered cache, the threshold after which batched invalidations are sent
InvocationBatchingConfigurationBuilder	invocationBatching()
L1ConfigurationBuilder	l1()	This method allows configuration of the L1 cache for distributed caches.
LockingConfigurationBuilder	locking()
MemoryConfigurationBuilder	memory()
PartitionHandlingConfigurationBuilder	partitionHandling()	Configures how the cache will react to cluster partitions.
PersistenceConfigurationBuilder	persistence()
QueryConfigurationBuilder	query()
ClusteringConfigurationBuilder	read(ClusteringConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
ClusteringConfigurationBuilder	remoteTimeout(long l)	This is the timeout used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.
ClusteringConfigurationBuilder	remoteTimeout(long l, TimeUnit unit)	This is the timeout used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.
SecurityConfigurationBuilder	security()
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
SitesConfigurationBuilder	sites()
StateTransferConfigurationBuilder	stateTransfer()	Configure the stateTransfer sub element for distributed and replicated caches.
StatisticsConfigurationBuilder	statistics()
ConfigurationChildBuilder	template(boolean template)
String	toString()
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

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

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

Field Details

builder

protected final ConfigurationBuilder builder

Method Details

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<ClusteringConfiguration>

cacheMode

public ClusteringConfigurationBuilder cacheMode(CacheMode cacheMode)

Cache mode. See CacheMode for information on the various cache modes available.

cacheMode

public CacheMode cacheMode()

cacheType

public ClusteringConfigurationBuilder cacheType(CacheType type)

cacheSync

public ClusteringConfigurationBuilder cacheSync(boolean sync)

remoteTimeout

public ClusteringConfigurationBuilder remoteTimeout(long l)

This is the timeout used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.

remoteTimeout

public ClusteringConfigurationBuilder remoteTimeout(long l,
 TimeUnit unit)

This is the timeout used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.

invalidationBatchSize

public ClusteringConfigurationBuilder invalidationBatchSize(int size)

For scattered cache, the threshold after which batched invalidations are sent

biasAcquisition

public ClusteringConfigurationBuilder biasAcquisition(BiasAcquisition biasAcquisition)

Used in scattered cache. Acquired bias allows reading data on non-owner, but slows down further writes from other nodes.

biasLifespan

public ClusteringConfigurationBuilder biasLifespan(long l,
 TimeUnit unit)

Used in scattered cache. Specifies the duration (in Milliseconds) that acquired bias can be held; while the reads will never be stale, tracking that information consumes memory on the primary owner.

hash

public HashConfigurationBuilder hash()

Configure hash sub element

Specified by:

hash in interface ClusteringConfigurationChildBuilder

l1

public L1ConfigurationBuilder l1()

This method allows configuration of the L1 cache for distributed caches. L1 should be explicitly enabled by calling L1ConfigurationBuilder.enable()

Specified by:

l1 in interface ClusteringConfigurationChildBuilder

stateTransfer

public StateTransferConfigurationBuilder stateTransfer()

Configure the stateTransfer sub element for distributed and replicated caches. It doesn't have any effect on LOCAL or INVALIDATION-mode caches.

Specified by:

stateTransfer in interface ClusteringConfigurationChildBuilder

partitionHandling

public PartitionHandlingConfigurationBuilder partitionHandling()

Description copied from interface: ClusteringConfigurationChildBuilder

Configures how the cache will react to cluster partitions.

Specified by:

partitionHandling in interface ClusteringConfigurationChildBuilder

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

validate

public void validate(GlobalConfiguration globalConfig)

Specified by:

validate in interface ConfigurationChildBuilder

create

public ClusteringConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<ClusteringConfiguration>

Returns:

read

public ClusteringConfigurationBuilder read(ClusteringConfiguration 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<ClusteringConfiguration>

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.

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(forRemoval=true)
public CustomInterceptorsConfigurationBuilder customInterceptors()

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

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

query

public QueryConfigurationBuilder query()

Specified by:

query 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