org.apache.ignite.internal.processors.cache.affinity

Class GridCacheAffinityProxy<K,V>

java.lang.Object

org.apache.ignite.internal.processors.cache.affinity.GridCacheAffinityProxy<K,V>

All Implemented Interfaces:

Externalizable, Serializable, CacheAffinity<K>

public class GridCacheAffinityProxy<K,V>
extends Object
implements CacheAffinity<K>, Externalizable

Affinity interface implementation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GridCacheAffinityProxy() Required by Externalizable.
GridCacheAffinityProxy(GridCacheContext<K,V> cctx, CacheAffinity<K> delegate)

Method Summary

Methods

Modifier and Type	Method and Description
Object	affinityKey(K key) Maps passed in key to a key which will be used for node affinity.
int[]	allPartitions(ClusterNode n) Gets partition ids for which nodes of the given projection has ownership (either primary or backup).
int[]	backupPartitions(ClusterNode n) Gets partition ids for which nodes of the given projection has backup ownership.
boolean	isBackup(ClusterNode n, K key) Returns true if local node is one of the backup nodes for given key.
boolean	isPrimary(ClusterNode n, K key) Returns true if given node is the primary node for given key.
boolean	isPrimaryOrBackup(ClusterNode n, K key) Returns true if local node is primary or one of the backup nodes This method is essentially equivalent to calling "CacheAffinity.isPrimary(org.apache.ignite.cluster.ClusterNode, Object) || CacheAffinity.isBackup(org.apache.ignite.cluster.ClusterNode, Object))", however it is more efficient as it makes both checks at once.
Map<ClusterNode,Collection<K>>	mapKeysToNodes(Collection<? extends K> keys) This method provides ability to detect which keys are mapped to which nodes.
ClusterNode	mapKeyToNode(K key) This method provides ability to detect to which primary node the given key is mapped.
Collection<ClusterNode>	mapKeyToPrimaryAndBackups(K key) Gets primary and backup nodes for the key.
Map<Integer,ClusterNode>	mapPartitionsToNodes(Collection<Integer> parts) Gets primary nodes for the given partitions.
ClusterNode	mapPartitionToNode(int part) Gets primary node for the given partition.
Collection<ClusterNode>	mapPartitionToPrimaryAndBackups(int part) Gets primary and backup nodes for partition.
int	partition(K key) Gets partition id for the given key.
int	partitions() Gets number of partitions in cache according to configured affinity function.
int[]	primaryPartitions(ClusterNode n) Gets partition ids for which nodes of the given projection has primary ownership.
void	readExternal(ObjectInput in)
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

GridCacheAffinityProxy

public GridCacheAffinityProxy()

Required by Externalizable.

GridCacheAffinityProxy

public GridCacheAffinityProxy(GridCacheContext<K,V> cctx,
                      CacheAffinity<K> delegate)

Parameters:

cctx - Context.

delegate - Delegate object.

Method Detail

partitions

public int partitions()

Gets number of partitions in cache according to configured affinity function.

Specified by:

partitions in interface CacheAffinity<K>

Returns:

Number of cache partitions.

See Also:

CacheAffinityFunction, CacheConfiguration.getAffinity(), CacheConfiguration.setAffinity(CacheAffinityFunction)

partition

public int partition(K key)

Gets partition id for the given key.

Specified by:

partition in interface CacheAffinity<K>

Parameters:

key - Key to get partition id for.

Returns:

Partition id.

See Also:

CacheAffinityFunction, CacheConfiguration.getAffinity(), CacheConfiguration.setAffinity(CacheAffinityFunction)

isPrimary

public boolean isPrimary(ClusterNode n,
                K key)

Returns true if given node is the primary node for given key.

Specified by:

isPrimary in interface CacheAffinity<K>

Parameters:

n - Node to check.

key - Key to check.

Returns:

True if local node is the primary node for given key.

isBackup

public boolean isBackup(ClusterNode n,
               K key)

Returns true if local node is one of the backup nodes for given key.

Specified by:

isBackup in interface CacheAffinity<K>

Parameters:

n - Node to check.

key - Key to check.

Returns:

True if local node is one of the backup nodes for given key.

isPrimaryOrBackup

public boolean isPrimaryOrBackup(ClusterNode n,
                        K key)

Returns true if local node is primary or one of the backup nodes

This method is essentially equivalent to calling "CacheAffinity.isPrimary(org.apache.ignite.cluster.ClusterNode, Object) || CacheAffinity.isBackup(org.apache.ignite.cluster.ClusterNode, Object))", however it is more efficient as it makes both checks at once.

Specified by:

isPrimaryOrBackup in interface CacheAffinity<K>

Parameters:

n - Node to check.

key - Key to check.

Returns:

True if local node is primary or backup for given key.

primaryPartitions

public int[] primaryPartitions(ClusterNode n)

Gets partition ids for which nodes of the given projection has primary ownership.

Note that since ClusterNode implements ClusterGroup, to find out primary partitions for a single node just pass a single node into this method.

This method may return an empty array if none of nodes in the projection have nearOnly disabled.

Specified by:

primaryPartitions in interface CacheAffinity<K>

Parameters:

n - Grid node.

Returns:

Partition ids for which given projection has primary ownership.

See Also:

CacheAffinityFunction, CacheConfiguration.getAffinity(), CacheConfiguration.setAffinity(CacheAffinityFunction)

backupPartitions

