com.basho.riak.client.core

Class RiakCluster.Builder

java.lang.Object

com.basho.riak.client.core.RiakCluster.Builder

Enclosing class:

RiakCluster

public static class RiakCluster.Builder
extends Object

Builder used to create RiakCluster instances.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_EXECUTION_ATTEMPTS
static int	DEFAULT_OPERATION_QUEUE_DEPTH

Constructor Summary

Constructors

Constructor and Description
Builder(Collection<HostAndPort> remoteHosts, RiakNode.Builder nodeBuilder) Instantiate a Builder containing the RiakNodes that will be build by using provided builder.
Builder(List<RiakNode> riakNodes) Instantiate a Builder containing the supplied RiakNodes
Builder(RiakNode.Builder nodeBuilder, List<String> remoteAddresses) Instantiate a Builder containing the RiakNodes that will be build by using provided builder.
Builder(RiakNode.Builder nodeBuilder, String... remoteAddresses) Instantiate a Builder containing the RiakNodes that will be build by using provided builder.
Builder(RiakNode node) Instantiate a Builder containing a single RiakNode

Method Summary

Modifier and Type	Method and Description
RiakCluster	build() Instantiates the RiakCluster
RiakCluster.Builder	withBootstrap(io.netty.bootstrap.Bootstrap bootstrap) The Netty Bootstrap this cluster will use.
RiakCluster.Builder	withExecutionAttempts(int numberOfAttempts) Sets the number of times the RiakCluster will attempt an operation before returning it as failed.
RiakCluster.Builder	withExecutor(ScheduledExecutorService executor) Sets the Threadpool for this cluster.
RiakCluster.Builder	withNodeManager(NodeManager nodeManager) Sets the NodeManager for this RiakCluster If none is provided the DefaultNodeManager will be used
RiakCluster.Builder	withOperationQueueMaxDepth(int operationQueueMaxDepth) Set the maximum number of operations to queue.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXECUTION_ATTEMPTS

public static final int DEFAULT_EXECUTION_ATTEMPTS

See Also:

Constant Field Values

DEFAULT_OPERATION_QUEUE_DEPTH

public static final int DEFAULT_OPERATION_QUEUE_DEPTH

See Also:

Constant Field Values

Constructor Detail

Builder

public Builder(List<RiakNode> riakNodes)

Instantiate a Builder containing the supplied RiakNodes

Parameters:

riakNodes - - a List of unstarted RiakNode objects

Builder

public Builder(RiakNode.Builder nodeBuilder,
               List<String> remoteAddresses)
        throws UnknownHostException

Instantiate a Builder containing the RiakNodes that will be build by using provided builder. The RiakNode.Builder is used for setting common properties among the nodes.

Throws:

UnknownHostException

Since:

2.0.3

See Also:

RiakNode.Builder.buildNodes(RiakNode.Builder, List)

Builder

public Builder(Collection<HostAndPort> remoteHosts,
               RiakNode.Builder nodeBuilder)
        throws UnknownHostException

Instantiate a Builder containing the RiakNodes that will be build by using provided builder. The RiakNode.Builder is used for setting common properties among the nodes.

Throws:

UnknownHostException

Since:

2.0.6

See Also:

RiakNode.Builder.buildNodes(Collection, RiakNode.Builder)

Builder

public Builder(RiakNode.Builder nodeBuilder,
               String... remoteAddresses)
        throws UnknownHostException

Instantiate a Builder containing the RiakNodes that will be build by using provided builder. The RiakNode.Builder is used for setting common properties among the nodes.

Throws:

UnknownHostException

Since:

2.0.3

See Also:

RiakNode.Builder.buildNodes(RiakNode.Builder, String...)

Builder

public Builder(RiakNode node)

Instantiate a Builder containing a single RiakNode

Parameters:

node -

Method Detail

withExecutionAttempts

public RiakCluster.Builder withExecutionAttempts(int numberOfAttempts)

Sets the number of times the RiakCluster will attempt an operation before returning it as failed.

Parameters:

numberOfAttempts -

Returns:

this

withNodeManager

public RiakCluster.Builder withNodeManager(NodeManager nodeManager)

Sets the NodeManager for this RiakCluster If none is provided the DefaultNodeManager will be used

Parameters:

nodeManager -

Returns:

this

withExecutor

public RiakCluster.Builder withExecutor(ScheduledExecutorService executor)

Sets the Threadpool for this cluster. This threadpool is passed down to the RiakNodes. At the very least it needs to have two threads available. It is not necessary to supply your own as the RiakCluster will instantiate one upon construction if this is not asSet.

Parameters:

executor -

Returns:

this

withBootstrap

public RiakCluster.Builder withBootstrap(io.netty.bootstrap.Bootstrap bootstrap)

The Netty Bootstrap this cluster will use. This Bootstrap is passed down to the RiakNodes. It is not necessary to supply your own as the RiakCluster will instantiate one upon construction if this is not asSet.

Parameters:

bootstrap -

Returns:

this

withOperationQueueMaxDepth

public RiakCluster.Builder withOperationQueueMaxDepth(int operationQueueMaxDepth)

Set the maximum number of operations to queue. A value of 0 disables the command queue. Setting this will override any of this clusters @{link RiakNode}s blockOnMaxConnection settings.

Please note that while using the Operation Queue, operations may be executed out of the order that they were added in.

Parameters:

operationQueueMaxDepth - - maximum number of operations to queue if all connections are busy

Returns:

this

See Also:

DEFAULT_OPERATION_QUEUE_DEPTH

build

public RiakCluster build()

Instantiates the RiakCluster

Returns:

a new RiakCluster