com.couchbase.client

Class ClusterManager

java.lang.Object

net.spy.memcached.compat.SpyObject

com.couchbase.client.ClusterManager

public class ClusterManager
extends net.spy.memcached.compat.SpyObject

A client to perform cluster-wide operations over the HTTP REST API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterManager.HttpResult Value Object to aggregate a raw response message.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONN_TIMEOUT The default connection timeout in milliseconds.
static int	DEFAULT_CONNS_PER_NODE The default number fo max.
static int	DEFAULT_IO_THREADS The default number of IO (worker) threads to use.
static int	DEFAULT_SOCKET_TIMEOUT The default socket timeout in milliseconds.
static boolean	DEFAULT_TCP_NODELAY By default, enable tcp nodelay.

Constructor Summary

Constructors

Constructor and Description
ClusterManager(java.util.List<java.net.URI> nodes, java.lang.String username, java.lang.String password) Create a new ClusterManager instance.
ClusterManager(java.util.List<java.net.URI> nodes, java.lang.String username, java.lang.String password, int connectionTimeout, int socketTimeout, boolean tcpNoDelay, int ioThreadCount, int connectionsPerNode) Create a new ClusterManager instance.

Method Summary

Modifier and Type	Method and Description
void	createDefaultBucket(BucketType type, int memorySizeMB, int replicas, boolean flushEnabled) Creates the default bucket.
void	createNamedBucket(BucketType type, java.lang.String name, int memorySizeMB, int replicas, java.lang.String authPassword, boolean flushEnabled) Creates a named bucket with a given password for SASL authentication.
void	createPortBucket(BucketType type, java.lang.String name, int memorySizeMB, int replicas, int port, boolean flush) Creates the a sasl bucket.
void	deleteBucket(java.lang.String name) Deletes a bucket.
FlushResponse	flushBucket(java.lang.String name) Deletes all data in a bucket.
java.util.List<java.lang.String>	listBuckets() Lists all buckets in a Couchbase cluster.
boolean	shutdown() Shutdown the ClusterManager.
void	updateBucket(java.lang.String name, int memorySizeMB, AuthType authType, int replicas, int port, java.lang.String authpassword, boolean flushEnabled) Update a bucket with the new settings.

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

Field Detail

DEFAULT_CONN_TIMEOUT

public static final int DEFAULT_CONN_TIMEOUT

The default connection timeout in milliseconds.

DEFAULT_SOCKET_TIMEOUT

public static final int DEFAULT_SOCKET_TIMEOUT

The default socket timeout in milliseconds.

DEFAULT_TCP_NODELAY

public static final boolean DEFAULT_TCP_NODELAY

By default, enable tcp nodelay.

See Also:

Constant Field Values

DEFAULT_IO_THREADS

public static final int DEFAULT_IO_THREADS

The default number of IO (worker) threads to use.

See Also:

Constant Field Values

DEFAULT_CONNS_PER_NODE

public static final int DEFAULT_CONNS_PER_NODE

The default number fo max. connections per node to keep open.

See Also:

Constant Field Values

Constructor Detail

ClusterManager

public ClusterManager(java.util.List<java.net.URI> nodes,
                      java.lang.String username,
                      java.lang.String password)

Create a new ClusterManager instance. Not all nodes in the cluster need to be provided, a subset is enough so that the ClusterManager can connect to at least one of them, even in the case of a node failure.

Parameters:

nodes - the list of nodes in the cluster to connect to.

username - the admin username.

password - the admin password.

ClusterManager

public ClusterManager(java.util.List<java.net.URI> nodes,
                      java.lang.String username,
                      java.lang.String password,
                      int connectionTimeout,
                      int socketTimeout,
                      boolean tcpNoDelay,
                      int ioThreadCount,
                      int connectionsPerNode)

Create a new ClusterManager instance. Not all nodes in the cluster need to be provided, a subset is enough so that the ClusterManager can connect to at least one of them, even in the case of a node failure.

Parameters:

nodes - the list of nodes in the cluster to connect to.

username - the admin username.

password - the admin password.

connectionTimeout - the timeout of the connection once established.

socketTimeout - the socket timeout of the connection.

tcpNoDelay - if nagle should be used or not.

ioThreadCount - the number of IO threads to use.

connectionsPerNode - the number of connections per node to establish.

Method Detail

createDefaultBucket

public void createDefaultBucket(BucketType type,
                                int memorySizeMB,
                                int replicas,
                                boolean flushEnabled)

Creates the default bucket.

Parameters:

type - The bucket type to create.

memorySizeMB - The amount of memory to allocate to this bucket.

replicas - The number of replicas for this bucket.

flushEnabled - If flush should be enabled on this bucket.

createNamedBucket

public void createNamedBucket(BucketType type,
                              java.lang.String name,
                              int memorySizeMB,
                              int replicas,
                              java.lang.String authPassword,
                              boolean flushEnabled)

Creates a named bucket with a given password for SASL authentication.

Parameters:

type - The bucket type to create.

name - The name of the bucket.

memorySizeMB - The amount of memory to allocate to this bucket.

replicas - The number of replicas for this bucket.

authPassword - The password for this bucket.

flushEnabled - If flush should be enabled on this bucket.

createPortBucket

public void createPortBucket(BucketType type,
                             java.lang.String name,
                             int memorySizeMB,
                             int replicas,
                             int port,
                             boolean flush)

Creates the a sasl bucket.

Parameters:

type - The bucket type to create.

name - The name of the bucket.

memorySizeMB - The amount of memory to allocate to this bucket.

replicas - The number of replicas for this bucket.

port - The port for this bucket to listen on.

deleteBucket

public void deleteBucket(java.lang.String name)

Deletes a bucket.

Parameters:

name - The name of the bucket to delete.

listBuckets

public java.util.List<java.lang.String> listBuckets()

Lists all buckets in a Couchbase cluster.

flushBucket

public FlushResponse flushBucket(java.lang.String name)

Deletes all data in a bucket.

Parameters:

name - The bucket to flush.

updateBucket

public void updateBucket(java.lang.String name,
                         int memorySizeMB,
                         AuthType authType,
                         int replicas,
                         int port,
                         java.lang.String authpassword,
                         boolean flushEnabled)

Update a bucket with the new settings.

Parameters:

name - The name of the bucket.

memorySizeMB - The amount of memory to allocate to this bucket.

authType - the authentication type to use.

replicas - The number of replicas for this bucket.

port - The port for this bucket to listen on.

authpassword - the authentication password.

flushEnabled - whether flush is enabled.

shutdown

public boolean shutdown()

Shutdown the ClusterManager.

Returns:

if success, false if not running or already shutting down.