com.couchbase.client.java.bucket

Class DefaultAsyncBucketManager

java.lang.Object

com.couchbase.client.java.bucket.DefaultAsyncBucketManager

All Implemented Interfaces:

AsyncBucketManager

public class DefaultAsyncBucketManager
extends java.lang.Object
implements AsyncBucketManager

Default implementation of a AsyncBucketManager.

Since:

2.0

Method Summary

Methods

Modifier and Type	Method and Description
static DefaultAsyncBucketManager	create(java.lang.String bucket, java.lang.String password, com.couchbase.client.core.ClusterFacade core)
rx.Observable<java.lang.Boolean>	flush() Flushes the bucket (removes all data).
rx.Observable<DesignDocument>	getDesignDocument(java.lang.String name) Loads a published DesignDocument by its name.
rx.Observable<DesignDocument>	getDesignDocument(java.lang.String name, boolean development) Loads a DesignDocument by its name from either development or production.
rx.Observable<DesignDocument>	getDesignDocuments() Loads all published DesignDocuments.
rx.Observable<DesignDocument>	getDesignDocuments(boolean development) Loads all DesignDocuments from development or production.
rx.Observable<BucketInfo>	info() Returns information about the connected bucket.
rx.Observable<DesignDocument>	insertDesignDocument(DesignDocument designDocument) Inserts a DesignDocument into production if it does not exist.
rx.Observable<DesignDocument>	insertDesignDocument(DesignDocument designDocument, boolean development) Inserts a DesignDocument into development or production if it does not exist.
rx.Observable<DesignDocument>	publishDesignDocument(java.lang.String name) Publishes a DesignDocument from development into production.
rx.Observable<DesignDocument>	publishDesignDocument(java.lang.String name, boolean overwrite) Publishes a DesignDocument from development into production.
rx.Observable<java.lang.Boolean>	removeDesignDocument(java.lang.String name) Removes a DesignDocument from production by its name.
rx.Observable<java.lang.Boolean>	removeDesignDocument(java.lang.String name, boolean development) Removes a DesignDocument from production or development by its name.
rx.Observable<DesignDocument>	upsertDesignDocument(DesignDocument designDocument) Upserts (inserts or replaces) a DesignDocument into production.
rx.Observable<DesignDocument>	upsertDesignDocument(DesignDocument designDocument, boolean development) Upserts (inserts or replaces) a DesignDocument into production or development.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static DefaultAsyncBucketManager create(java.lang.String bucket,
                               java.lang.String password,
                               com.couchbase.client.core.ClusterFacade core)

info

public rx.Observable<BucketInfo> info()

Description copied from interface: AsyncBucketManager

Returns information about the connected bucket.

The Observable can error under the following conditions:

• com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.

Specified by:

info in interface AsyncBucketManager

Returns:

bucket information wrapped in a BucketInfo.

flush

public rx.Observable<java.lang.Boolean> flush()

Description copied from interface: AsyncBucketManager

Flushes the bucket (removes all data).

Note that flush needs to be enabled on the bucket, otherwise an exception will be raised.

The Observable can error under the following conditions:

• com.couchbase.client.java.error.FlushDisabledException: If flush is disabled.
• com.couchbase.client.core.CouchbaseException: If the server response could not be parsed.

Specified by:

flush in interface AsyncBucketManager

Returns:

true if the bucket was flushed, an failed Observable otherwise.

getDesignDocuments

public rx.Observable<DesignDocument> getDesignDocuments()

Description copied from interface: AsyncBucketManager

Loads all published DesignDocuments.

The Observable can error under the following conditions:

• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Specified by:

getDesignDocuments in interface AsyncBucketManager

Returns:

zero to N invocations containing published DesignDocuments.

getDesignDocuments

public rx.Observable<DesignDocument> getDesignDocuments(boolean development)

Description copied from interface: AsyncBucketManager

Loads all DesignDocuments from development or production.

The Observable can error under the following conditions:

• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Specified by:

getDesignDocuments in interface AsyncBucketManager

Parameters:

development - if the DesignDocuments should be loaded from development or production.

Returns:

zero to N invocations containing published DesignDocuments.

getDesignDocument

public rx.Observable<DesignDocument> getDesignDocument(java.lang.String name)

Description copied from interface: AsyncBucketManager

Loads a published DesignDocument by its name.

The Observable can error under the following conditions:

• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Specified by:

getDesignDocument in interface AsyncBucketManager

Parameters:

name - the name of the DesignDocument.

Returns:

and empty observable if the document not found or a DesignDocument.

getDesignDocument

public rx.Observable<DesignDocument> getDesignDocument(java.lang.String name,
                                              boolean development)

