com.basho.riak.client.core

Class RiakNode.Builder

java.lang.Object

com.basho.riak.client.core.RiakNode.Builder

Enclosing class:

RiakNode

public static class RiakNode.Builder
extends Object

Builder used to construct a RiakNode.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONNECTION_TIMEOUT The default connection timeout in milliseconds if not specified: 0
static HealthCheckFactory	DEFAULT_HEALTHCHECK_FACTORY The default HealthCheckFactory.
static int	DEFAULT_IDLE_TIMEOUT The default idle timeout in milliseconds for connections if not specified: 1000
static int	DEFAULT_MAX_CONNECTIONS The default maximum number of connections allowed if not specified: 0
static int	DEFAULT_MIN_CONNECTIONS The default minimum number of connections to maintain if not specified: 1
static String	DEFAULT_REMOTE_ADDRESS The default remote address to be used if not specified: "127.0.0.1"
static int	DEFAULT_REMOTE_PORT The default port number to be used if not specified: 8087

Constructor Summary

Constructors

Constructor and Description
Builder() Default constructor.

Method Summary

Modifier and Type	Method and Description
RiakNode	build() Builds a RiakNode.
static List<RiakNode>	buildNodes(Collection<HostAndPort> remoteHosts, RiakNode.Builder builder) Build a set of RiakNodes.
static List<RiakNode>	buildNodes(RiakNode.Builder builder, List<String> remoteAddresses) Build a set of RiakNodes.
static List<RiakNode>	buildNodes(RiakNode.Builder builder, String... remoteAddresses) Build a set of RiakNodes.
RiakNode.Builder	withAuth(String username, String password, KeyStore trustStore) Set the credentials for Riak security and authentication.
RiakNode.Builder	withAuth(String username, String password, KeyStore trustStore, KeyStore keyStore, String keyPassword) Set the credentials for Riak security and authentication.
RiakNode.Builder	withBlockOnMaxConnections(boolean block) Set whether to block if all connections are in use.
RiakNode.Builder	withBootstrap(io.netty.bootstrap.Bootstrap bootstrap) Provides a Netty Bootstrap for this node to use.
RiakNode.Builder	withConnectionTimeout(int connectionTimeoutInMillis) Set the connection timeout used when making new connections
RiakNode.Builder	withExecutor(ScheduledExecutorService executor) Provides an executor for this node to use for internal maintenance tasks.
RiakNode.Builder	withHealthCheck(HealthCheckFactory factory) Set the HealthCheckFactory used to determine if this RiakNode is healthy.
RiakNode.Builder	withIdleTimeout(int idleTimeoutInMillis) Set the idle timeout used to reap inactive connections.
RiakNode.Builder	withMaxConnections(int maxConnections) Set the maximum number of connections allowed.
RiakNode.Builder	withMinConnections(int minConnections) Set the minimum number of active connections to maintain.
RiakNode.Builder	withRemoteAddress(HostAndPort hp) Specifies the remote host and remote port for this RiakNode.
RiakNode.Builder	withRemoteAddress(String remoteAddress) Sets the remote address for this RiakNode.
RiakNode.Builder	withRemoteHost(HostAndPort hostAndPOrt) Sets the remote host and port for this RiakNode.
RiakNode.Builder	withRemotePort(int port) Specifies the remote port for this RiakNode.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REMOTE_ADDRESS

public static final String DEFAULT_REMOTE_ADDRESS

The default remote address to be used if not specified: "127.0.0.1"

See Also:

withRemoteAddress(java.lang.String), Constant Field Values

DEFAULT_REMOTE_PORT

public static final int DEFAULT_REMOTE_PORT

The default port number to be used if not specified: 8087

See Also:

withRemotePort(int), Constant Field Values

DEFAULT_MIN_CONNECTIONS

public static final int DEFAULT_MIN_CONNECTIONS

The default minimum number of connections to maintain if not specified: 1

See Also:

withMinConnections(int), Constant Field Values

DEFAULT_MAX_CONNECTIONS

public static final int DEFAULT_MAX_CONNECTIONS

The default maximum number of connections allowed if not specified: 0

See Also:

withMaxConnections(int), Constant Field Values

DEFAULT_IDLE_TIMEOUT

public static final int DEFAULT_IDLE_TIMEOUT

The default idle timeout in milliseconds for connections if not specified: 1000

See Also:

withIdleTimeout(int), Constant Field Values

DEFAULT_CONNECTION_TIMEOUT

public static final int DEFAULT_CONNECTION_TIMEOUT

The default connection timeout in milliseconds if not specified: 0

See Also:

withConnectionTimeout(int), Constant Field Values

DEFAULT_HEALTHCHECK_FACTORY

public static final HealthCheckFactory DEFAULT_HEALTHCHECK_FACTORY

The default HealthCheckFactory.

By default this is the PingHealthCheck

See Also:

HealthCheckFactory, HealthCheckDecoder

Constructor Detail

Builder

public Builder()

Default constructor. Returns a new builder for a RiakNode with default values set.

Method Detail

withRemoteHost

public RiakNode.Builder withRemoteHost(HostAndPort hostAndPOrt)

Sets the remote host and port for this RiakNode.

Parameters:

hostAndPOrt -

Returns:

this

withRemoteAddress

public RiakNode.Builder withRemoteAddress(String remoteAddress)

Sets the remote address for this RiakNode.

Parameters:

remoteAddress - Can either be a FQDN or IP address. Since 2.0.3 it may contain port delimited by ':'.

Returns:

this

See Also:

DEFAULT_REMOTE_ADDRESS

withRemotePort

public RiakNode.Builder withRemotePort(int port)

