com.couchbase.client.java.bucket

Interface BucketManager

All Known Implementing Classes:

DefaultBucketManager

@InterfaceStability.Committed
 @InterfaceAudience.Public
public interface BucketManager

Provides management capabilities for a Bucket.

Operations provided on the BucketManager can be used to perform administrative tasks which require bucket-level credentials like managing DesignDocuments or flushing a Bucket. Access to the underlying AsyncBucketManager is provided through the async() method.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
AsyncBucketManager	async() Returns the underlying AsyncBucketManager for asynchronous execution.
Boolean	flush() Flushes the bucket (removes all data) with the default management timeout.
Boolean	flush(long timeout, TimeUnit timeUnit) Flushes the bucket (removes all data) with a custom timeout.
DesignDocument	getDesignDocument(String name) Loads a published DesignDocument by its name with the default management timeout.
DesignDocument	getDesignDocument(String name, boolean development) Loads a DesignDocument by its name from either development or production with the default management timeout.
DesignDocument	getDesignDocument(String name, boolean development, long timeout, TimeUnit timeUnit) Loads a DesignDocuments by its name from either development or production with a custom timeout.
DesignDocument	getDesignDocument(String name, long timeout, TimeUnit timeUnit) Loads a published DesignDocument by its name with the a custom timeout.
List<DesignDocument>	getDesignDocuments() Loads all published DesignDocuments with the default management timeout.
List<DesignDocument>	getDesignDocuments(boolean development) Loads all DesignDocuments from either development or production with the default management timeout.
List<DesignDocument>	getDesignDocuments(boolean development, long timeout, TimeUnit timeUnit) Loads all DesignDocuments from either development or production with a custom timeout.
List<DesignDocument>	getDesignDocuments(long timeout, TimeUnit timeUnit) Loads all published DesignDocuments with a custom timeout.
BucketInfo	info() Returns information about the connected bucket with the default management timeout.
BucketInfo	info(long timeout, TimeUnit timeUnit) Returns information about the connected bucket with a custom timeout.
DesignDocument	insertDesignDocument(DesignDocument designDocument) Inserts a DesignDocument into production if it does not exist with the default management timeout.
DesignDocument	insertDesignDocument(DesignDocument designDocument, boolean development) Inserts a DesignDocument into development or production if it does not exist with the default management timeout.
DesignDocument	insertDesignDocument(DesignDocument designDocument, boolean development, long timeout, TimeUnit timeUnit) Inserts a DesignDocument into development or production if it does not exist with a custom timeout.
DesignDocument	insertDesignDocument(DesignDocument designDocument, long timeout, TimeUnit timeUnit) Inserts a DesignDocument into production if it does not exist with a custom timeout.
DesignDocument	publishDesignDocument(String name) Publishes a DesignDocument from development into production with the default management timeout.
DesignDocument	publishDesignDocument(String name, boolean overwrite) Publishes a DesignDocument from development into production with the default management timeout.
DesignDocument	publishDesignDocument(String name, boolean overwrite, long timeout, TimeUnit timeUnit) Publishes a DesignDocument from development into production with a custom timeout.
DesignDocument	publishDesignDocument(String name, long timeout, TimeUnit timeUnit) Publishes a DesignDocument from development into production with a custom timeout.
Boolean	removeDesignDocument(String name) Removes a DesignDocument from production by its name with the default management timeout.
Boolean	removeDesignDocument(String name, boolean development) Removes a DesignDocument from production or development by its name with the default management timeout.
Boolean	removeDesignDocument(String name, boolean development, long timeout, TimeUnit timeUnit) Removes a DesignDocument from production or development by its name with a custom timeout.
Boolean	removeDesignDocument(String name, long timeout, TimeUnit timeUnit) Removes a DesignDocument from production by its name with a custom timeout.
DesignDocument	upsertDesignDocument(DesignDocument designDocument) Upserts (inserts or replaces) a DesignDocument into production with the default management timeout.
DesignDocument	upsertDesignDocument(DesignDocument designDocument, boolean development) Upserts (inserts or replaces) a DesignDocument into production or development with the default management timeout.
DesignDocument	upsertDesignDocument(DesignDocument designDocument, boolean development, long timeout, TimeUnit timeUnit) Upserts (inserts or replaces) a DesignDocument into production or development with a custom timeout.
DesignDocument	upsertDesignDocument(DesignDocument designDocument, long timeout, TimeUnit timeUnit) Upserts (inserts or replaces) a DesignDocument into production with a custom timeout.

