com.couchbase.mock

Class CouchbaseMock

java.lang.Object

com.couchbase.mock.CouchbaseMock

public class CouchbaseMock
extends Object

This class is the main entry point to the Mock cluster. It represents a "Cluster" of sorts. Unlike in a real cluster, the mock "Nodes" do not support multi-tenancy, or in other words, a single "Node" can only serve a single bucket. From a client perspective this should not matter, but it is important to keep this aspect in mind.

Constructor Summary

Constructors

Constructor and Description
CouchbaseMock(int port, List<BucketConfiguration> configs) Create a new CouchbaseMock object.
CouchbaseMock(String hostname, int port, int numNodes, int numVBuckets)
CouchbaseMock(String hostname, int port, int numNodes, int bucketStartPort, int numVBuckets)
CouchbaseMock(String hostname, int port, int numNodes, int bucketStartPort, int numVBuckets, String bucketSpec, int numReplicas)
CouchbaseMock(String hostname, int port, int numNodes, int numVBuckets, String bucketSpec)

Method Summary

Modifier and Type	Method and Description
void	clearInitialConfigs() Clear the initial bucket configurations which were added during construction.
void	createBucket(BucketConfiguration config) Create a new bucket, and start it.
Authenticator	getAuthenticator() Get the authenticator object which can be used to verify credentials for access to the cluster
Map<String,Bucket>	getBuckets() Return the list of active buckets for inspection.
BucketConfiguration	getDefaultConfig() Get the default configuration for buckets.
MockCommandDispatcher	getDispatcher()
String	getHttpHost() Get the name of the host to which the REST API is bound
int	getHttpPort() Get The port of the http server providing the REST interface.
HarakiriMonitor	getMonitor()
String	getPoolName()
PoolsHandler	getPoolsHandler()
Map<String,User>	getUsers()
boolean	isCccpBootstrap()
static void	main(String[] args)
void	removeBucket(String name) Destroy a bucket
void	start() Start the mock.
void	startHarakiriMonitor(InetSocketAddress address, boolean terminate) Tell the harakiri monitor to connect to the given address.
void	startHarakiriMonitor(String host, boolean terminate) Start the monitor see startHarakiriMonitor(java.net.InetSocketAddress, boolean)
void	stop() Stops the cluster.
void	waitForStartup() Wait until all initial buckets have been created

Methods inherited from class java.lang.Object

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

Constructor Detail

CouchbaseMock

public CouchbaseMock(String hostname,
                     int port,
                     int numNodes,
                     int bucketStartPort,
                     int numVBuckets,
                     String bucketSpec,
                     int numReplicas)
              throws IOException

Throws:

IOException

CouchbaseMock

public CouchbaseMock(String hostname,
                     int port,
                     int numNodes,
                     int bucketStartPort,
                     int numVBuckets)
              throws IOException

Throws:

IOException

CouchbaseMock

public CouchbaseMock(String hostname,
                     int port,
                     int numNodes,
                     int numVBuckets)
              throws IOException

Throws:

IOException

CouchbaseMock

public CouchbaseMock(String hostname,
                     int port,
                     int numNodes,
                     int numVBuckets,
                     String bucketSpec)
              throws IOException

Throws:

IOException

CouchbaseMock

public CouchbaseMock(int port,
                     List<BucketConfiguration> configs)
              throws IOException

Create a new CouchbaseMock object.

Parameters:

port - The REST port which the mock should listen on. If set to 0, a random available port will be selected

configs - A list of bucket configurations which the mock should start when the start() method is called.

Throws:

IOException - if an I/O error occurs

Method Detail

isCccpBootstrap

public boolean isCccpBootstrap()

startHarakiriMonitor

public void startHarakiriMonitor(InetSocketAddress address,
                                 boolean terminate)
                          throws IOException

Tell the harakiri monitor to connect to the given address.

Parameters:

address - The address the monitor should connect to

terminate - Whether the application should exit when a disconnect is detected on the socket

Throws:

IOException - If the monitor could not listen on the given port, or if the monitor is already listening

startHarakiriMonitor

public void startHarakiriMonitor(String host,
                                 boolean terminate)
                          throws IOException

Start the monitor see startHarakiriMonitor(java.net.InetSocketAddress, boolean)

Parameters:

host - A string in the form of host:port

terminate - Whether the application should terminate on disconnect

Throws:

IOException - If an I/O error occurs

getPoolName

public String getPoolName()

getBuckets

public Map<String,Bucket> getBuckets()

Return the list of active buckets for inspection. The returned value should not be modified. Use createBucket(BucketConfiguration) or removeBucket(String) to add or remove buckets

Returns:

active buckets

clearInitialConfigs

public void clearInitialConfigs()

Clear the initial bucket configurations which were added during construction. This should be used if you want start() to start up a blank cluster.

getMonitor

public HarakiriMonitor getMonitor()

getDispatcher

public MockCommandDispatcher getDispatcher()

getPoolsHandler

public PoolsHandler getPoolsHandler()

getDefaultConfig

public BucketConfiguration getDefaultConfig()

Get the default configuration for buckets. The default configuration is determined by values passed to the constructor.

Returns:

A copy of the default configuration. This may be passed as the first argument to BucketConfiguration

waitForStartup

public void waitForStartup()
                    throws InterruptedException

Wait until all initial buckets have been created

Throws:

InterruptedException - if interrupted

getHttpPort

public int getHttpPort()

Get The port of the http server providing the REST interface.

Returns:

The REST API port

getHttpHost

public String getHttpHost()

Get the name of the host to which the REST API is bound

Returns:

The bound host

getAuthenticator

public Authenticator getAuthenticator()

Get the authenticator object which can be used to verify credentials for access to the cluster

Returns:

The authenticator

createBucket

public void createBucket(BucketConfiguration config)
                  throws BucketAlreadyExistsException,
                         IOException

Create a new bucket, and start it.

Parameters:

config - The bucket configuration to use

Throws:

BucketAlreadyExistsException - If the bucket already exists

IOException - If an I/O error occurs

removeBucket

public void removeBucket(String name)
                  throws FileNotFoundException

Destroy a bucket

Parameters:

name - The name of the bucket to remove

Throws:

FileNotFoundException - If the bucket does not exist

start

public void start()
           throws IOException

Start the mock. This will open the REST API port and initialize any buckets which are configured in the initial configuration list. To stop the cluster, invoke stop()

Throws:

IOException - If an I/O error occurs

stop

public void stop()

Stops the cluster. This stops the server listening on the REST API port, and also destroys any buckets which are part of the cluster.

main

public static void main(String[] args)

getUsers

public Map<String,User> getUsers()