Package org.infinispan.configuration.cache

Class HashConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.HashConfigurationBuilder

All Implemented Interfaces:

Builder<HashConfiguration>, ClusteringConfigurationChildBuilder, ConfigurationChildBuilder

public class HashConfigurationBuilder
extends Object
implements Builder<HashConfiguration>

Allows fine-tuning of rehashing characteristics. Must only used with 'distributed' cache mode.

Author:

pmuir

Field Summary

Fields

Modifier and Type	Field	Description
protected ConfigurationBuilder	builder

Method Summary

Modifier and Type	Method	Description
Configuration	build()
HashConfigurationBuilder	capacityFactor(float capacityFactor)	Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster.
ClusteringConfigurationBuilder	clustering()
CompatibilityModeConfigurationBuilder	compatibility()	Deprecated.
HashConfigurationBuilder	consistentHash(ConsistentHash consistentHash)	Deprecated. Since 5.2, replaced by consistentHashFactory(ConsistentHashFactory).
HashConfigurationBuilder	consistentHashFactory(ConsistentHashFactory<? extends ConsistentHash> consistentHashFactory)	The consistent hash factory in use.
HashConfiguration	create()	Create the configuration bean
CustomInterceptorsConfigurationBuilder	customInterceptors()
DataContainerConfigurationBuilder	dataContainer()
DeadlockDetectionConfigurationBuilder	deadlockDetection()
EncodingConfigurationBuilder	encoding()
EvictionConfigurationBuilder	eviction()
ExpirationConfigurationBuilder	expiration()
protected ConfigurationBuilder	getBuilder()
protected ClusteringConfigurationBuilder	getClusteringBuilder()
GroupsConfigurationBuilder	groups()
HashConfigurationBuilder	hash()	Allows fine-tuning of rehashing characteristics.
HashConfigurationBuilder	hash(Hash hash)	Deprecated. Since 8.2, use keyPartitioner(KeyPartitioner) instead.
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
JMXStatisticsConfigurationBuilder	jmxStatistics()
HashConfigurationBuilder	keyPartitioner(KeyPartitioner keyPartitioner)	Key partitioner, controlling the mapping of keys to hash segments.
L1ConfigurationBuilder	l1()	Configures the L1 cache behavior in 'distributed' caches instances.
LockingConfigurationBuilder	locking()
MemoryConfigurationBuilder	memory()
HashConfigurationBuilder	numOwners(int numOwners)	Number of cluster-wide replicas for each cache entry.
HashConfigurationBuilder	numSegments(int numSegments)	Controls the total number of hash space segments (per cluster).
HashConfigurationBuilder	numVirtualNodes(int numVirtualNodes)	Deprecated. No longer used since 5.2, replaced by numSegments(int) (which works like a numVirtualNodes value for the entire cluster).
PartitionHandlingConfigurationBuilder	partitionHandling()	Configures how the cache will react to cluster partitions.
PersistenceConfigurationBuilder	persistence()
HashConfigurationBuilder	read(HashConfiguration template)	Reads the configuration from an already created configuration bean into this builder.
HashConfigurationBuilder	rehashDisabled()	Deprecated. Use StateTransferConfigurationBuilder.fetchInMemoryState(boolean) instead.
HashConfigurationBuilder	rehashEnabled()	Deprecated. Use StateTransferConfigurationBuilder.fetchInMemoryState(boolean) instead.
HashConfigurationBuilder	rehashEnabled(boolean enabled)	Deprecated. Use StateTransferConfigurationBuilder.fetchInMemoryState(boolean) instead.
HashConfigurationBuilder	rehashRpcTimeout(long rehashRpcTimeout)	Deprecated. Use StateTransferConfigurationBuilder.timeout(long) instead.
HashConfigurationBuilder	rehashWait(long rehashWait)	Deprecated. No longer used.
SecurityConfigurationBuilder	security()
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
SitesConfigurationBuilder	sites()
StateTransferConfigurationBuilder	stateTransfer()	Configures how state is transferred when a new cache joins the cluster.
StoreAsBinaryConfigurationBuilder	storeAsBinary()	Deprecated.
SyncConfigurationBuilder	sync()	If configured all communications are synchronous, in that whenever a thread sends a message sent over the wire, it blocks until it receives an acknowledgment from the recipient.
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)
VersioningConfigurationBuilder	versioning()

Methods inherited from class java.lang.Object

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

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

build, clustering, compatibility, customInterceptors, dataContainer, deadlockDetection, encoding, eviction, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, persistence, security, simpleCache, simpleCache, sites, storeAsBinary, template, transaction, unsafe, versioning

Field Detail

builder

protected final ConfigurationBuilder builder

Method Detail

consistentHash

@Deprecated
public HashConfigurationBuilder consistentHash(ConsistentHash consistentHash)

Deprecated.

Since 5.2, replaced by consistentHashFactory(ConsistentHashFactory).

consistentHashFactory

public HashConfigurationBuilder consistentHashFactory(ConsistentHashFactory<? extends ConsistentHash> consistentHashFactory)

The consistent hash factory in use.

numOwners

public HashConfigurationBuilder numOwners(int numOwners)

Number of cluster-wide replicas for each cache entry.

numVirtualNodes

