com.couchbase.mock

Class Bucket

java.lang.Object

com.couchbase.mock.Bucket

Direct Known Subclasses:

CouchbaseBucket, MemcachedBucket

public abstract class Bucket
extends Object

Abstract class for all bucket types in Couchbase. see CouchbaseBucket see MemcachedBucket A bucket is instantiated via CouchbaseMock.createBucket(BucketConfiguration). The number of servers a bucket has is limited to the amount provided in the BucketConfiguration.numNodes field. Nodes can be removed and then re-added, but currently new nodes cannot be added once the bucket has been instantiated.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Bucket.BucketType

Field Summary

Fields

Modifier and Type	Field and Description
protected CouchbaseMock	cluster
protected ReentrantReadWriteLock	configurationRwLock
protected String	name
protected int	numReplicas
protected int	numVBuckets
protected String	password
protected String	poolName
protected MemcachedServer[]	servers
protected VBucketInfo[]	vbInfo

Constructor Summary

Constructors

Constructor and Description
Bucket(CouchbaseMock cluster, BucketConfiguration config)

Method Summary

Modifier and Type	Method and Description
List<MemcachedServer>	activeServers() Gets the list of active nodes within the bucket.
void	configReadLock() Lock the current configuration for reading.
void	configReadUnlock() Unlock the configuration read lock.
static Bucket	create(CouchbaseMock mock, BucketConfiguration config) Create a bucket.
void	failover(int index, boolean rebalance) Fail over one of the bucket's nodes
BucketAdminServer	getAdminServer() Get the object used for handling configuration changes
CAPIServer	getCAPIServer() Get the CAPIServer object used for managing views.
CouchbaseMock	getCluster() Gets the parent CouchbaseMock object
protected Map<String,Object>	getCommonConfig() Returns configuration information common to both Couchbase and Memcached buckets
abstract Map<String,Object>	getConfigMap() Gets a map of the current bucket configuration which can be JSON-serialized as a valid "Cluster configuration".
String	getJSON() Convenience method to get the JSON-encoded version of the configuration map getConfigMap()
Iterable<Item>	getMasterItems(Storage.StorageType type) Returns an iterable over all the items in this bucket
String	getName() Get the name of the bucket
String	getPassword() Get the password for this bucket.
MemcachedServer[]	getServers() Get the list of servers allocated for this bucket.
abstract Bucket.BucketType	getType() Gets the type of the bucket
String	getUUID() Gets the UUID for the bucket.
short	getVbIndexForKey(String key) Get the server index for a given key
VBucketInfo[]	getVBucketInfo() Returns the vBucket map for the given bucket.
void	regenCoords()
void	respawn(int index) Re-Add a previously failed-over node
abstract ErrorCode	storeItem(String key, byte[] value) Convenience method to store an item in a bucket

Methods inherited from class java.lang.Object

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

Field Detail

vbInfo

protected final VBucketInfo[] vbInfo

servers

protected final MemcachedServer[] servers

numVBuckets

protected final int numVBuckets

numReplicas

protected final int numReplicas

poolName

protected final String poolName

See Also:

Constant Field Values

name

protected final String name

cluster

protected final CouchbaseMock cluster

password

protected final String password

configurationRwLock

protected final ReentrantReadWriteLock configurationRwLock

Constructor Detail

Bucket

public Bucket(CouchbaseMock cluster,
              BucketConfiguration config)
       throws IOException

Throws:

IOException

Method Detail

getVBucketInfo

public VBucketInfo[] getVBucketInfo()

Returns the vBucket map for the given bucket. This is only relevant for CouchbaseBucket

Returns:

An array of vBucket map structures

getServers

public MemcachedServer[] getServers()

Get the list of servers allocated for this bucket. This returns both active and inactive servers

Returns:

an array of servers for this bucket.

getMasterItems

public Iterable<Item> getMasterItems(Storage.StorageType type)

Returns an iterable over all the items in this bucket

Parameters:

type - The storage location to fetch from

Returns:

An iterable which will return all items in the bucket. Note this currently makes a copy of the items list, making it thread safe. It also means that this will potentially return stale data

getVbIndexForKey

public short getVbIndexForKey(String key)

Get the server index for a given key

Parameters:

key - The key to look up

Returns:

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

create

public static Bucket create(CouchbaseMock mock,
                            BucketConfiguration config)
                     throws IOException

Create a bucket.

Parameters:

mock - The cluster this bucket is a member of

config - The configuration for the bucket

Returns:

The newly instantiated subclass

Throws:

IOException - if an I/O error occurs

getType

public abstract Bucket.BucketType getType()

Gets the type of the bucket

Returns:

The type of the bucket

getCAPIServer

public CAPIServer getCAPIServer()

Get the CAPIServer object used for managing views.

Returns:

The view manager

getAdminServer

public BucketAdminServer getAdminServer()

Get the object used for handling configuration changes

Returns:

The configuration manager

getConfigMap

public abstract Map<String,Object> getConfigMap()

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.

Returns:

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

getCommonConfig

protected Map<String,Object> getCommonConfig()

Returns configuration information common to both Couchbase and Memcached buckets

Returns:

The configuration object to be injected

getJSON

public final String getJSON()

Convenience method to get the JSON-encoded version of the configuration map getConfigMap()

Returns:

An encoded JSON String

configReadLock

public void configReadLock()

Lock the current configuration for reading. As long as this lock is held, any configuration changes to the bucket (such as failover, removing a node, rebalances, etc.) will be blocked. Be sure to call configReadUnlock() once the lock is no longer required. This method is most useful to ensure that the bucket state remains the same while reading configuration-related properties.

configReadUnlock

public void configReadUnlock()

Unlock the configuration read lock. This is the exit bracket for configReadLock()

storeItem

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

Convenience method to store an item in a bucket

Parameters:

key - The key of the item

value - The value of the item

Returns:

The status of the operation

failover

public void failover(int index,
                     boolean rebalance)

Fail over one of the bucket's nodes

Parameters:

index - The index of the node to fail over. This index is the index of the node within the servers (or getServers() array; not the logical index within the vBucket map!

rebalance - Should we rebalance after failover Note this will also automatically rebalance the cluster

respawn

public void respawn(int index)

Re-Add a previously failed-over node

Parameters:

index - The index to restore. This should be an index into the servers array.

activeServers

public List<MemcachedServer> activeServers()

Gets the list of active nodes within the bucket. An active node is one that is not failed over

Returns:

The list of active nodes in the cluster.

regenCoords

public void regenCoords()

getPassword

public String getPassword()

Get the password for this bucket.

Returns:

The password

getName

public String getName()

Get the name of the bucket

Returns:

name

getUUID

public String getUUID()

Gets the UUID for the bucket. This is only used to generate the stats response

Returns:

bucket uuid

getCluster

public CouchbaseMock getCluster()

Gets the parent CouchbaseMock object

Returns:

parent