com.couchbase.client.java.cluster

Interface AsyncClusterManager

All Known Implementing Classes:

DefaultAsyncClusterManager

@InterfaceStability.Committed
@InterfaceAudience.Public
public interface AsyncClusterManager

Provides management capabilities for a Couchbase Server Cluster.

Since:

2.0

Method Summary

Methods

Modifier and Type	Method and Description
rx.Observable<BucketSettings>	getBucket(java.lang.String name) Returns the BucketSettings for the Bucket identified by name.
rx.Observable<BucketSettings>	getBuckets() Returns BucketSettings for all available Buckets.
rx.Observable<java.lang.Boolean>	hasBucket(java.lang.String name) Checks if the cluster has a Bucket identified by the given name.
rx.Observable<ClusterInfo>	info() Provides information about the cluster.
rx.Observable<BucketSettings>	insertBucket(BucketSettings settings) Inserts a Bucket with its BucketSettings if it does not already exist.
rx.Observable<java.lang.Boolean>	removeBucket(java.lang.String name) Removes a Bucket identified by its name.
rx.Observable<BucketSettings>	updateBucket(BucketSettings settings) Updates a Bucket with its BucketSettings if it does already exist.

Method Detail

info

rx.Observable<ClusterInfo> info()

Provides information about the cluster.

The Observable can error under the following conditions:

• 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.

getBuckets

rx.Observable<BucketSettings> getBuckets()

Returns BucketSettings for all available Buckets.

The Observable can error under the following conditions:

• 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:

zero to N BucketSettings.

getBucket

rx.Observable<BucketSettings> getBucket(java.lang.String name)

Returns the BucketSettings for the Bucket identified by name.

The Observable can error under the following conditions:

• 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 an empty observable if not found.

hasBucket

rx.Observable<java.lang.Boolean> hasBucket(java.lang.String name)

Checks if the cluster has a Bucket identified by the given name.

The Observable can error under the following conditions:

• 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.

insertBucket

rx.Observable<BucketSettings> insertBucket(BucketSettings settings)

Inserts a Bucket with its BucketSettings if it does not already exist.

The Observable can error under the following conditions:

• 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.

Parameters:

settings - the bucket settings that should be applied.

Returns:

the stored bucket settings if succeeded.

updateBucket

rx.Observable<BucketSettings> updateBucket(BucketSettings settings)

Updates a Bucket with its BucketSettings if it does already exist.

The Observable can error under the following conditions:

• 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.

Parameters:

settings - the bucket settings that should be applied.

Returns:

the updated bucket settings if succeeded.

removeBucket

rx.Observable<java.lang.Boolean> removeBucket(java.lang.String name)

Removes a Bucket identified by its name.

The Observable can error under the following conditions:

• 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 the removal was successful, false otherwise.