com.couchbase.client.java

Interface AsyncCluster

All Known Implementing Classes:

CouchbaseAsyncCluster

@InterfaceStability.Committed
@InterfaceAudience.Public
public interface AsyncCluster

Represents a Couchbase Server Cluster.

A AsyncCluster is able to open many AsyncBuckets while sharing the underlying resources very efficiently. In addition, the AsyncClusterManager is available to perform cluster-wide operations.

Since:

2.0

Method Summary

Methods

Modifier and Type	Method and Description
rx.Observable<AsyncClusterManager>	clusterManager(java.lang.String username, java.lang.String password) Provides access to the AsyncClusterManager to perform cluster-wide operations.
rx.Observable<com.couchbase.client.core.ClusterFacade>	core() Returns the underlying “core-io” library through its ClusterFacade.
rx.Observable<java.lang.Boolean>	disconnect() Disconnects form all open buckets and shuts down the CouchbaseEnvironment if it is the exclusive owner.
rx.Observable<AsyncBucket>	openBucket() Opens the default bucket with an empty password.
rx.Observable<AsyncBucket>	openBucket(java.lang.String name) Opens the bucket with the given name and an empty password.
rx.Observable<AsyncBucket>	openBucket(java.lang.String name, java.lang.String password) Opens the bucket with the given name and password.
rx.Observable<AsyncBucket>	openBucket(java.lang.String name, java.lang.String password, java.util.List<Transcoder<? extends Document,?>> transcoders) Opens the bucket with the given name, password and a custom list of Transcoders.

Method Detail

openBucket

rx.Observable<AsyncBucket> openBucket()

Opens the default bucket with an empty password.

The Observable can error under the following conditions:

• 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

rx.Observable<AsyncBucket> openBucket(java.lang.String name)

Opens the bucket with the given name and an empty password.

The Observable can error under the following conditions:

• 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:

name - the name of the bucket.

Returns:

the opened bucket if successful.

openBucket

rx.Observable<AsyncBucket> openBucket(java.lang.String name,
                                    java.lang.String password)

Opens the bucket with the given name and password.

The Observable can error under the following conditions:

• 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:

name - the name of the bucket.

Returns:

the opened bucket if successful.

openBucket

rx.Observable<AsyncBucket> openBucket(java.lang.String name,
                                    java.lang.String password,
                                    java.util.List<Transcoder<? extends Document,?>> transcoders)

Opens the bucket with the given name, password and a custom list of Transcoders.

The Observable can error under the following conditions:

• 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:

name - the name of the bucket.

Returns:

the opened bucket if successful.

clusterManager

rx.Observable<AsyncClusterManager> clusterManager(java.lang.String username,
                                                java.lang.String password)

Provides access to the AsyncClusterManager 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 AsyncClusterManager if successful.

disconnect

rx.Observable<java.lang.Boolean> disconnect()

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

Returns:

true once done and everything succeeded, false otherwise.

core

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