org.gridgain.grid.kernal.processors.cache

Class GridCacheDefaultAffinityKeyMapper

java.lang.Object

org.gridgain.grid.kernal.processors.cache.GridCacheDefaultAffinityKeyMapper

All Implemented Interfaces:

Serializable, GridCacheAffinityKeyMapper

public class GridCacheDefaultAffinityKeyMapper
extends Object
implements GridCacheAffinityKeyMapper

Default key affinity mapper. If key class has annotation GridCacheAffinityKeyMapped, then the value of annotated method or field will be used to get affinity value instead of the key itself. If there is no annotation, then the key is used as is.

Convenience affinity key adapter, GridCacheAffinityKey can be used in conjunction with this mapper to automatically provide custom affinity keys for cache keys.

If non-default affinity mapper is used, is should be provided via GridCacheConfiguration.getAffinityMapper() configuration property.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GridCacheDefaultAffinityKeyMapper()

Method Summary

Methods

Modifier and Type	Method and Description
Object	affinityKey(Object key) If key class has annotation GridCacheAffinityKeyMapped, then the value of annotated method or field will be used to get affinity value instead of the key itself.
void	reset() Resets cache affinity mapper to its initial state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GridCacheDefaultAffinityKeyMapper

public GridCacheDefaultAffinityKeyMapper()

Method Detail

affinityKey

public Object affinityKey(Object key)

If key class has annotation GridCacheAffinityKeyMapped, then the value of annotated method or field will be used to get affinity value instead of the key itself. If there is no annotation, then the key is returned as is.

Specified by:

affinityKey in interface GridCacheAffinityKeyMapper

Parameters:

key - Key to get affinity key for.

Returns:

Affinity key for given key.

reset

public void reset()

Resets cache affinity mapper to its initial state. This method will be called by the system any time the affinity mapper has been sent to remote node where it has to be reinitialized. If your implementation of affinity mapper has no initialization logic, leave this method empty.

Specified by:

reset in interface GridCacheAffinityKeyMapper