ClusterManager (Couchbase Java SDK)

All Known Implementing Classes:

DefaultClusterManager
```
@InterfaceStability.Committed
 @InterfaceAudience.Public
public interface ClusterManager
```
Provides management capabilities for a Couchbase Server Cluster.
The underlying asynchronous capabilities can be leveraged through the async() method.

Since:

2.0

Author:

Michael Nitschinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AsyncClusterManager`	`async()` Accesses the underlying `AsyncClusterManager` to perform asynchronous operations on the cluster.
`BucketSettings`	`getBucket(String name)` Returns the `BucketSettings` for the `Bucket` identified by name with the default management timeout.
`BucketSettings`	`getBucket(String name, long timeout, TimeUnit timeUnit)` Returns the `BucketSettings` for the `Bucket` identified by name with a custom timeout.
`List<BucketSettings>`	`getBuckets()` Returns a list of `BucketSettings` for all available `Bucket`s with the default management timeout.
`List<BucketSettings>`	`getBuckets(long timeout, TimeUnit timeUnit)` Returns a list of `BucketSettings` for all available `Bucket`s with a custom timeout.
`Boolean`	`hasBucket(String name)` Checks if the cluster has a `Bucket` identified by the given name with the default management timeout.
`Boolean`	`hasBucket(String name, long timeout, TimeUnit timeUnit)` Checks if the cluster has a `Bucket` identified by the given name with a custom timeout.
`ClusterInfo`	`info()` Provides information about the cluster with the default management timeout.
`ClusterInfo`	`info(long timeout, TimeUnit timeUnit)` Provides information about the cluster with a custom timeout.
`BucketSettings`	`insertBucket(BucketSettings settings)` Inserts a `Bucket` with its `BucketSettings` if it does not already exist with the default management timeout.
`BucketSettings`	`insertBucket(BucketSettings settings, long timeout, TimeUnit timeUnit)` Inserts a `Bucket` with its `BucketSettings` if it does not already exist with a custom timeout.
`Boolean`	`removeBucket(String name)` Removes a `Bucket` identified by its name with the default management timeout.
`Boolean`	`removeBucket(String name, long timeout, TimeUnit timeUnit)` Removes a `Bucket` identified by its name with a custom timeout.
`BucketSettings`	`updateBucket(BucketSettings settings)` Updates a `Bucket` with its `BucketSettings` if it does already exist with the default management timeout.
`BucketSettings`	`updateBucket(BucketSettings settings, long timeout, TimeUnit timeUnit)` Updates a `Bucket` with its `BucketSettings` if it does already exist with a custom timeout.

- Method Detail
  - async
```
AsyncClusterManager async()
```
    Accesses the underlying AsyncClusterManager to perform asynchronous operations on the cluster.
    
    Returns:
    
    the underlying AsyncClusterManager.
  - info
```
ClusterInfo info()
```
    Provides information about the cluster with the default management timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Returns:
    
    cluster information wrapped into a ClusterInfo object.
  - info
```
ClusterInfo info(long timeout,
                 TimeUnit timeUnit)
```
    Provides information about the cluster with a custom timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Parameters:
    
    timeout - the custom timeout.
    
    timeUnit - the time unit for the custom timeout.
    
    Returns:
    
    cluster information wrapped into a ClusterInfo object.
  - getBuckets
```
List<BucketSettings> getBuckets()
```
    Returns a list of BucketSettings for all available Buckets with the default management timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Returns:
    
    a potentially empty list with BucketSettings.
  - getBuckets
```
List<BucketSettings> getBuckets(long timeout,
                                TimeUnit timeUnit)
```
    Returns a list of BucketSettings for all available Buckets with a custom timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Parameters:
    
    timeout - the custom timeout.
    
    timeUnit - the time unit for the custom timeout.
    
    Returns:
    
    a potentially empty list with BucketSettings.
  - getBucket
```
BucketSettings getBucket(String name)
```
    Returns the BucketSettings for the Bucket identified by name with the default management timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Parameters:
    
    name - the name of the bucket.
    
    Returns:
    
    the BucketSettings if found or null.
  - getBucket
```
BucketSettings getBucket(String name,
                         long timeout,
                         TimeUnit timeUnit)