Description copied from interface: AsyncBucketManager

Loads a DesignDocument by its name from either development or production.

The Observable can error under the following conditions:

• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Specified by:

getDesignDocument in interface AsyncBucketManager

Parameters:

name - the name of the DesignDocument.

development - if it should be loaded from development or production.

Returns:

and empty observable if the document not found or a DesignDocument.

insertDesignDocument

public rx.Observable<DesignDocument> insertDesignDocument(DesignDocument designDocument)

Description copied from interface: AsyncBucketManager

Inserts a DesignDocument into production if it does not exist.

Note that inserting a DesignDocument is not an atomic operation, but instead internally performs a AsyncBucketManager.getDesignDocument(String) operation first. While expected to be very uncommon, a race condition may happen if two users at the same time perform this operation with the same DesignDocument.

The Observable can error under the following conditions:

• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
• com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument exists.

Specified by:

insertDesignDocument in interface AsyncBucketManager

Parameters:

designDocument - the DesignDocument to insert.

Returns:

the inserted DesignDocument on success.

insertDesignDocument

public rx.Observable<DesignDocument> insertDesignDocument(DesignDocument designDocument,
                                                 boolean development)

Description copied from interface: AsyncBucketManager

Inserts a DesignDocument into development or production if it does not exist.

Note that inserting a DesignDocument is not an atomic operation, but instead internally performs a AsyncBucketManager.getDesignDocument(String) operation first. While expected to be very uncommon, a race condition may happen if two users at the same time perform this operation with the same DesignDocument.

The Observable can error under the following conditions:

• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
• com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument exists.

Specified by:

insertDesignDocument in interface AsyncBucketManager

Parameters:

designDocument - the DesignDocument to insert.

development - if it should be inserted into development or production (published).

Returns:

the inserted DesignDocument on success.

upsertDesignDocument

public rx.Observable<DesignDocument> upsertDesignDocument(DesignDocument designDocument)

Description copied from interface: AsyncBucketManager

Upserts (inserts or replaces) a DesignDocument into production.

The Observable can error under the following conditions:

• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Specified by:

upsertDesignDocument in interface AsyncBucketManager

Parameters:

designDocument - the DesignDocument to upsert.

Returns:

the upserted DesignDocument on success.

upsertDesignDocument

public rx.Observable<DesignDocument> upsertDesignDocument(DesignDocument designDocument,
                                                 boolean development)

Description copied from interface: AsyncBucketManager

Upserts (inserts or replaces) a DesignDocument into production or development.

The Observable can error under the following conditions:

• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Specified by:

upsertDesignDocument in interface AsyncBucketManager

Parameters:

designDocument - the DesignDocument to upsert.

development - if the DesignDocument should be upserted into development or production.

Returns:

the upserted DesignDocument on success.

removeDesignDocument

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

Description copied from interface: AsyncBucketManager

Removes a DesignDocument from production by its name.

Specified by:

removeDesignDocument in interface AsyncBucketManager

Parameters:

name - the name of the DesignDocument.

Returns:

true if succeeded, false otherwise.

removeDesignDocument

public rx.Observable<java.lang.Boolean> removeDesignDocument(java.lang.String name,
                                                    boolean development)

Description copied from interface: AsyncBucketManager

Removes a DesignDocument from production or development by its name.

Specified by:

removeDesignDocument in interface AsyncBucketManager

Parameters:

name - the name of the DesignDocument.

development - if the DesignDocument should be removed from development or production.

Returns:

true if succeeded, false otherwise.

publishDesignDocument

public rx.Observable<DesignDocument> publishDesignDocument(java.lang.String name)

Description copied from interface: AsyncBucketManager

Publishes a DesignDocument from development into production.

Note that this method does not override a already existing DesignDocument (see AsyncBucketManager.publishDesignDocument(String, boolean)) as an alternative.

The Observable can error under the following conditions:

• com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument already exists.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Specified by:

publishDesignDocument in interface AsyncBucketManager

Parameters:

name - the name of the DesignDocument to publish.

Returns:

the published DesignDocument on success.

publishDesignDocument

public rx.Observable<DesignDocument> publishDesignDocument(java.lang.String name,
                                                  boolean overwrite)

Description copied from interface: AsyncBucketManager

Publishes a DesignDocument from development into production.

The Observable can error under the following conditions:

• com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument already exists and override is set to false.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Specified by:

publishDesignDocument in interface AsyncBucketManager

Parameters:

name - the name of the DesignDocument to publish.

overwrite - if an existing DesignDocument should be overridden.

Returns:

the published DesignDocument on success.