Method Detail

async

AsyncBucketManager async()

Returns the underlying AsyncBucketManager for asynchronous execution.

Returns:

the underlying bucket manager.

info

BucketInfo info()

Returns information about the connected bucket with the default management timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.

Returns:

bucket information wrapped in a BucketInfo.

info

BucketInfo info(long timeout,
                TimeUnit timeUnit)

Returns information about the connected bucket with a custom timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Parameters:

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

bucket information wrapped in a BucketInfo.

flush

Boolean flush()

Flushes the bucket (removes all data) with the default management timeout.

Note that flushing takes some time on the server to be performed properly, so do not set a too low timeout. Also, flush needs to be enabled on the bucket, otherwise an exception will be raised.

This method throws:

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

Returns:

true if the bucket was flushed, an exception thrown if otherwise.

flush

Boolean flush(long timeout,
              TimeUnit timeUnit)

Flushes the bucket (removes all data) with a custom timeout.

Note that flushing takes some time on the server to be performed properly, so do not set a too low timeout. Also, flush needs to be enabled on the bucket, otherwise an exception will be raised.

This method throws:

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

Parameters:

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

true if the bucket was flushed, an exception thrown if otherwise.

getDesignDocuments

List<DesignDocument> getDesignDocuments()

Loads all published DesignDocuments with the default management timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Returns:

a potentially empty list containing published DesignDocuments.

getDesignDocuments

List<DesignDocument> getDesignDocuments(long timeout,
                                        TimeUnit timeUnit)

Loads all published DesignDocuments with a custom timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Parameters:

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

a potentially empty list containing published DesignDocuments.

getDesignDocuments

List<DesignDocument> getDesignDocuments(boolean development)

Loads all DesignDocuments from either development or production with the default management timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Parameters:

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

Returns:

a potentially empty list containing published DesignDocuments.

getDesignDocuments

List<DesignDocument> getDesignDocuments(boolean development,
                                        long timeout,
                                        TimeUnit timeUnit)

Loads all DesignDocuments from either development or production with a custom timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Parameters:

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

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

a potentially empty list containing published DesignDocuments.

getDesignDocument

DesignDocument getDesignDocument(String name)

Loads a published DesignDocument by its name with the default management timeout.

If the DesignDocument is not found, null is returned.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Parameters:

name - the name of the DesignDocument.

Returns:

null if the document not found or a DesignDocument.

getDesignDocument

DesignDocument getDesignDocument(String name,
                                 long timeout,
                                 TimeUnit timeUnit)

Loads a published DesignDocument by its name with the a custom timeout.

If the DesignDocument is not found, null is returned.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Parameters:

name - the name of the DesignDocument.

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

null if the document not found or a DesignDocument.

getDesignDocument

DesignDocument getDesignDocument(String name,
                                 boolean development)

Loads a DesignDocument by its name from either development or production with the default management timeout.

If the DesignDocument is not found, null is returned.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Parameters:

name - the name of the DesignDocument.

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

Returns:

null if the document not found or a DesignDocument.

getDesignDocument

DesignDocument getDesignDocument(String name,
                                 boolean development,
                                 long timeout,
                                 TimeUnit timeUnit)

Loads a DesignDocuments by its name from either development or production with a custom timeout.

If the DesignDocument is not found, null is returned.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Parameters:

name - the name of the DesignDocument.

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

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

null if the document not found or a DesignDocument.

insertDesignDocument

DesignDocument insertDesignDocument(DesignDocument designDocument)

Inserts a DesignDocument into production if it does not exist with the default management timeout.

Note that inserting a DesignDocument is not an atomic operation, but instead internally performs a 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.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
• com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument exists.

Parameters:

designDocument - the DesignDocument to insert.

Returns:

the inserted DesignDocument on success.

insertDesignDocument

DesignDocument insertDesignDocument(DesignDocument designDocument,
                                    long timeout,
                                    TimeUnit timeUnit)

Inserts a DesignDocument into production if it does not exist with a custom timeout.

Note that inserting a DesignDocument is not an atomic operation, but instead internally performs a 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.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
• com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument exists.

Parameters:

designDocument - the DesignDocument to insert.

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the inserted DesignDocument on success.

insertDesignDocument

DesignDocument insertDesignDocument(DesignDocument designDocument,
                                    boolean development)

