DefaultClusterManager (Couchbase Java SDK)

java.lang.Object
- com.couchbase.client.java.cluster.DefaultClusterManager

All Implemented Interfaces:: ClusterManager

public class DefaultClusterManager
extends Object
implements ClusterManager

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClusterApiClient`	`apiClient()` Returns a new `ClusterApiClient` to prepare and perform REST API synchronous requests on this cluster.
`AsyncClusterManager`	`async()` Accesses the underlying `AsyncClusterManager` to perform asynchronous operations on the cluster.
`static DefaultClusterManager`	`create(String username, String password, ConnectionString connectionString, CouchbaseEnvironment environment, ClusterFacade core)`
`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.

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

- Method Detail
  - create
```
public static DefaultClusterManager create(String username,
                                           String password,
                                           ConnectionString connectionString,
                                           CouchbaseEnvironment environment,
                                           ClusterFacade core)
```
  - async
```
public AsyncClusterManager async()
```
    Description copied from interface: ClusterManager
    
    Accesses the underlying AsyncClusterManager to perform asynchronous operations on the cluster.
    
    Specified by:
    
    async in interface ClusterManager
    
    Returns:
    
    the underlying AsyncClusterManager.
  - info
```
public ClusterInfo info()
```
    Description copied from interface: ClusterManager
    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.
    Specified by:
    
    info in interface ClusterManager
    
    Returns:
    
    cluster information wrapped into a ClusterInfo object.
  - info
```
public ClusterInfo info(long timeout,
                        TimeUnit timeUnit)
```
    Description copied from interface: ClusterManager
    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.
    Specified by:
    
    info in interface ClusterManager
    
    Parameters:
    
    timeout - the custom timeout.
    
    timeUnit - the time unit for the custom timeout.
    
    Returns:
    
    cluster information wrapped into a ClusterInfo object.
  - getBuckets
```
public List<BucketSettings> getBuckets()
```
    Description copied from interface: ClusterManager
    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.
    Specified by:
    
    getBuckets in interface ClusterManager
    
    Returns:
    
    a potentially empty list with BucketSettings.
  - getBuckets
```
public List<BucketSettings> getBuckets(long timeout,
                                       TimeUnit timeUnit)
```
    Description copied from interface: ClusterManager
    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.
    Specified by:
    
    getBuckets in interface ClusterManager
    
    Parameters:
    
    timeout - the custom timeout.
    
    timeUnit - the time unit for the custom timeout.
    
    Returns:
    
    a potentially empty list with BucketSettings.
  - getBucket
```
public BucketSettings getBucket(String name)
```
    Description copied from interface: ClusterManager
    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.
    Specified by:
    
    getBucket in interface ClusterManager
    
    Parameters:
    
    name - the name of the bucket.
    
    Returns:
    
    the BucketSettings if found or null.
  - getBucket
```
public BucketSettings getBucket(String name,
                                long timeout,
                                TimeUnit timeUnit)
```
    Description copied from interface: ClusterManager
    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.
    Specified by:
    
    getBucket in interface ClusterManager
    
    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
```
public Boolean hasBucket(String name)
```
    Description copied from interface: ClusterManager
    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.
    Specified by:
    
    hasBucket in interface ClusterManager
    
    Parameters:
    
    name - the name of the bucket.
    
    Returns:
    
    true if it was found, false otherwise.
  - hasBucket
```
public Boolean hasBucket(String name,
                         long timeout,
                         TimeUnit timeUnit)
```
    Description copied from interface: ClusterManager
    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.
    Specified by:
    
    hasBucket in interface ClusterManager
    
    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
```
public BucketSettings insertBucket(BucketSettings settings)
```
    Description copied from interface: ClusterManager
    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.
    Specified by:
    
    insertBucket in interface ClusterManager
    
    Parameters:
    
    settings - the bucket settings that should be applied.
    
    Returns:
    
    the stored bucket settings if succeeded.
  - insertBucket
```
public BucketSettings insertBucket(BucketSettings settings,
                                   long timeout,
                                   TimeUnit timeUnit)
```
    Description copied from interface: ClusterManager
    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.
    Specified by:
    
    insertBucket in interface ClusterManager
    
    Parameters:
    
    settings - the bucket settings that should be applied.
    
    Returns:
    
    the stored bucket settings if succeeded.
  - updateBucket
```
public BucketSettings updateBucket(BucketSettings settings)
```
    Description copied from interface: ClusterManager
    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.
    Specified by:
    
    updateBucket in interface ClusterManager
    
    Parameters:
    
    settings - the bucket settings that should be applied.
    
    Returns:
    
    the updated bucket settings if succeeded.
  - updateBucket
```
public BucketSettings updateBucket(BucketSettings settings,
                                   long timeout,
                                   TimeUnit timeUnit)
```
    Description copied from interface: ClusterManager
    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.
    Specified by:
    
    updateBucket in interface ClusterManager
    
    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
```
public Boolean removeBucket(String name)
```
    Description copied from interface: ClusterManager
    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.
    Specified by:
    
    removeBucket in interface ClusterManager
    
    Parameters:
    
    name - the name of the bucket.
    
    Returns:
    
    true if the removal was successful, false otherwise.
  - removeBucket
```
public Boolean removeBucket(String name,
                            long timeout,
                            TimeUnit timeUnit)
```
    Description copied from interface: ClusterManager
    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.
    Specified by:
    
    removeBucket in interface ClusterManager
    
    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.
  - apiClient
```
@InterfaceStability.Experimental
public ClusterApiClient apiClient()
```
    Description copied from interface: ClusterManager
    
    Returns a new ClusterApiClient to prepare and perform REST API synchronous requests on this cluster. The requests have a default timeout corresponding to the configured CouchbaseEnvironment.managementTimeout().
    
    Specified by:
    
    apiClient in interface ClusterManager
    
    Returns:
    
    a new ClusterApiClient.

Class DefaultClusterManager

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

async

info

info

getBuckets

getBuckets

getBucket

getBucket

hasBucket

hasBucket

insertBucket

insertBucket

updateBucket

updateBucket

removeBucket

removeBucket

apiClient