Bug 1038636

24. High Availability Using Server Hinting
"In Red Hat JBoss Data Grid, Server Hinting is a topology aware consistent hashing algorithm that ensures backup copies of data are not stored on the same physical server, rack or data center as the original. Server Hinting does not apply to total replication because total replication mandates complete replicas on every server, rack and data center."

change to

"In Red Hat JBoss Data Grid, Server Hinting ensures backup copies of data are not stored on the same physical server, rack or data center as the original. Server Hinting does not apply to total replication because total replication mandates complete replicas on every server, rack and data center.

Data distribution across nodes is controlled by mechanism called Consistent Hashing. Red Hat JBoss Data Grid offers a pluggable policy to specify the consistent hashing algorithm. For details see section 24.4."

24.2. Configure Server Hinting (Remote Client-Server Mode)
"configured using the subsystem tags" -> "configured in the JGroups subsystem on the transport element for the default stack"

"Set up subsystem Tagging" -> "Find the JGroups subsystem configuration"

24.4. ConsistentHashFactories
Add following at the beginning:
"Red Hat JBoss Data Grid offers pluggable mechanism for selecting the consistent hashing algorithm. It is shipped with four implementations but a custom one may be used as well."

Then move the list of shipped algorithms from 24.4.1 here.

Replace the

---BEGIN---
The TopologyAwareConsistentHashFactory implementation enables Server Hinting. This attempts to distribute segments based on the topology information in the Transport configuration.
The TopologyAwareConsistentHashFactory implementation can be selected by setting one or more of the parameters in the transport configuration.
The TopologyAwareSyncConsistentHashFactory implementation can also be selected via the hash configuration:
---END---

with

"The consistent hash implementation can be selected via the hash configuration:"

24.4.1. Implementing a ConsistentHashFactory
Remove the first sentence, the list below that should be moved to 24.4.

"In addition to these, a ConsistentHashFactory can be implemented manually. The custom ConsistentHashFactory must implement the following methods:
The following is an example to manually implement ConsistentHashFactory"

->

"Custom ConsistentHashFactory must implement the org.infinispan.distribution.ch.ConsistenHashFactory interface with following methods (all returning implementation of org.infinispan.distribution.ch.ConsistentHash):"

---------------
create(Hash hashFunction, int numOwners, int numSegments, List<Address> members,Map<Address, Float> capacityFactors)
updateMembers(ConsistentHash baseCH, List<Address> newMembers, Map<Address, Float> capacityFactors)
rebalance(ConsistentHash baseCH)
union(ConsistentHash ch1, ConsistentHash ch2)
--------------

Remove the whole Procedure 24.3., if somebody wants to implement custom ConsistentHashFactory, he needs to look into the interface source code anyways.