org.infinispan.configuration.cache

Class HashConfiguration

java.lang.Object

org.infinispan.configuration.cache.HashConfiguration

All Implemented Interfaces:

Matchable<HashConfiguration>, BaseConfigurationInfo, ConfigurationInfo

public class HashConfiguration
extends java.lang.Object
implements Matchable<HashConfiguration>, ConfigurationInfo

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

Field Summary

Fields

Modifier and Type	Field and Description
static AttributeDefinition<java.lang.Float>	CAPACITY_FACTOR
static AttributeDefinition<ConsistentHashFactory>	CONSISTENT_HASH_FACTORY
static ElementDefinition	ELEMENT_DEFINITION
static AttributeDefinition<Hash>	HASH
static AttributeDefinition<KeyPartitioner>	KEY_PARTITIONER
static AttributeDefinition<java.lang.Integer>	NUM_OWNERS
static AttributeDefinition<java.lang.Integer>	NUM_SEGMENTS

Method Summary

Modifier and Type	Method and Description
AttributeSet	attributes()
float	capacityFactor() Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster.
ConsistentHash	consistentHash() Deprecated. Since 5.2, replaced by consistentHashFactory().
ConsistentHashFactory<?>	consistentHashFactory() The consistent hash factory in use.
boolean	equals(java.lang.Object obj)
ElementDefinition	getElementDefinition()
GroupsConfiguration	groups() Configuration for various grouper definitions.
Hash	hash() Deprecated. Since 8.2, use keyPartitioner() instead.
int	hashCode()
KeyPartitioner	keyPartitioner()
boolean	matches(HashConfiguration other)
int	numOwners() Number of cluster-wide replicas for each cache entry.
int	numSegments() Controls the total number of hash space segments (per cluster).
boolean	rehashEnabled() Deprecated. Use StateTransferConfiguration.fetchInMemoryState() instead.
long	rehashRpcTimeout() Deprecated. Use StateTransferConfiguration.timeout() instead.
long	rehashWait() Deprecated. Use StateTransferConfiguration.timeout() instead.
java.util.List<ConfigurationInfo>	subElements()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CONSISTENT_HASH_FACTORY

public static final AttributeDefinition<ConsistentHashFactory> CONSISTENT_HASH_FACTORY

HASH

public static final AttributeDefinition<Hash> HASH

NUM_OWNERS

public static final AttributeDefinition<java.lang.Integer> NUM_OWNERS

NUM_SEGMENTS

public static final AttributeDefinition<java.lang.Integer> NUM_SEGMENTS

CAPACITY_FACTOR

public static final AttributeDefinition<java.lang.Float> CAPACITY_FACTOR

KEY_PARTITIONER

public static final AttributeDefinition<KeyPartitioner> KEY_PARTITIONER

ELEMENT_DEFINITION

public static final ElementDefinition ELEMENT_DEFINITION

Method Detail

consistentHash

@Deprecated
public ConsistentHash consistentHash()

Deprecated. Since 5.2, replaced by consistentHashFactory().

consistentHashFactory

public ConsistentHashFactory<?> consistentHashFactory()

The consistent hash factory in use.

hash

@Deprecated
public Hash hash()

Deprecated. Since 8.2, use keyPartitioner() instead.

The hash function in use. Used as a bit spreader and a general hash code generator. Typically one of the the many default ConsistentHash implementations shipped.

numOwners

public int numOwners()

Number of cluster-wide replicas for each cache entry.

numSegments

public 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.

rehashEnabled

@Deprecated
public boolean rehashEnabled()

Deprecated. Use StateTransferConfiguration.fetchInMemoryState() instead.

If false, no rebalancing or rehashing will take place when a new node joins the cluster or a node leaves

rehashRpcTimeout

@Deprecated
public long rehashRpcTimeout()

Deprecated. Use StateTransferConfiguration.timeout() instead.

Rehashing timeout

rehashWait

@Deprecated
public long rehashWait()

Deprecated. Use StateTransferConfiguration.timeout() instead.

capacityFactor

public 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.

keyPartitioner

public KeyPartitioner keyPartitioner()

groups

public GroupsConfiguration groups()

Configuration for various grouper definitions. See the user guide for more information.

attributes

public AttributeSet attributes()

Specified by:

attributes in interface BaseConfigurationInfo

Returns:

the AttributeSet declared by the configuration.

getElementDefinition

public ElementDefinition getElementDefinition()

Specified by:

getElementDefinition in interface BaseConfigurationInfo

Returns:

the ElementDefinition of the configuration.

subElements

public java.util.List<ConfigurationInfo> subElements()

Specified by:

subElements in interface ConfigurationInfo

Returns:

the list of sub elements.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

matches

public boolean matches(HashConfiguration other)

Specified by:

matches in interface Matchable<HashConfiguration>