com.couchbase.client.java

Class CouchbaseAsyncCluster

java.lang.Object

com.couchbase.client.java.CouchbaseAsyncCluster

All Implemented Interfaces:

AsyncCluster

public class CouchbaseAsyncCluster
extends java.lang.Object
implements AsyncCluster

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.
static CouchbaseAsyncCluster	create()
static CouchbaseAsyncCluster	create(CouchbaseEnvironment environment)
static CouchbaseAsyncCluster	create(CouchbaseEnvironment environment, java.util.List<java.lang.String> nodes)
static CouchbaseAsyncCluster	create(CouchbaseEnvironment environment, java.lang.String... nodes)
static CouchbaseAsyncCluster	create(java.util.List<java.lang.String> nodes)
static CouchbaseAsyncCluster	create(java.lang.String... nodes)
rx.Observable<java.lang.Boolean>	disconnect() Disconnects form all open buckets and shuts down the CouchbaseEnvironment if it is the exclusive owner.
static CouchbaseAsyncCluster	fromConnectionString(CouchbaseEnvironment environment, java.lang.String connectionString)
static CouchbaseAsyncCluster	fromConnectionString(java.lang.String connectionString)
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 pass) Opens the bucket with the given name and password.
rx.Observable<AsyncBucket>	openBucket(java.lang.String name, java.lang.String pass, java.util.List<Transcoder<? extends Document,?>> transcoders) Opens the bucket with the given name, password and a custom list of Transcoders.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static CouchbaseAsyncCluster create()

create

public static CouchbaseAsyncCluster create(CouchbaseEnvironment environment)

create

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

create

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

create

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

create

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

fromConnectionString

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

fromConnectionString

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

openBucket

public rx.Observable<AsyncBucket> openBucket()

Description copied from interface: AsyncCluster

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.

Specified by:

openBucket in interface AsyncCluster

Returns:

the opened bucket if successful.

openBucket

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

Description copied from interface: AsyncCluster

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.

Specified by:

openBucket in interface AsyncCluster

Parameters:

name - the name of the bucket.

Returns:

the opened bucket if successful.

openBucket

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

Description copied from interface: AsyncCluster

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.

Specified by:

openBucket in interface AsyncCluster

Parameters:

name - the name of the bucket.

Returns:

the opened bucket if successful.

openBucket

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

Description copied from interface: AsyncCluster

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.

Specified by:

openBucket in interface AsyncCluster

Parameters:

name - the name of the bucket.

Returns:

the opened bucket if successful.

disconnect

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

Description copied from interface: AsyncCluster

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

Specified by:

disconnect in interface AsyncCluster

Returns:

true once done and everything succeeded, false otherwise.

clusterManager

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

Description copied from interface: AsyncCluster

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.

Specified by:

clusterManager in interface AsyncCluster

Parameters:

username - the username to perform cluster-wide operations.

password - the password associated with the username.

Returns:

the AsyncClusterManager if successful.

core

public rx.Observable<com.couchbase.client.core.ClusterFacade> core()

Description copied from interface: AsyncCluster

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 AsyncCluster

Returns:

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