```
    Returns the BucketSettings for the Bucket identified by name with a custom timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Parameters:
    
    name - the name of the bucket.
    
    timeout - the custom timeout.
    
    timeUnit - the time unit for the custom timeout.
    
    Returns:
    
    the BucketSettings if found or null.
  - hasBucket
```
Boolean hasBucket(String name)
```
    Checks if the cluster has a Bucket identified by the given name with the default management timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Parameters:
    
    name - the name of the bucket.
    
    Returns:
    
    true if it was found, false otherwise.
  - hasBucket
```
Boolean hasBucket(String name,
                  long timeout,
                  TimeUnit timeUnit)
```
    Checks if the cluster has a Bucket identified by the given name with a custom timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Parameters:
    
    name - the name of the bucket.
    
    timeout - the custom timeout.
    
    timeUnit - the time unit for the custom timeout.
    
    Returns:
    
    true if it was found, false otherwise.
  - insertBucket
```
BucketSettings insertBucket(BucketSettings settings)
```
    Inserts a Bucket with its BucketSettings if it does not already exist with the default management timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    - com.couchbase.client.java.error.BucketAlreadyExistsException: If the bucket already exists.
    Note: Inserting a Bucket is an asynchronous operation on the server side, so even if the response is returned there is no guarantee that the operation has finished on the server itself.
    Parameters:
    
    settings - the bucket settings that should be applied.
    
    Returns:
    
    the stored bucket settings if succeeded.
  - insertBucket
```
BucketSettings insertBucket(BucketSettings settings,
                            long timeout,
                            TimeUnit timeUnit)
```
    Inserts a Bucket with its BucketSettings if it does not already exist with a custom timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    - com.couchbase.client.java.error.BucketAlreadyExistsException: If the bucket already exists.
    Note: Inserting a Bucket is an asynchronous operation on the server side, so even if the response is returned there is no guarantee that the operation has finished on the server itself.
    Parameters:
    
    settings - the bucket settings that should be applied.
    
    Returns:
    
    the stored bucket settings if succeeded.
  - updateBucket
```
BucketSettings updateBucket(BucketSettings settings)
```
    Updates a Bucket with its BucketSettings if it does already exist with the default management timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    - com.couchbase.client.java.error.BucketDoesNotExistException: If the bucket does not exist.
    Note: Updating a Bucket is an asynchronous operation on the server side, so even if the response is returned there is no guarantee that the operation has finished on the server itself.
    Parameters:
    
    settings - the bucket settings that should be applied.
    
    Returns:
    
    the updated bucket settings if succeeded.
  - updateBucket
```
BucketSettings updateBucket(BucketSettings settings,
                            long timeout,
                            TimeUnit timeUnit)
```
    Updates a Bucket with its BucketSettings if it does already exist with a custom timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    - com.couchbase.client.java.error.BucketDoesNotExistException: If the bucket does not exist.
    Note: Updating a Bucket is an asynchronous operation on the server side, so even if the response is returned there is no guarantee that the operation has finished on the server itself.
    Parameters:
    
    settings - the bucket settings that should be applied.
    
    timeout - the custom timeout.
    
    timeUnit - the time unit for the custom timeout.
    
    Returns:
    
    the updated bucket settings if succeeded.
  - removeBucket
```
Boolean removeBucket(String name)
```
    Removes a Bucket identified by its name with the default management timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Note: Removing a Bucket is an asynchronous operation on the server side, so even if the response is returned there is no guarantee that the operation has finished on the server itself.
    Parameters:
    
    name - the name of the bucket.
    
    Returns:
    
    true if the removal was successful, false otherwise.
  - removeBucket
```
Boolean removeBucket(String name,
                     long timeout,
                     TimeUnit timeUnit)
```
    Removes a Bucket identified by its name with a custom timeout.
    This method throws:
    - java.util.concurrent.TimeoutException: If the timeout is exceeded.
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Note: Removing a Bucket is an asynchronous operation on the server side, so even if the response is returned there is no guarantee that the operation has finished on the server itself.
    Parameters:
    
    name - the name of the bucket.
    
    timeout - the custom timeout.
    
    timeUnit - the time unit for the custom timeout.
    
    Returns:
    
    true if the removal was successful, false otherwise.

Interface ClusterManager

Method Summary

Method Detail

async

info

info

getBuckets

getBuckets

getBucket

getBucket

hasBucket

hasBucket

insertBucket

insertBucket

updateBucket

updateBucket

removeBucket

removeBucket