com.basho.riak.client.core

Class RiakCluster

java.lang.Object

com.basho.riak.client.core.RiakCluster

All Implemented Interfaces:

NodeStateListener, OperationRetrier

public class RiakCluster
extends Object
implements OperationRetrier, NodeStateListener

A modeled Riak Cluster.

This class represents a Riak Cluster upon which operations are executed. Instances are created using the RiakCluster.Builder

Since:

2.0

Author:

Brian Roach , Sergey Galkin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RiakCluster.Builder Builder used to create RiakCluster instances.

Method Summary

Modifier and Type	Method and Description
void	addNode(RiakNode node) Adds a RiakNode to this cluster.
static RiakCluster.Builder	builder(List<RiakNode> nodes)
static RiakCluster.Builder	builder(RiakNode node)
void	cleanup() Cleans up any Thread-Local variables after shutdown.
<V,S> RiakFuture<V,S>	execute(FutureOperation<V,?,S> operation)
<V,S> StreamingRiakFuture<V,S>	execute(PBStreamingFutureOperation<V,?,S> operation)
List<RiakNode>	getNodes() Returns a copy of the list of nodes in this cluster.
void	nodeStateChanged(RiakNode node, RiakNode.State state)
void	operationComplete(FutureOperation operation, int remainingRetries)
void	operationFailed(FutureOperation operation, int remainingRetries)
void	registerNodeStateListener(NodeStateListener listener) Register a NodeStateListener.
boolean	removeNode(RiakNode node) Removes the provided node from the cluster.
void	removeNodeStateListener(NodeStateListener listener) Remove a NodeStateListener.
Future<Boolean>	shutdown()
void	start()

Methods inherited from class java.lang.Object

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

Method Detail

start

public void start()

shutdown

public Future<Boolean> shutdown()

execute

public <V,S> RiakFuture<V,S> execute(FutureOperation<V,?,S> operation)

execute

public <V,S> StreamingRiakFuture<V,S> execute(PBStreamingFutureOperation<V,?,S> operation)

addNode

public void addNode(RiakNode node)
             throws UnknownHostException

Adds a RiakNode to this cluster. The node can not have been started nor have its Bootstrap or Executor asSet. The node will be started as part of this process.

Parameters:

node - the RiakNode to add

Throws:

UnknownHostException - if the RiakNode's hostname cannot be resolved

IllegalArgumentException - if the node's Bootstrap or Executor are already asSet.

removeNode

public boolean removeNode(RiakNode node)

Removes the provided node from the cluster.

Parameters:

node -

Returns:

true if the node was in the cluster, false otherwise.

getNodes

public List<RiakNode> getNodes()

Returns a copy of the list of nodes in this cluster.

Returns:

A copy of the list of RiakNodes

nodeStateChanged

public void nodeStateChanged(RiakNode node,
                             RiakNode.State state)

Specified by:

nodeStateChanged in interface NodeStateListener

operationFailed

public void operationFailed(FutureOperation operation,
                            int remainingRetries)

Specified by:

operationFailed in interface OperationRetrier

operationComplete

public void operationComplete(FutureOperation operation,
                              int remainingRetries)

Specified by:

operationComplete in interface OperationRetrier

registerNodeStateListener

public void registerNodeStateListener(NodeStateListener listener)

Register a NodeStateListener.

Any state change by any of the nodes in the cluster will be sent to the registered NodeStateListener.

When registering, the current state of all the nodes is sent to the listener.

Parameters:

listener - The NodeStateListener to register.

removeNodeStateListener

public void removeNodeStateListener(NodeStateListener listener)

Remove a NodeStateListener.

The supplied NodeStateListener will be unregistered and no longer receive state updates.

Parameters:

listener - The NodeStateListener to unregister.

builder

public static RiakCluster.Builder builder(List<RiakNode> nodes)

builder

public static RiakCluster.Builder builder(RiakNode node)

cleanup

public void cleanup()

Cleans up any Thread-Local variables after shutdown. This operation is useful when you are in a container environment, and you do not want to leave the thread local variables in the threads you do not manage. Call this method when your application is being unloaded from the container, after all RiakNode, RiakCluster, and RiakClient objects are in the shutdown state.