CouchbaseAsyncCluster (Couchbase Java SDK)

java.lang.Object
- com.couchbase.client.java.CouchbaseAsyncCluster

All Implemented Interfaces:

AsyncCluster
```
public class CouchbaseAsyncCluster
extends Object
implements AsyncCluster
```
Main asynchronous entry point to a Couchbase Cluster.
The CouchbaseAsyncCluster object is the main entry point when connecting to a remote Couchbase Server cluster. It will either create a bundled stateful environment or accept one passed in, in case the application needs to connect to more clusters at the same time.
It provides cluster level management facilities through the AsyncClusterManager class, but mainly provides facilities to open AsyncBuckets where the actual CRUD and query operations are performed against.
The simplest way to initialize a CouchbaseAsyncCluster is by using the create() factory method. This is only recommended during development, since it will connect to a Cluster residing on 127.0.0.1.
```
AsyncCluster cluster = CouchbaseAsyncCluster.create();
```
In production, it is recommended that at least two or three hosts are passed in, so in case one fails the SDK is able to bootstrap through alternative options.
```
AsyncCluster cluster = CouchbaseAsyncCluster.create(
  "192.168.56.101", "192.168.56.102", "192.168.56.103"
);
```
Please make sure that these hosts are part of the same cluster, otherwise non-deterministic connecting behaviour will arise (the SDK may connect to the wrong cluster).
If you need to customize CouchbaseEnvironment options or connect to multiple clusters, it is recommended to explicitly create one and then reuse it. Keep in mind that the cluster will not shut down the environment if it didn’t create it, so this is up to the caller.
```
CouchbaseEnvironment environment = DefaultCouchbaseEnvironment.builder()
.kvTimeout(3000) // change the default kv timeout
.build();

AsyncCluster cluster = CouchbaseAsyncCluster.create(environment, "192.168.56.101",
  "192.168.56.102");
Observable&lt;Bucket&gt; bucket = cluster.openBucket("travel-sample");

// Perform your work here...

cluster.disconnect();
environment.shutdownAsync().toBlocking().single();
```
Since:

2.0.0

Author:

Michael Nitschinger, Simon Baslé

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_BUCKET` The default bucket used when `openBucket()` is called.
`static String`	`DEFAULT_HOST` The default hostname used to bootstrap then `create()` is used.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CouchbaseAsyncCluster`	`authenticate(Authenticator auth)` Sets the `Authenticator` to use when credentials are needed for an operation but no explicit credentials are provided.
`AsyncCluster`	`authenticate(String username, String password)` Shortcut method to directly authenticate with a username and a password.
`Authenticator`	`authenticator()` Get the `Authenticator` currently used when credentials are needed for an operation, but no explicit credentials are provided.
`rx.Observable<AsyncClusterManager>`	`clusterManager()` Provides access to the `AsyncClusterManager` to perform cluster-wide operations, using the credentials set through the configured `Authenticator`, for the `CredentialContext.CLUSTER_MANAGEMENT` context.
`rx.Observable<AsyncClusterManager>`	`clusterManager(String username, String password)` Provides access to the `AsyncClusterManager` to perform cluster-wide operations.
`rx.Observable<ClusterFacade>`	`core()` Returns the underlying “core-io” library through its `ClusterFacade`.
`static CouchbaseAsyncCluster`	`create()` Creates a new `CouchbaseAsyncCluster` reference against the `DEFAULT_HOST`.
`static CouchbaseAsyncCluster`	`create(CouchbaseEnvironment environment)` Creates a new `CouchbaseAsyncCluster` reference against the `DEFAULT_HOST`.
`static CouchbaseAsyncCluster`	`create(CouchbaseEnvironment environment, List<String> nodes)` Creates a new `CouchbaseAsyncCluster` reference against the nodes passed in.
`static CouchbaseAsyncCluster`	`create(CouchbaseEnvironment environment, String... nodes)` Creates a new `CouchbaseAsyncCluster` reference against the nodes passed in.
`static CouchbaseAsyncCluster`	`create(List<String> nodes)` Creates a new `CouchbaseAsyncCluster` reference against the nodes passed in.
`static CouchbaseAsyncCluster`	`create(String... nodes)` Creates a new `CouchbaseAsyncCluster` reference against the nodes passed in.
`rx.Observable<Boolean>`	`disconnect()` Disconnects form all open buckets and shuts down the `CouchbaseEnvironment` if it is the exclusive owner.
`static CouchbaseAsyncCluster`	`fromConnectionString(CouchbaseEnvironment environment, String connectionString)` Creates a new `CouchbaseAsyncCluster` reference using the connection string.
`static CouchbaseAsyncCluster`	`fromConnectionString(String connectionString)` Creates a new `CouchbaseAsyncCluster` reference using the connection string.
`protected Credential`	`getSingleCredential(CredentialContext context, String specific)`
`rx.Observable<ServicesHealth>`	`healthCheck()` Provides a simple health check which allows insight into the current state of services and endpoints.
`rx.Observable<AsyncBucket>`	`openBucket()` Opens the default bucket with an empty password.
`rx.Observable<AsyncBucket>`	`openBucket(String name)` Opens the bucket with the given name using the password from the `Authenticator` that was last `set`
`rx.Observable<AsyncBucket>`	`openBucket(String name, List<Transcoder<? extends Document,?>> transcoders)` Opens the bucket with the given name using the password from the `Authenticator` that was last `set`
`rx.Observable<AsyncBucket>`	`openBucket(String name, String password)` Opens the bucket with the given name and password.
`rx.Observable<AsyncBucket>`	`openBucket(String name, String password, List<Transcoder<? extends Document,?>> transcoders)` Opens the bucket with the given name, password and a custom list of `Transcoder`s.
`rx.Observable<AsyncN1qlQueryResult>`	`query(N1qlQuery query)` Asynchronously perform a N1QL query that can span multiple buckets.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_BUCKET
```
public static final String DEFAULT_BUCKET
```
    The default bucket used when openBucket() is called.
    Defaults to “default”.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HOST
```
public static final String DEFAULT_HOST
```
    The default hostname used to bootstrap then create() is used.
    Defaults to “127.0.0.1”.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - create
```
public static CouchbaseAsyncCluster create()
```
    Creates a new CouchbaseAsyncCluster reference against the DEFAULT_HOST.
    Note: It is recommended to use this method only during development, since it does not allow you to pass in hostnames when connecting to a remote cluster. Please use create(String...) or similar instead.
    The CouchbaseEnvironment will be automatically created and its lifecycle managed.
    
    Returns:
    
    a new CouchbaseAsyncCluster reference.
  - create
```
public static CouchbaseAsyncCluster create(CouchbaseEnvironment environment)
```
    Creates a new CouchbaseAsyncCluster reference against the DEFAULT_HOST.
    Note: It is recommended to use this method only during development, since it does not allow you to pass in hostnames when connecting to a remote cluster. Please use create(String...) or similar instead.
    
    Parameters:
    
    environment - the custom environment to use for this cluster reference.
    
    Returns:
    
    a new CouchbaseAsyncCluster reference.
  - create
```
public static CouchbaseAsyncCluster create(String... nodes)
```
    Creates a new CouchbaseAsyncCluster reference against the nodes passed in.
    The CouchbaseEnvironment will be automatically created and its lifecycle managed.
    
    Parameters:
    
    nodes - the list of nodes to use when connecting to the cluster reference.
    
    Returns:
    
    a new CouchbaseAsyncCluster reference.
  - create
```
public static CouchbaseAsyncCluster create(List<String> nodes)
```
    Creates a new CouchbaseAsyncCluster reference against the nodes passed in.
    The CouchbaseEnvironment will be automatically created and its lifecycle managed.
    
    Parameters:
    
    nodes - the list of nodes to use when connecting to the cluster reference.
    
    Returns:
    
    a new CouchbaseAsyncCluster reference.
  - create
```
public static CouchbaseAsyncCluster create(CouchbaseEnvironment environment,
                                           String... nodes)
```
    Creates a new CouchbaseAsyncCluster reference against the nodes passed in.
    
    Parameters:
    
    environment - the custom environment to use for this cluster reference.
    
    nodes - the list of nodes to use when connecting to the cluster reference.
    
    Returns:
    
    a new CouchbaseAsyncCluster reference.
  - create
```
public static CouchbaseAsyncCluster create(CouchbaseEnvironment environment,
                                           List<String> nodes)
```
    Creates a new CouchbaseAsyncCluster reference against the nodes passed in.
    
    Parameters:
    
    environment - the custom environment to use for this cluster reference.
    
    nodes - the list of nodes to use when connecting to the cluster reference.
    
    Returns:
    
    a new CouchbaseAsyncCluster reference.
  - fromConnectionString
```
public static CouchbaseAsyncCluster fromConnectionString(String connectionString)
```
    Creates a new CouchbaseAsyncCluster reference using the connection string.
    The CouchbaseEnvironment will be automatically created and its lifecycle managed.
    
    Parameters:
    
    connectionString - the connection string to identify the remote cluster.
    
    Returns:
    
    a new CouchbaseAsyncCluster reference.
  - fromConnectionString
```
public static CouchbaseAsyncCluster fromConnectionString(CouchbaseEnvironment environment,
                                                         String connectionString)
```
    Creates a new CouchbaseAsyncCluster reference using the connection string.
    
    Parameters:
    
    environment - the custom environment to use for this cluster reference.
    
    connectionString - the connection string to identify the remote cluster.
    
    Returns:
    
    a new CouchbaseAsyncCluster reference.
  - 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(String name)
```
    Description copied from interface: AsyncCluster
    Opens the bucket with the given name using the password from the Authenticator that was last set
    If no credential context can be found for the bucket when using ClassicAuthenticator , the old behavior of defaulting to an empty password is used.
    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.
    - AuthenticatorException: If more than one credentials was returned by the Authenticator for this bucket.
    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(String name,
                                             List<Transcoder<? extends Document,?>> transcoders)
```
    Description copied from interface: AsyncCluster
    Opens the bucket with the given name using the password from the Authenticator that was last set
    If no credential context can be found for the bucket when using ClassicAuthenticator , the old behavior of defaulting to an empty password is used.
    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.
    - AuthenticatorException: If more than one credentials was returned by the Authenticator for this bucket.
    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(String name,
                                             String password)
```
    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(String name,
                                             String password,
                                             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<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(String username,
                                                         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.
  - getSingleCredential
```
protected Credential getSingleCredential(CredentialContext context,
                                         String specific)
```
  - clusterManager
```
public rx.Observable<AsyncClusterManager> clusterManager()
```
    Description copied from interface: AsyncCluster
    Provides access to the AsyncClusterManager to perform cluster-wide operations, using the credentials set through the configured Authenticator, for the CredentialContext.CLUSTER_MANAGEMENT context.
    The Observable can error under the following notable condition:
    - AuthenticatorException: if no Authenticator is set or it doesn’t contains a cluster management credential.
    Specified by:
    
    clusterManager in interface AsyncCluster
    
    Returns:
    
    the AsyncClusterManager if successful.
  - core
```
public rx.Observable<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.
  - authenticate
```
public CouchbaseAsyncCluster authenticate(Authenticator auth)
```
    Description copied from interface: AsyncCluster
    
    Sets the Authenticator to use when credentials are needed for an operation but no explicit credentials are provided.
    Note that setting a new Authenticator will not be propagated to any Bucket that has been opened with the previous Authenticator, as the instance is passed to the Bucket for its own use.
    
    Specified by:
    
    authenticate in interface AsyncCluster
    
    Parameters:
    
    auth - the new Authenticator to use.
    
    Returns:
    
    this AsyncCluster instance for chaining.
  - authenticate
```
public AsyncCluster authenticate(String username,
                                 String password)
```
    Description copied from interface: AsyncCluster
    
    Shortcut method to directly authenticate with a username and a password.
    
    Specified by:
    
    authenticate in interface AsyncCluster
    
    Parameters:
    
    username - the username to authenticate
    
    password - the password for the username
    
    Returns:
    
    this Cluster instance for chaining.
  - authenticator
```
@InterfaceStability.Uncommitted
 @InterfaceAudience.Private
public Authenticator authenticator()
```
    Get the Authenticator currently used when credentials are needed for an operation, but no explicit credentials are provided.
    
    Returns:
    
    the Authenticator currently used for this cluster.
  - query
```
public rx.Observable<AsyncN1qlQueryResult> query(N1qlQuery query)
```
    Description copied from interface: AsyncCluster
    Asynchronously perform a N1QL query that can span multiple buckets. The query will use any credential set through this cluster’s Authenticator.
    In order to use that method, at least one AsyncBucket must currently be opened. Note that if you are only performing queries spanning a single bucket, you should prefer opening that Bucket and use the query API at the bucket level.
    The Observable can fail in the following notable conditions:
    - UnsupportedOperationException: no bucket is currently opened.
    - IllegalStateException: no Authenticator is set or no credentials are available in it for cluster level querying.
    - TimeoutException: the operation takes longer than the specified timeout.
    - BackpressureException: the producer outpaces the SDK.
    - RequestCancelledException: the operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying.
    Specified by:
    
    query in interface AsyncCluster
    
    Parameters:
    
    query - the N1qlQuery to execute.
    
    Returns:
    
    an observable emitting at most a single query result.
  - healthCheck
```
public rx.Observable<ServicesHealth> healthCheck()
```
    Description copied from interface: AsyncCluster
    
    Provides a simple health check which allows insight into the current state of services and endpoints.
    
    Specified by:
    
    healthCheck in interface AsyncCluster
    
    Returns:
    
    health services in the form of ServicesHealth.

Class CouchbaseAsyncCluster

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BUCKET

DEFAULT_HOST

Method Detail

create

create

create

create

create

create

fromConnectionString

fromConnectionString

openBucket

openBucket

openBucket

openBucket

openBucket

disconnect

clusterManager

getSingleCredential

clusterManager

core

authenticate

authenticate

authenticator

query

healthCheck