com.couchbase.client.java.cluster

Class DefaultAsyncClusterManager

java.lang.Object

com.couchbase.client.java.cluster.DefaultAsyncClusterManager

All Implemented Interfaces:

AsyncClusterManager

public class DefaultAsyncClusterManager
extends java.lang.Object
implements AsyncClusterManager

Method Summary

Methods

Modifier and Type	Method and Description
static DefaultAsyncClusterManager	create(java.lang.String username, java.lang.String password, ConnectionString connectionString, CouchbaseEnvironment environment, com.couchbase.client.core.ClusterFacade core)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static DefaultAsyncClusterManager create(java.lang.String username,
                                java.lang.String password,
                                ConnectionString connectionString,
                                CouchbaseEnvironment environment,
                                com.couchbase.client.core.ClusterFacade core)

info

public rx.Observable<ClusterInfo> info()

Description copied from interface: AsyncClusterManager

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.

Specified by:

info in interface AsyncClusterManager

Returns:

cluster information wrapped into a ClusterInfo object.

getBuckets

public rx.Observable<BucketSettings> getBuckets()

Description copied from interface: AsyncClusterManager

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.

Specified by:

getBuckets in interface AsyncClusterManager

Returns:

zero to N BucketSettings.

getBucket

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

Description copied from interface: AsyncClusterManager

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.

Specified by:

getBucket in interface AsyncClusterManager

Parameters:

name - the name of the bucket.

Returns:

the BucketSettings if found or an empty observable if not found.

hasBucket

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

Description copied from interface: AsyncClusterManager

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.

Specified by:

hasBucket in interface AsyncClusterManager

Parameters:

name - the name of the bucket.

Returns:

true if it was found, false otherwise.

removeBucket

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

Description copied from interface: AsyncClusterManager

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.

Specified by:

removeBucket in interface AsyncClusterManager

Parameters:

name - the name of the bucket.

Returns:

true if the removal was successful, false otherwise.

insertBucket

public rx.Observable<BucketSettings> insertBucket(BucketSettings settings)

Description copied from interface: AsyncClusterManager

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.

Specified by:

insertBucket in interface AsyncClusterManager

Parameters:

settings - the bucket settings that should be applied.

Returns:

the stored bucket settings if succeeded.

updateBucket

public rx.Observable<BucketSettings> updateBucket(BucketSettings settings)

Description copied from interface: AsyncClusterManager

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.

Specified by:

updateBucket in interface AsyncClusterManager

Parameters:

settings - the bucket settings that should be applied.

Returns:

the updated bucket settings if succeeded.