RiakNode (Riak Client for Java 2.1.1 API)

java.lang.Object
- com.basho.riak.client.core.RiakNode

All Implemented Interfaces:

RiakResponseListener
```
public class RiakNode
extends Object
implements RiakResponseListener
```
Since:

2.0

Author:

Brian Roach , Sergey Galkin , Alex Moore

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RiakNode.Builder
Builder used to construct a RiakNode.

static class RiakNode.State

Nested Classes
Modifier and Type	Class and Description
`static class`	`RiakNode.Builder` Builder used to construct a RiakNode.
`static class`	`RiakNode.State`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addStateListener(NodeStateListener listener)`
`int`	`availablePermits()` Returns the number of permits currently available.
`boolean`	`execute(FutureOperation operation)` Submits the operation to be executed on this node.
`boolean`	`getBlockOnMaxConnections()` Returns if this node is set to block when all connections are in use.
`int`	`getConnectionTimeout()` Returns the connection timeout in milliseconds.
`int`	`getIdleTimeout()` Returns the connection idle timeout for connections in milliseconds.
`int`	`getMaxConnections()` Returns the maximum number of connections allowed.
`int`	`getMinConnections()` Returns the current minimum number of active connections to be maintained.
`RiakNode.State`	`getNodeState()` Returns the current state of this node.
`int`	`getPort()` returns the remote port for this RiakNode
`String`	`getRemoteAddress()` Returns the `remoteAddress` for this RiakNode
`void`	`onException(io.netty.channel.Channel channel, Throwable t)`
`void`	`onRiakErrorResponse(io.netty.channel.Channel channel, RiakResponseException ex)`
`void`	`onSuccess(io.netty.channel.Channel channel, RiakMessage response)`
`boolean`	`removeStateListener(NodeStateListener listener)`
`void`	`setBlockOnMaxConnections(boolean block)` Set whether to block when all connections are in use.
`RiakNode`	`setBootstrap(io.netty.bootstrap.Bootstrap bootstrap)` Sets the Netty `Bootstrap` for this Node's connections.
`RiakNode`	`setConnectionTimeout(int connectionTimeoutInMillis)` Sets the connection timeout for new connections.
`RiakNode`	`setExecutor(ScheduledExecutorService executor)` Sets the `ScheduledExecutorService` for this Node and its pool(s).
`RiakNode`	`setIdleTimeout(int idleTimeoutInMillis)` Sets the connection idle timeout for connections.
`RiakNode`	`setMaxConnections(int maxConnections)` Sets the maximum number of connections allowed.
`RiakNode`	`setMinConnections(int minConnections)` Sets the minimum number of active connections to be maintained.
`Future<Boolean>`	`shutdown()`
`RiakNode`	`start()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - start
```
public RiakNode start()
               throws UnknownHostException
```
    Throws:
    
    UnknownHostException
  - shutdown
```
public Future<Boolean> shutdown()
```
  - setBootstrap
```
public RiakNode setBootstrap(io.netty.bootstrap.Bootstrap bootstrap)
```
    Sets the Netty Bootstrap for this Node's connections. Bootstrap.clone() is called to clone the bootstrap.
    
    Parameters:
    
    bootstrap - - the Netty Bootstrap to use
    
    Returns:
    
    a reference to this RiakNode
    
    Throws:
    
    IllegalArgumentException - if it was already set via the builder.
    
    IllegalStateException - if the node has already been started.
    
    See Also:
    
    RiakNode.Builder.withBootstrap(io.netty.bootstrap.Bootstrap)
  - setExecutor
```
public RiakNode setExecutor(ScheduledExecutorService executor)
```
    Sets the ScheduledExecutorService for this Node and its pool(s).
    
    Parameters:
    
    executor - - the ScheduledExecutorService to use.
    
    Returns:
    
    a reference to this RiakNode
    
    Throws:
    
    IllegalArgumentException - if it was already set via the builder.
    
    IllegalStateException - if the node has already been started.
    
    See Also:
    
    RiakNode.Builder.withExecutor(java.util.concurrent.ScheduledExecutorService)
  - setMaxConnections
```
public RiakNode setMaxConnections(int maxConnections)
```
    Sets the maximum number of connections allowed.
    
    Parameters:
    
    maxConnections - the maxConnections to set.
    
    Returns:
    
    a reference to this RiakNode.
    
    See Also:
    
    RiakNode.Builder.withMaxConnections(int)
  - getMaxConnections
```
public int getMaxConnections()
```
    Returns the maximum number of connections allowed.
    
    Returns:
    
    the maxConnections
    
    See Also:
    
    RiakNode.Builder.withMaxConnections(int)
  - setMinConnections