Specifies the remote port for this RiakNode.

Parameters:

port - - the port

Returns:

this

See Also:

DEFAULT_REMOTE_PORT

withRemoteAddress

public RiakNode.Builder withRemoteAddress(HostAndPort hp)

Specifies the remote host and remote port for this RiakNode.

Parameters:

hp - - host and port

Returns:

this

Since:

2.0.3

See Also:

DEFAULT_REMOTE_PORT, HostAndPort

withMinConnections

public RiakNode.Builder withMinConnections(int minConnections)

Set the minimum number of active connections to maintain. These connections are exempt from the idle timeout.

Parameters:

minConnections - - number of connections to maintain.

Returns:

this

See Also:

DEFAULT_MIN_CONNECTIONS

withMaxConnections

public RiakNode.Builder withMaxConnections(int maxConnections)

Set the maximum number of connections allowed. A value of 0 sets this to unlimited.

Parameters:

maxConnections - - maximum number of connections to allow

Returns:

this

See Also:

DEFAULT_MAX_CONNECTIONS

withIdleTimeout

public RiakNode.Builder withIdleTimeout(int idleTimeoutInMillis)

Set the idle timeout used to reap inactive connections. Any connection that has been idle for this amount of time becomes eligible to be closed and discarded unless minConnections has been set via withMinConnections(int)

Parameters:

idleTimeoutInMillis - - idle timeout in milliseconds

Returns:

this

See Also:

DEFAULT_IDLE_TIMEOUT

withConnectionTimeout

public RiakNode.Builder withConnectionTimeout(int connectionTimeoutInMillis)

Set the connection timeout used when making new connections

Parameters:

connectionTimeoutInMillis -

Returns:

this

See Also:

DEFAULT_CONNECTION_TIMEOUT

withExecutor

public RiakNode.Builder withExecutor(ScheduledExecutorService executor)

Provides an executor for this node to use for internal maintenance tasks. If not provided one will be created via Executors.newSingleThreadScheduledExecutor()

Parameters:

executor - the ScheduledExecutorService to use.

Returns:

this

withBootstrap

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

Provides a Netty Bootstrap for this node to use. If not provided one will be created with its own NioEventLoopGroup.

Parameters:

bootstrap -

Returns:

this

withBlockOnMaxConnections

public RiakNode.Builder withBlockOnMaxConnections(boolean block)

Set whether to block if all connections are in use.

If a maximum number of connections is specified and all those connections are in use, the default behavior when an operation is submitted to a node is to fail-fast and return. Setting this to true will cause the call to block (fair-scheduled, FIFO) until a connection becomes available.

Parameters:

block - whether to block when an operation is submitted and all connections are in use.

Returns:

this

withAuth

public RiakNode.Builder withAuth(String username,
                                 String password,
                                 KeyStore trustStore)

Set the credentials for Riak security and authentication.

Riak supports authentication and authorization features. These credentials will be used for all connections.

Note this requires Riak to have been configured with security enabled.

Parameters:

username - the riak user name.

password - the password for this user.

trustStore - A Java KeyStore loaded with the CA certificate required for TLS/SSL

Returns:

a reference to this object.

withAuth

public RiakNode.Builder withAuth(String username,
                                 String password,
                                 KeyStore trustStore,
                                 KeyStore keyStore,
                                 String keyPassword)

Set the credentials for Riak security and authentication.

Riak supports authentication and authorization features. These credentials will be used for all connections.

Note this requires Riak to have been configured with security enabled.

Parameters:

username - the riak user name.

password - the password for this user.

trustStore - A Java KeyStore loaded with the CA certificate required for TLS/SSL

keyStore - A Java KeyStore loaded with User's Private certificate required for TLS/SSL

keyPassword - the password for User's Private certificate.

Returns:

a reference to this object.

withHealthCheck

public RiakNode.Builder withHealthCheck(HealthCheckFactory factory)

Set the HealthCheckFactory used to determine if this RiakNode is healthy.

If not set the PingHealthCheck is used.

Parameters:

factory - a HealthCheckFactory instance that produces HealthCheckDecoders

Returns:

a reference to this object.

See Also:

HealthCheckDecoder

build

public RiakNode build()

Builds a RiakNode. If a Netty Bootstrap and/or a ScheduledExecutorService has not been provided they will be created.

Returns:

a new Riaknode

buildNodes

public static List<RiakNode> buildNodes(RiakNode.Builder builder,
                                        List<String> remoteAddresses)

Build a set of RiakNodes. The provided builder will be used to construct a set of RiakNodes using the supplied addresses.

Parameters:

builder - a configured builder, used for common properties among the nodes

remoteAddresses - a list of IP addresses or FQDN. Since 2.0.3 each of list item is treated as a comma separated list of FQDN or IP addresses with the optional remote port delimited by ':'.

Returns:

a list of constructed RiakNodes

buildNodes

public static List<RiakNode> buildNodes(Collection<HostAndPort> remoteHosts,
                                        RiakNode.Builder builder)

Build a set of RiakNodes. The provided builder will be used to construct a set of RiakNodes using the supplied hosts.

Parameters:

remoteHosts - a list of hosts w/wo ports.

builder - a configured builder, used for common properties among the nodes

Returns:

a list of constructed RiakNodes

Since:

2.0.6

buildNodes

public static List<RiakNode> buildNodes(RiakNode.Builder builder,
                                        String... remoteAddresses)
                                 throws UnknownHostException

Build a set of RiakNodes. The provided builder will be used to construct a set of RiakNodes using the supplied addresses.

Throws:

UnknownHostException

Since:

2.0.3

See Also:

buildNodes(RiakNode.Builder, List)