com.couchbase.mock

Class CouchbaseBucket

java.lang.Object

com.couchbase.mock.Bucket

com.couchbase.mock.CouchbaseBucket

public class CouchbaseBucket
extends Bucket

Representation of a membase bucket

Author:

Trond Norbye

Nested Class Summary

Nested classes/interfaces inherited from class com.couchbase.mock.Bucket

Bucket.BucketType

Field Summary

Fields inherited from class com.couchbase.mock.Bucket

cluster, configurationRwLock, name, numReplicas, numVBuckets, password, poolName, servers, vbInfo

Constructor Summary

Constructors

Constructor and Description
CouchbaseBucket(CouchbaseMock cluster, BucketConfiguration config)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getConfigMap() Gets a map of the current bucket configuration which can be JSON-serialized as a valid "Cluster configuration".
Bucket.BucketType	getType() Gets the type of the bucket
short	getVbIndexForKey(String key) Get the server index for a given key
ErrorCode	storeItem(String key, byte[] value) Convenience method to store an item in a bucket

Methods inherited from class com.couchbase.mock.Bucket

activeServers, configReadLock, configReadUnlock, create, failover, getAdminServer, getCAPIServer, getCluster, getCommonConfig, getJSON, getMasterItems, getName, getPassword, getServers, getUUID, getVBucketInfo, regenCoords, respawn

Methods inherited from class java.lang.Object

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

Constructor Detail

CouchbaseBucket

public CouchbaseBucket(CouchbaseMock cluster,
                       BucketConfiguration config)
                throws IOException

Throws:

IOException

Method Detail

getVbIndexForKey

public short getVbIndexForKey(String key)

Description copied from class: Bucket

Get the server index for a given key

Overrides:

getVbIndexForKey in class Bucket

Parameters:

key - The key to look up

Returns:

an index which can be used in the servers array (via getServers)

getConfigMap

public Map<String,Object> getConfigMap()

Description copied from class: Bucket

Gets a map of the current bucket configuration which can be JSON-serialized as a valid "Cluster configuration". This method is useful for other configuration handlers which wish to embed the current bucket's configuration into a larger structure. The information returned is equivalent to that returned via the /pools/default/buckets/$bucket endpoint in a Couchbase cluster.

Specified by:

getConfigMap in class Bucket

Returns:

A map representing the cluster configuration Note that to avoid race conditions, invoke Bucket.configReadLock() before calling this method, and Bucket.configReadUnlock() after calling this method.

getType

public Bucket.BucketType getType()

Description copied from class: Bucket

Gets the type of the bucket

Specified by:

getType in class Bucket

Returns:

The type of the bucket

storeItem

public ErrorCode storeItem(String key,
                           byte[] value)

Description copied from class: Bucket

Convenience method to store an item in a bucket

Specified by:

storeItem in class Bucket

Parameters:

key - The key of the item

value - The value of the item

Returns:

The status of the operation