public int[] backupPartitions(ClusterNode n)

Gets partition ids for which nodes of the given projection has backup ownership. Note that you can find a back up at a certain level, e.g. first backup or third backup by specifying the 'levels parameter. If no 'level' is specified then all backup partitions are returned.

Note that since ClusterNode implements ClusterGroup, to find out backup partitions for a single node, just pass that single node into this method.

This method may return an empty array if none of nodes in the projection have nearOnly disabled.

Specified by:

backupPartitions in interface CacheAffinity<K>

Parameters:

n - Grid node.

Returns:

Partition ids for which given projection has backup ownership.

See Also:

CacheAffinityFunction, CacheConfiguration.getAffinity(), CacheConfiguration.setAffinity(CacheAffinityFunction)

allPartitions

public int[] allPartitions(ClusterNode n)

Gets partition ids for which nodes of the given projection has ownership (either primary or backup).

Note that since ClusterNode implements ClusterGroup, to find out all partitions for a single node, just pass that single node into this method.

This method may return an empty array if none of nodes in the projection have nearOnly disabled.

Specified by:

allPartitions in interface CacheAffinity<K>

Parameters:

n - Grid node.

Returns:

Partition ids for which given projection has ownership.

See Also:

CacheAffinityFunction, CacheConfiguration.getAffinity(), CacheConfiguration.setAffinity(CacheAffinityFunction)

mapPartitionToNode

public ClusterNode mapPartitionToNode(int part)

Gets primary node for the given partition.

Specified by:

mapPartitionToNode in interface CacheAffinity<K>

Parameters:

part - Partition id.

Returns:

Primary node for the given partition.

See Also:

CacheAffinityFunction, CacheConfiguration.getAffinity(), CacheConfiguration.setAffinity(CacheAffinityFunction)

mapPartitionsToNodes

public Map<Integer,ClusterNode> mapPartitionsToNodes(Collection<Integer> parts)

Gets primary nodes for the given partitions.

Specified by:

mapPartitionsToNodes in interface CacheAffinity<K>

Parameters:

parts - Partition ids.

Returns:

Mapping of given partitions to their primary nodes.

See Also:

CacheAffinityFunction, CacheConfiguration.getAffinity(), CacheConfiguration.setAffinity(CacheAffinityFunction)

affinityKey

public Object affinityKey(K key)

Maps passed in key to a key which will be used for node affinity. The affinity key may be different from actual key if some field in the actual key was designated for affinity mapping via CacheAffinityKeyMapped annotation or if a custom CacheAffinityKeyMapper was configured.

Specified by:

affinityKey in interface CacheAffinity<K>

Parameters:

key - Key to map.

Returns:

Key to be used for node-to-affinity mapping (may be the same key as passed in).

mapKeyToNode

@Nullable
public ClusterNode mapKeyToNode(K key)

This method provides ability to detect to which primary node the given key is mapped. Use it to determine which nodes are storing which keys prior to sending jobs that access these keys.

This method works as following:

• For local caches it returns only local node ID.
• For fully replicated caches first node ID returned by CacheAffinityFunction is returned.
• For partitioned caches, primary node for the given key is returned.

Specified by:

mapKeyToNode in interface CacheAffinity<K>

Parameters:

key - Keys to map to a node.

Returns:

Primary node for the key or null if there are no alive nodes for this cache.

mapKeysToNodes

public Map<ClusterNode,Collection<K>> mapKeysToNodes(@Nullable
                                            Collection<? extends K> keys)

This method provides ability to detect which keys are mapped to which nodes. Use it to determine which nodes are storing which keys prior to sending jobs that access these keys.

This method works as following:

• For local caches it returns only local node mapped to all keys.
• For fully replicated caches CacheAffinityFunction is used to determine which keys are mapped to which nodes.
• For partitioned caches, the returned map represents node-to-key affinity.

Specified by:

mapKeysToNodes in interface CacheAffinity<K>

Parameters:

keys - Keys to map to nodes.

Returns:

Map of nodes to keys or empty map if there are no alive nodes for this cache.

mapKeyToPrimaryAndBackups

public Collection<ClusterNode> mapKeyToPrimaryAndBackups(K key)

Gets primary and backup nodes for the key. Note that primary node is always first in the returned collection.

If there are only cache nodes in the projection with CacheConfiguration.getDistributionMode() property set to NEAR_ONLY, then this method will return an empty collection.

Specified by:

mapKeyToPrimaryAndBackups in interface CacheAffinity<K>

Parameters:

key - Key to get affinity nodes for.

Returns:

Collection of primary and backup nodes for the key with primary node always first, or an empty collection if this projection contains only nodes with CacheConfiguration.getDistributionMode() property set to NEAR_ONLY.

mapPartitionToPrimaryAndBackups

public Collection<ClusterNode> mapPartitionToPrimaryAndBackups(int part)

Gets primary and backup nodes for partition. Note that primary node is always first in the returned collection.

If there are only cache nodes in the projection with CacheConfiguration.getDistributionMode() property set to NEAR_ONLY, then this method will return an empty collection.

Specified by:

mapPartitionToPrimaryAndBackups in interface CacheAffinity<K>

Parameters:

part - Partition to get affinity nodes for.

Returns:

Collection of primary and backup nodes for partition with primary node always first, or an empty collection if this projection contains only nodes with CacheConfiguration.getDistributionMode() property set to NEAR_ONLY.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException