Cluster (Couchbase Java SDK)

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

Author:

Michael Nitschinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Cluster`	`authenticate(Authenticator auth)` Sets the `Authenticator` to use when credentials are needed for an operation but no explicit credentials are provided.
`ClusterManager`	`clusterManager()` Provides access to the `ClusterManager` to perform cluster-wide operations, using the credentials set through the configured `Authenticator` (see `authenticate(Authenticator)`), for the `CredentialContext.CLUSTER_MANAGEMENT` context.
`ClusterManager`	`clusterManager(String username, String password)` Provides access to the `ClusterManager` to perform cluster-wide operations.
`ClusterFacade`	`core()` Returns the underlying “core-io” library through its `ClusterFacade`.
`Boolean`	`disconnect()` Disconnects form all open buckets and shuts down the `CouchbaseEnvironment` if it is the exclusive owner with the default disconnect timeout.
`Boolean`	`disconnect(long timeout, 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, TimeUnit timeUnit)` Opens the default bucket with an empty password with a custom timeout.
`Bucket`	`openBucket(String name)` Opens the bucket with the given name, using the default timeout and the password from the `Authenticator` that was last `set` (in the `BUCKET_KV context`).
`Bucket`	`openBucket(String name, long timeout, TimeUnit timeUnit)` Opens the bucket with the given name, using a custom timeout and the password from the `Authenticator` that was last `set` (in the `BUCKET_KV context`).
`Bucket`	`openBucket(String name, String password)` Opens a bucket identified by its name and password with the default connect timeout.
`Bucket`	`openBucket(String name, String password, 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(String name, String password, List<Transcoder<? extends Document,?>> transcoders, long timeout, TimeUnit timeUnit)` Opens a bucket identified by its name and password with custom transcoders and with a custom timeout.
`Bucket`	`openBucket(String name, String password, long timeout, 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,
                  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(String name)
```
    Opens the bucket with the given name, using the default timeout and the password from the Authenticator that was last set (in the BUCKET_KV context).
    If no credential can be found for the bucket in the authenticator, the old behavior of defaulting to an empty password is used.
    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.
    - AuthenticatorException: If more than one credentials was returned by the Authenticator for this bucket.
    Returns:
    
    the opened bucket if successful.
  - openBucket
```
Bucket openBucket(String name,
                  long timeout,
                  TimeUnit timeUnit)
```
    Opens the bucket with the given name, using a custom timeout and the password from the Authenticator that was last set (in the BUCKET_KV context).
    If no credential can be found for the bucket in the authenticator, the old behavior of defaulting to an empty password is used.
    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.
    - AuthenticatorException: If more than one credentials was returned by the Authenticator for this bucket.
    Parameters:
    
    timeout - the custom timeout.
    
    timeUnit - the time unit for the custom timeout.
    
    Returns:
    
    the opened bucket if successful.
  - openBucket
```
Bucket openBucket(String name,
                  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(String name,
                  String password,
                  long timeout,
                  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(String name,
                  String password,
                  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(String name,
                  String password,
                  List<Transcoder<? extends Document,?>> transcoders,
                  long timeout,
                  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(String username,
                              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.
  - clusterManager
```
ClusterManager clusterManager()
```
    Provides access to the ClusterManager to perform cluster-wide operations, using the credentials set through the configured Authenticator (see authenticate(Authenticator)), for the CredentialContext.CLUSTER_MANAGEMENT context.
    
    Returns:
    
    the ClusterManager if successful.
    
    Throws:
    
    AuthenticatorException - if no Authenticator is set or it doesn’t contain a cluster management credential.
  - disconnect
```
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
```
Boolean disconnect(long timeout,
                   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
```
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.
  - authenticate
```
Cluster authenticate(Authenticator auth)
```
    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.
    
    Parameters:
    
    auth - the new Authenticator to use.
    
    Returns:
    
    this Cluster instance for chaining.

Interface Cluster

Method Summary

Method Detail

openBucket

openBucket

openBucket

openBucket

openBucket

openBucket

openBucket

openBucket

clusterManager

clusterManager

disconnect

disconnect

core

authenticate