@Deprecated
public HashConfigurationBuilder numVirtualNodes(int numVirtualNodes)

Deprecated.

No longer used since 5.2, replaced by numSegments(int) (which works like a numVirtualNodes value for the entire cluster).

numSegments

public HashConfigurationBuilder numSegments(int numSegments)

Controls the total number of hash space segments (per cluster).

A hash space segment is the granularity for key distribution in the cluster: a node can own (or primary-own) one or more full segments, but not a fraction of a segment. As such, larger numSegments values will mean a more even distribution of keys between nodes.

On the other hand, the memory/bandwidth usage of the new consistent hash grows linearly with numSegments. So we recommend keeping numSegments <= 10 * clusterSize.

Parameters:

numSegments - the number of hash space segments. Must be strictly positive.

rehashEnabled

@Deprecated
public HashConfigurationBuilder rehashEnabled()

Deprecated.

Use StateTransferConfigurationBuilder.fetchInMemoryState(boolean) instead.

Enable rebalancing and rehashing, which will take place when a new node joins the cluster or a node leaves

rehashEnabled

@Deprecated
public HashConfigurationBuilder rehashEnabled(boolean enabled)

Deprecated.

Use StateTransferConfigurationBuilder.fetchInMemoryState(boolean) instead.

Enable rebalancing and rehashing, which will take place when a new node joins the cluster or a node leaves

rehashDisabled

@Deprecated
public HashConfigurationBuilder rehashDisabled()

Deprecated.

Use StateTransferConfigurationBuilder.fetchInMemoryState(boolean) instead.

Disable rebalancing and rehashing, which would have taken place when a new node joins the cluster or a node leaves

rehashRpcTimeout

@Deprecated
public HashConfigurationBuilder rehashRpcTimeout(long rehashRpcTimeout)

Deprecated.

Use StateTransferConfigurationBuilder.timeout(long) instead.

Rehashing timeout

rehashWait

@Deprecated
public HashConfigurationBuilder rehashWait(long rehashWait)

Deprecated.

No longer used.

hash

@Deprecated
public HashConfigurationBuilder hash(Hash hash)

Deprecated.

Since 8.2, use keyPartitioner(KeyPartitioner) instead.

The hash function in use. Used as a bit spreader and a general hash code generator. Typically used in conjunction with the many default ConsistentHash implementations shipped. NOTE: Currently Infinispan will not use the object instance, but instead instantiate a new instance of the class. Therefore, do not expect any state to survive, and provide a no-args constructor to any instance. This will be resolved in Infinispan 5.2.0

capacityFactor

public HashConfigurationBuilder capacityFactor(float capacityFactor)

Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster. This is just a suggestion, there is no guarantee that a node with a capacity factor of 2 will have twice as many entries as a node with a capacity factor of 1.

Parameters:

capacityFactor - the capacity factor for the local node. Must be positive.

keyPartitioner

public HashConfigurationBuilder keyPartitioner(KeyPartitioner keyPartitioner)

Key partitioner, controlling the mapping of keys to hash segments.

The default implementation org.infinispan.distribution.ch.impl.HashFunctionPartitioner, uses the hash function configured via hash(Hash). Future versions may ignore the hash function.

Since:

8.2

groups

public GroupsConfigurationBuilder groups()

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

validate

public void validate(GlobalConfiguration globalConfig)

Specified by:

validate in interface ConfigurationChildBuilder

create

public HashConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<HashConfiguration>

Returns:

read

public HashConfigurationBuilder read(HashConfiguration 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<HashConfiguration>

Parameters:

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

toString

public String toString()

Overrides:

toString in class Object

hash

public HashConfigurationBuilder hash()

Description copied from interface: ClusteringConfigurationChildBuilder

Allows fine-tuning of rehashing characteristics. Must only used with 'distributed' cache mode.

Specified by:

hash in interface ClusteringConfigurationChildBuilder

l1

public L1ConfigurationBuilder l1()

Description copied from interface: ClusteringConfigurationChildBuilder

Configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored.

Specified by:

l1 in interface ClusteringConfigurationChildBuilder

stateTransfer

public StateTransferConfigurationBuilder stateTransfer()

Description copied from interface: ClusteringConfigurationChildBuilder

Configures how state is transferred when a new cache joins the cluster. Used with distribution and replication clustered modes.

Specified by:

stateTransfer in interface ClusteringConfigurationChildBuilder

sync

public SyncConfigurationBuilder sync()

Description copied from interface: ClusteringConfigurationChildBuilder

If configured all communications are synchronous, in that whenever a thread sends a message sent over the wire, it blocks until it receives an acknowledgment from the recipient. SyncConfig is mutually exclusive with the AsyncConfig.

Specified by:

sync 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

getClusteringBuilder

protected ClusteringConfigurationBuilder getClusteringBuilder()

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

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

encoding

public EncodingConfigurationBuilder encoding()

Specified by:

encoding 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

security

public SecurityConfigurationBuilder security()

Specified by:

security in interface ConfigurationChildBuilder

storeAsBinary

@Deprecated
public StoreAsBinaryConfigurationBuilder storeAsBinary()

Deprecated.

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

@Deprecated
public CompatibilityModeConfigurationBuilder compatibility()

Deprecated.

Specified by:

compatibility 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