com.couchbase.client.vbucket

Class VBucketNodeLocator

java.lang.Object

net.spy.memcached.compat.SpyObject

com.couchbase.client.vbucket.VBucketNodeLocator

All Implemented Interfaces:

net.spy.memcached.NodeLocator

public class VBucketNodeLocator
extends net.spy.memcached.compat.SpyObject
implements net.spy.memcached.NodeLocator

Implementation of the NodeLocator interface that contains vbucket hashing methods.

Constructor Summary

Constructors

Constructor and Description
VBucketNodeLocator(java.util.List<net.spy.memcached.MemcachedNode> nodes, Config jsonConfig) Construct a VBucketNodeLocator over the given JSON configuration string.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<net.spy.memcached.MemcachedNode>	getAll()
net.spy.memcached.MemcachedNode	getAlternative(java.lang.String k, java.util.Collection<net.spy.memcached.MemcachedNode> notMyVbucketNodes) Method returns the node that is not contained in the specified collection of the failed nodes.
net.spy.memcached.MemcachedNode	getPrimary(java.lang.String k)
net.spy.memcached.NodeLocator	getReadonlyCopy()
net.spy.memcached.MemcachedNode	getReplica(java.lang.String key, int index) Return a replica node for the given key and replica index.
java.util.List<java.lang.Integer>	getReplicaIndexes(java.lang.String key) Gets a list of vBucket indexes for the current replicas defined.
java.util.Iterator<net.spy.memcached.MemcachedNode>	getSequence(java.lang.String k)
net.spy.memcached.MemcachedNode	getServerByIndex(int k)
int	getVBucketIndex(java.lang.String key) Returns a vbucket index for the given key.
boolean	hasActiveMaster(java.lang.String key) Checks if in the current vbucket the master is not "-1".
void	updateLocator(java.util.Collection<net.spy.memcached.MemcachedNode> nodes, Config newconf)
void	updateLocator(java.util.List<net.spy.memcached.MemcachedNode> nodes)

Methods inherited from class net.spy.memcached.compat.SpyObject

getLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

VBucketNodeLocator

public VBucketNodeLocator(java.util.List<net.spy.memcached.MemcachedNode> nodes,
                          Config jsonConfig)

Construct a VBucketNodeLocator over the given JSON configuration string.

Parameters:

nodes -

jsonConfig -

Method Detail

getPrimary

public net.spy.memcached.MemcachedNode getPrimary(java.lang.String k)

Specified by:

getPrimary in interface net.spy.memcached.NodeLocator

getReplica

public net.spy.memcached.MemcachedNode getReplica(java.lang.String key,
                                                  int index)

Return a replica node for the given key and replica index. Based on the ReplicaIndex ID given, this method calculates the replica node. It works similar to the getMaster method, but has the additional capability to find the node based on the given replica index.

Parameters:

key - the key to find the node for.

index - the Nth replica number

Returns:

the node where the given replica exists

Throws:

java.lang.RuntimeException - when no replica is defined for the given key

getServerByIndex

public net.spy.memcached.MemcachedNode getServerByIndex(int k)

getSequence

public java.util.Iterator<net.spy.memcached.MemcachedNode> getSequence(java.lang.String k)

Specified by:

getSequence in interface net.spy.memcached.NodeLocator

getAll

public java.util.Collection<net.spy.memcached.MemcachedNode> getAll()

Specified by:

getAll in interface net.spy.memcached.NodeLocator

getReadonlyCopy

public net.spy.memcached.NodeLocator getReadonlyCopy()

Specified by:

getReadonlyCopy in interface net.spy.memcached.NodeLocator

updateLocator

public void updateLocator(java.util.List<net.spy.memcached.MemcachedNode> nodes)

Specified by:

updateLocator in interface net.spy.memcached.NodeLocator

updateLocator

public void updateLocator(java.util.Collection<net.spy.memcached.MemcachedNode> nodes,
                          Config newconf)

getVBucketIndex

public int getVBucketIndex(java.lang.String key)

Returns a vbucket index for the given key.

Parameters:

key - the key

Returns:

vbucket index

getAlternative

public net.spy.memcached.MemcachedNode getAlternative(java.lang.String k,
                                                      java.util.Collection<net.spy.memcached.MemcachedNode> notMyVbucketNodes)

Method returns the node that is not contained in the specified collection of the failed nodes.

Parameters:

k - the key

notMyVbucketNodes - a collection of the nodes are excluded

Returns:

The first MemcachedNode which meets requirements

getReplicaIndexes

public java.util.List<java.lang.Integer> getReplicaIndexes(java.lang.String key)

Gets a list of vBucket indexes for the current replicas defined. This method helps in identifying the actual current replicas because during a rebalance or failover scenario this list can differ from the actual config setting in the bucket.

Parameters:

key - the key to check for.

Returns:

a list of currently usable replica indexes.

hasActiveMaster

public boolean hasActiveMaster(java.lang.String key)

Checks if in the current vbucket the master is not "-1".

Parameters:

key - the key to check for.

Returns:

true if there is a master assigned for the key.