com.couchbase.client.java

Class CouchbaseCluster

java.lang.Object

com.couchbase.client.java.CouchbaseCluster

All Implemented Interfaces:

Cluster

public class CouchbaseCluster
extends java.lang.Object
implements Cluster

Method Summary

Methods

Modifier and Type	Method and Description
ClusterManager	clusterManager(java.lang.String username, java.lang.String password) Provides access to the ClusterManager to perform cluster-wide operations.
com.couchbase.client.core.ClusterFacade	core() Returns the underlying “core-io” library through its ClusterFacade.
static CouchbaseCluster	create()
static CouchbaseCluster	create(CouchbaseEnvironment environment)
static CouchbaseCluster	create(CouchbaseEnvironment environment, java.util.List<java.lang.String> nodes)
static CouchbaseCluster	create(CouchbaseEnvironment environment, java.lang.String... nodes)
static CouchbaseCluster	create(java.util.List<java.lang.String> nodes)
static CouchbaseCluster	create(java.lang.String... nodes)
java.lang.Boolean	disconnect() Disconnects form all open buckets and shuts down the CouchbaseEnvironment if it is the exclusive owner with the default disconnect timeout.
java.lang.Boolean	disconnect(long timeout, java.util.concurrent.TimeUnit timeUnit) Disconnects form all open buckets and shuts down the CouchbaseEnvironment if it is the exclusive owner with a custom timeout.
static CouchbaseCluster	fromConnectionString(CouchbaseEnvironment environment, java.lang.String connectionString)
static CouchbaseCluster	fromConnectionString(java.lang.String connectionString)
Bucket	openBucket() Opens the default bucket with an empty password with the default connect timeout.
Bucket	openBucket(long timeout, java.util.concurrent.TimeUnit timeUnit) Opens the default bucket with an empty password with a custom timeout.
Bucket	openBucket(java.lang.String name) Opens a bucket identified by its name with an empty password and with the default connect timeout.
Bucket	openBucket(java.lang.String name, long timeout, java.util.concurrent.TimeUnit timeUnit) Opens a bucket identified by its name with an empty password and with a custom timeout.
Bucket	openBucket(java.lang.String name, java.lang.String password) Opens a bucket identified by its name and password with the default connect timeout.
Bucket	openBucket(java.lang.String name, java.lang.String password, java.util.List<Transcoder<? extends Document,?>> transcoders) Opens a bucket identified by its name and password with custom transcoders and with the default connect timeout.
Bucket	openBucket(java.lang.String name, java.lang.String password, java.util.List<Transcoder<? extends Document,?>> transcoders, long timeout, java.util.concurrent.TimeUnit timeUnit) Opens a bucket identified by its name and password with custom transcoders and with a custom timeout.
Bucket	openBucket(java.lang.String name, java.lang.String password, long timeout, java.util.concurrent.TimeUnit timeUnit) Opens a bucket identified by its name and password with a custom timeout.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static CouchbaseCluster create()

create

public static CouchbaseCluster create(CouchbaseEnvironment environment)

create

public static CouchbaseCluster create(java.lang.String... nodes)

create

public static CouchbaseCluster create(java.util.List<java.lang.String> nodes)

create

public static CouchbaseCluster create(CouchbaseEnvironment environment,
                      java.lang.String... nodes)

create

public static CouchbaseCluster create(CouchbaseEnvironment environment,
                      java.util.List<java.lang.String> nodes)

fromConnectionString

public static CouchbaseCluster fromConnectionString(java.lang.String connectionString)

fromConnectionString

public static CouchbaseCluster fromConnectionString(CouchbaseEnvironment environment,
                                    java.lang.String connectionString)

openBucket

public Bucket openBucket()

Description copied from interface: Cluster

Opens the default bucket with an empty password with the default connect timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed).
• com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.

Specified by:

openBucket in interface Cluster

Returns:

the opened bucket if successful.

openBucket

public Bucket openBucket(long timeout,
                java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: Cluster

Opens the default bucket with an empty password with a custom timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed).
• com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.

Specified by:

openBucket in interface Cluster

Parameters:

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the opened bucket if successful.

openBucket

public Bucket openBucket(java.lang.String name)

Description copied from interface: Cluster

Opens a bucket identified by its name with an empty password and with the default connect timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed).
• com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.

Specified by:

openBucket in interface Cluster

Returns:

the opened bucket if successful.

openBucket

public Bucket openBucket(java.lang.String name,
                long timeout,
                java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: Cluster

Opens a bucket identified by its name with an empty password and with a custom timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed).
• com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.

Specified by:

openBucket in interface Cluster

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the opened bucket if successful.

openBucket

public Bucket openBucket(java.lang.String name,
                java.lang.String password)

Description copied from interface: Cluster

Opens a bucket identified by its name and password with the default connect timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed).
• com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.

Specified by:

openBucket in interface Cluster

Returns:

the opened bucket if successful.

openBucket

public Bucket openBucket(java.lang.String name,
                java.lang.String password,
                long timeout,
                java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: Cluster

Opens a bucket identified by its name and password with a custom timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed).
• com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.

Specified by:

openBucket in interface Cluster

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the opened bucket if successful.

openBucket

public Bucket openBucket(java.lang.String name,
                java.lang.String password,
                java.util.List<Transcoder<? extends Document,?>> transcoders)

Description copied from interface: Cluster

Opens a bucket identified by its name and password with custom transcoders and with the default connect timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed).
• com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.

Specified by:

openBucket in interface Cluster

Returns:

the opened bucket if successful.

openBucket

public Bucket openBucket(java.lang.String name,
                java.lang.String password,
                java.util.List<Transcoder<? extends Document,?>> transcoders,
                long timeout,
                java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: Cluster

Opens a bucket identified by its name and password with custom transcoders and with a custom timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed).
• com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.

Specified by:

openBucket in interface Cluster

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the opened bucket if successful.

clusterManager

public ClusterManager clusterManager(java.lang.String username,
                            java.lang.String password)

Description copied from interface: Cluster

Provides access to the ClusterManager to perform cluster-wide operations.

Note that the credentials provided here are different from bucket-level credentials. As a rule of thumb, the “Administrator” credentials need to be passed in here or any credentials with enough permissions to perform the underlying operations. Bucket level credentials will not work.

Specified by:

clusterManager in interface Cluster

Parameters:

username - the username to perform cluster-wide operations.

password - the password associated with the username.

Returns:

the ClusterManager if successful.

disconnect

public java.lang.Boolean disconnect()

Description copied from interface: Cluster

Disconnects form all open buckets and shuts down the CouchbaseEnvironment if it is the exclusive owner with the default disconnect timeout.

Specified by:

disconnect in interface Cluster

Returns:

true once done and everything succeeded, false otherwise.

disconnect

public java.lang.Boolean disconnect(long timeout,
                           java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: Cluster

Disconnects form all open buckets and shuts down the CouchbaseEnvironment if it is the exclusive owner with a custom timeout.

Specified by:

disconnect in interface Cluster

Returns:

true once done and everything succeeded, false otherwise.

core

public com.couchbase.client.core.ClusterFacade core()

Description copied from interface: Cluster

Returns the underlying “core-io” library through its ClusterFacade.

Handle with care, with great power comes great responsibility. All additional checks which are normally performed by this library are skipped.

Specified by:

core in interface Cluster

Returns:

the underlying ClusterFacade from the “core-io” package.