```
public RiakNode setMinConnections(int minConnections)
```
    Sets the minimum number of active connections to be maintained.
    
    Parameters:
    
    minConnections - the minConnections to set
    
    Returns:
    
    a reference to this RiakNode
    
    See Also:
    
    RiakNode.Builder.withMinConnections(int)
  - getMinConnections
```
public int getMinConnections()
```
    Returns the current minimum number of active connections to be maintained.
    
    Returns:
    
    the minConnections
    
    See Also:
    
    RiakNode.Builder.withMinConnections(int)
  - setBlockOnMaxConnections
```
public void setBlockOnMaxConnections(boolean block)
```
    Set whether to block when all connections are in use.
    
    Parameters:
    
    block - true to block.
    
    See Also:
    
    RiakNode.Builder.withBlockOnMaxConnections(boolean)
  - getBlockOnMaxConnections
```
public boolean getBlockOnMaxConnections()
```
    Returns if this node is set to block when all connections are in use.
    
    Returns:
    
    true if set to block, false otherwise.
    
    See Also:
    
    RiakNode.Builder.withBlockOnMaxConnections(boolean)
  - setIdleTimeout
```
public RiakNode setIdleTimeout(int idleTimeoutInMillis)
```
    Sets the connection idle timeout for connections.
    
    Parameters:
    
    idleTimeoutInMillis - the idleTimeout to set
    
    Returns:
    
    a reference to this RiakNode
    
    See Also:
    
    RiakNode.Builder.withIdleTimeout(int)
  - getIdleTimeout
```
public int getIdleTimeout()
```
    Returns the connection idle timeout for connections in milliseconds.
    
    Returns:
    
    the idleTimeout in milliseconds
    
    See Also:
    
    RiakNode.Builder.withIdleTimeout(int)
  - setConnectionTimeout
```
public RiakNode setConnectionTimeout(int connectionTimeoutInMillis)
```
    Sets the connection timeout for new connections.
    
    Parameters:
    
    connectionTimeoutInMillis - the connectionTimeout to set
    
    Returns:
    
    a reference to this RiakNode
    
    See Also:
    
    RiakNode.Builder.withConnectionTimeout(int)
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    Returns the connection timeout in milliseconds.
    
    Returns:
    
    the connectionTimeout
    
    See Also:
    
    RiakNode.Builder.withConnectionTimeout(int)
  - availablePermits
```
public int availablePermits()
```
    Returns the number of permits currently available. The number of available permits indicates how many additional connections can be made without blocking.
    
    Returns:
    
    the number of available permits.
    
    See Also:
    
    RiakNode.Builder.withMaxConnections(int)
  - addStateListener
```
public void addStateListener(NodeStateListener listener)
```
  - removeStateListener
```
public boolean removeStateListener(NodeStateListener listener)
```
  - execute
```
public boolean execute(FutureOperation operation)
```
    Submits the operation to be executed on this node.
    
    Parameters:
    
    operation - The operation to perform
    
    Returns:
    
    true if this operation was accepted, false if there were no available connections.
    
    Throws:
    
    IllegalStateException - if this node is not in the RUNNING or HEALTH_CHECKING state
    
    IllegalArgumentException - if the protocol required for the operation is not supported by this node
  - onSuccess
```
public void onSuccess(io.netty.channel.Channel channel,
                      RiakMessage response)
```
    Specified by:
    
    onSuccess in interface RiakResponseListener
  - onRiakErrorResponse
```
public void onRiakErrorResponse(io.netty.channel.Channel channel,
                                RiakResponseException ex)
```
    Specified by:
    
    onRiakErrorResponse in interface RiakResponseListener
  - onException
```
public void onException(io.netty.channel.Channel channel,
                        Throwable t)
```
    Specified by:
    
    onException in interface RiakResponseListener
  - getRemoteAddress
```
public String getRemoteAddress()
```
    Returns the remoteAddress for this RiakNode
    
    Returns:
    
    The IP address or FQDN as a String
  - getPort
```
public int getPort()
```
    returns the remote port for this RiakNode
    
    Returns:
    
    the port number
  - getNodeState
```
public RiakNode.State getNodeState()
```
    Returns the current state of this node.
    
    Returns:
    
    The state

Class RiakNode

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

start

shutdown

setBootstrap

setExecutor

setMaxConnections

getMaxConnections

setMinConnections

getMinConnections

setBlockOnMaxConnections

getBlockOnMaxConnections

setIdleTimeout

getIdleTimeout

setConnectionTimeout

getConnectionTimeout

availablePermits

addStateListener

removeStateListener

execute

onSuccess

onRiakErrorResponse

onException

getRemoteAddress

getPort

getNodeState