Inserts a DesignDocument into development or production if it does not exist with the default management timeout.

Note that inserting a DesignDocument is not an atomic operation, but instead internally performs a 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.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
• com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument exists.

Parameters:

designDocument - the DesignDocument to insert.

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

Returns:

the inserted DesignDocument on success.

insertDesignDocument

DesignDocument insertDesignDocument(DesignDocument designDocument,
                                    boolean development,
                                    long timeout,
                                    TimeUnit timeUnit)

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

Note that inserting a DesignDocument is not an atomic operation, but instead internally performs a 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.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
• com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument exists.

Parameters:

designDocument - the DesignDocument to insert.

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

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the inserted DesignDocument on success.

upsertDesignDocument

DesignDocument upsertDesignDocument(DesignDocument designDocument)

Upserts (inserts or replaces) a DesignDocument into production with the default management timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Parameters:

designDocument - the DesignDocument to upsert.

Returns:

the upserted DesignDocument on success.

upsertDesignDocument

DesignDocument upsertDesignDocument(DesignDocument designDocument,
                                    long timeout,
                                    TimeUnit timeUnit)

Upserts (inserts or replaces) a DesignDocument into production with a custom timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Parameters:

designDocument - the DesignDocument to upsert.

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the upserted DesignDocument on success.

upsertDesignDocument

DesignDocument upsertDesignDocument(DesignDocument designDocument,
                                    boolean development)

Upserts (inserts or replaces) a DesignDocument into production or development with the default management timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Parameters:

designDocument - the DesignDocument to upsert.

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

Returns:

the upserted DesignDocument on success.

upsertDesignDocument

DesignDocument upsertDesignDocument(DesignDocument designDocument,
                                    boolean development,
                                    long timeout,
                                    TimeUnit timeUnit)

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

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.

Parameters:

designDocument - the DesignDocument to upsert.

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

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the upserted DesignDocument on success.

removeDesignDocument

Boolean removeDesignDocument(String name)

Removes a DesignDocument from production by its name with the default management timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.

Parameters:

name - the name of the DesignDocument.

Returns:

true if succeeded, false otherwise.

removeDesignDocument

Boolean removeDesignDocument(String name,
                             long timeout,
                             TimeUnit timeUnit)

Removes a DesignDocument from production by its name with a custom timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.

Parameters:

name - the name of the DesignDocument.

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

true if succeeded, false otherwise.

removeDesignDocument

Boolean removeDesignDocument(String name,
                             boolean development)

Removes a DesignDocument from production or development by its name with the default management timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.

Parameters:

name - the name of the DesignDocument.

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

Returns:

true if succeeded, false otherwise.

removeDesignDocument

Boolean removeDesignDocument(String name,
                             boolean development,
                             long timeout,
                             TimeUnit timeUnit)

Removes a DesignDocument from production or development by its name with a custom timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.

Parameters:

name - the name of the DesignDocument.

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

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

true if succeeded, false otherwise.

publishDesignDocument

DesignDocument publishDesignDocument(String name)

Publishes a DesignDocument from development into production with the default management timeout.

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

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• 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.

Parameters:

name - the name of the DesignDocument to publish.

Returns:

the published DesignDocument on success.

publishDesignDocument

DesignDocument publishDesignDocument(String name,
                                     long timeout,
                                     TimeUnit timeUnit)

Publishes a DesignDocument from development into production with a custom timeout.

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

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• 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.

Parameters:

name - the name of the DesignDocument to publish.

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the published DesignDocument on success.

publishDesignDocument

DesignDocument publishDesignDocument(String name,
                                     boolean overwrite)

Publishes a DesignDocument from development into production with the default management timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• 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.

Parameters:

name - the name of the DesignDocument to publish.

overwrite - if an existing DesignDocument should be overridden.

Returns:

the published DesignDocument on success.

publishDesignDocument

DesignDocument publishDesignDocument(String name,
                                     boolean overwrite,
                                     long timeout,
                                     TimeUnit timeUnit)

Publishes a DesignDocument from development into production with a custom timeout.

This method throws:

• java.util.concurrent.TimeoutException: If the timeout is exceeded.
• 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.

Parameters:

name - the name of the DesignDocument to publish.

overwrite - if an existing DesignDocument should be overridden.

timeout - the custom timeout.

timeUnit - the time unit for the custom timeout.

Returns:

the published DesignDocument on success.