com.ibm.websphere.objectgrid.plugins
Interface PartitionableKey

public interface PartitionableKey

This interface is used to identify keys that want to use their own partitioning algorithm. If a key supports this interface, ObjectGrid will call the ibmGetPartition() method to prime the partitioning process. The returned Object needs to support the hashCode() method which will be used by ObjectGrid to spread the data requests across the set of configured partitions. If this interface is not used, then the hashCode() method on the key itself will be used to prime the partitioning process.

Since:

WAS XD 6.0.1

Method Summary

Object

ibmGetPartition() Used to obtain an object from the key that should be used for partitioning.

Method Detail

ibmGetPartition

Object ibmGetPartition()

Used to obtain an object from the key that should be used for partitioning.

The returned Object could be a String, an Integer, or any Object that properly identifies the desired partition. ObjectGrid will use this returned Object's hashCode() method to prime the partitioning process.

Returns:

an Object that identifies the desired partition for this key