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 final ConfigurationBuilder	builder

Method Summary

Modifier and Type	Method	Description
AttributeSet	attributes()
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()
HashConfigurationBuilder	consistentHashFactory(ConsistentHashFactory<? extends ConsistentHash> consistentHashFactory)	Deprecated, for removal: This API element is subject to removal in a future version. Since 11.0.
HashConfiguration	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()
protected ClusteringConfigurationBuilder	getClusteringBuilder()
GroupsConfigurationBuilder	groups()
HashConfigurationBuilder	hash()	Allows fine-tuning of rehashing characteristics.
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
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).
PartitionHandlingConfigurationBuilder	partitionHandling()	Configures how the cache will react to cluster partitions.
PersistenceConfigurationBuilder	persistence()
QueryConfigurationBuilder	query()
HashConfigurationBuilder	read(HashConfiguration 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()
StateTransferConfigurationBuilder	stateTransfer()	Configures how state is transferred when a new cache joins the cluster.
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<HashConfiguration>

consistentHashFactory

@Deprecated(forRemoval=true)
public HashConfigurationBuilder consistentHashFactory(ConsistentHashFactory<? extends ConsistentHash> consistentHashFactory)

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

Since 11.0. Will be removed in 14.0, the segment allocation will no longer be customizable.

The consistent hash factory in use.

numOwners

public HashConfigurationBuilder numOwners(int numOwners)

Number of cluster-wide replicas for each cache entry.

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, very small numSegments values (< 10 segments per node) will make the distribution of keys between nodes more uneven.

The recommended value is 20 * the expected cluster size.

Note: The value returned by ConsistentHash.getNumSegments() may be different, e.g. rounded up to a power of 2.

Parameters:

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

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 is org.infinispan.distribution.ch.impl.HashFunctionPartitioner, uses MurmurHash3.

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

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

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

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

@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