com.couchbase.client.java

Interface Cluster

All Known Implementing Classes:

CouchbaseCluster

@InterfaceStability.Committed
@InterfaceAudience.Public
public interface Cluster

Represents a Couchbase Server Cluster.

A Cluster is able to open many Buckets while sharing the underlying resources very efficiently. In addition, the ClusterManager is available to perform cluster-wide operations.

Since:

2.0

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.
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.
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.

Method Detail

openBucket

Bucket openBucket()

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.

Returns:

the opened bucket if successful.

openBucket

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

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.

Parameters:

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the opened bucket if successful.

openBucket

Bucket openBucket(java.lang.String name)

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.

Returns:

the opened bucket if successful.

openBucket

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.

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.

Parameters:

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the opened bucket if successful.

openBucket

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

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.

Returns:

the opened bucket if successful.

openBucket

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.

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.

Parameters:

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the opened bucket if successful.

openBucket

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.

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.

Returns:

the opened bucket if successful.

openBucket

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.

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.

Parameters:

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the opened bucket if successful.

clusterManager

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

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.

Parameters:

username - the username to perform cluster-wide operations.

password - the password associated with the username.

Returns:

the ClusterManager if successful.

disconnect

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.

Returns:

true once done and everything succeeded, false otherwise.

disconnect

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.

Returns:

true once done and everything succeeded, false otherwise.

core

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

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.

Returns:

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