HashConfiguration (Infinispan JavaDoc 8.0.2.Final API)

java.lang.Object
- org.infinispan.configuration.cache.HashConfiguration

```
public class HashConfiguration
extends Object
```
Allows fine-tuning of rehashing characteristics. Must only used with 'distributed' cache mode.

Author:

pmuir

Field Summary

Fields
Modifier and Type	Field and Description
`static AttributeDefinition<Float>`	`CAPACITY_FACTOR`
`static AttributeDefinition<ConsistentHashFactory>`	`CONSISTENT_HASH_FACTORY`
`static AttributeDefinition<Hash>`	`HASH`
`static AttributeDefinition<Integer>`	`NUM_OWNERS`
`static AttributeDefinition<Integer>`	`NUM_SEGMENTS`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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(Object obj)`
`GroupsConfiguration`	`groups()` Configuration for various grouper definitions.
`Hash`	`hash()` The hash function in use.
`int`	`hashCode()`
`int`	`numOwners()` Number of cluster-wide replicas for each cache entry.
`int`	`numSegments()` Controls the total number of hash space segments (per cluster).
`int`	`numVirtualNodes()` Deprecated. No longer used since 5.2, replaced by `numSegments()` (which works like a `numVirtualNodes` value for the entire cluster).
`boolean`	`rehashEnabled()` Deprecated. Use `StateTransferConfiguration.fetchInMemoryState()` instead.
`long`	`rehashRpcTimeout()` Deprecated. Use `StateTransferConfiguration.timeout()` instead.
`long`	`rehashWait()` Deprecated. Use `StateTransferConfiguration.timeout()` instead.
`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<Integer> NUM_OWNERS
```
  - NUM_SEGMENTS
```
public static final AttributeDefinition<Integer> NUM_SEGMENTS
```
  - CAPACITY_FACTOR
```
public static final AttributeDefinition<Float> CAPACITY_FACTOR
```
- 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
```
public Hash hash()
```
    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.
  - numVirtualNodes
```
@Deprecated
public int numVirtualNodes()
```
    Deprecated. No longer used since 5.2, replaced by numSegments() (which works like a numVirtualNodes value for the entire cluster).
  - 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.
  - groups
```
public GroupsConfiguration groups()
```
    Configuration for various grouper definitions. See the user guide for more information.
  - attributes
```
public AttributeSet attributes()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class HashConfiguration

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONSISTENT_HASH_FACTORY

HASH

NUM_OWNERS

NUM_SEGMENTS

CAPACITY_FACTOR

Method Detail

consistentHash

consistentHashFactory

hash

numOwners

numVirtualNodes

numSegments

rehashEnabled

rehashRpcTimeout

rehashWait

capacityFactor

groups

attributes

toString

equals

hashCode