com.couchbase.mock.control

Class MockCommand

java.lang.Object

com.couchbase.mock.control.MockCommand

Direct Known Subclasses:

BucketCommandHandler, CCCPCommandHandler, EnhancedErrorsCommandHandler, GetMCPortsHandler, KeyCommandHandler, MockHelpCommandHandler, MockInfoCommandHandler, OpfailCommandHandler, ResetQueryStateHandler, ServersCommandHandler, TimeTravelCommandHandler

public abstract class MockCommand
extends Object

The MockCommand class is the base class for all commands that the client may send to the mock to instruct it to do certain actions. All commands is sent as JSON objects with a certain form:

{ "command" : "name of the command", "payload" : { } }

The response for the command will be delivered at its most basic level will be a JSON object consisting of the following fields:

{ "status" : "ok", "payload" : { } }

For "non-successful" commands the object may be:

{ "status" : "fail", "error" : "error description" }

To implement a new command you should subclass the MockCommand class and add implement the execute method. You must add the name of the command to the Command enum, and register the class in MockCommandDispatcher.

Author:

mnunberg

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MockCommand.Command

Constructor Summary

Constructors

Constructor and Description
MockCommand()

Method Summary

Modifier and Type	Method and Description
abstract CommandStatus	execute(CouchbaseMock mock, MockCommand.Command command, com.google.gson.JsonObject payload) Execute the command
protected CommandStatus	getResponse() Get the response to send to the client.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockCommand

public MockCommand()

Method Detail

getResponse

@NotNull
protected CommandStatus getResponse()

Get the response to send to the client.

Returns:

a CommandStatus object indicating the status

execute

@NotNull
public abstract CommandStatus execute(@NotNull
                                               CouchbaseMock mock,
                                               @NotNull
                                               MockCommand.Command command,
                                               @NotNull
                                               com.google.gson.JsonObject payload)

Execute the command

Parameters:

mock - the couchbase mock object to operate on

command - the actual command being executed (in case a handler implements multiple commands

payload - the payload containing arguments to the command

Returns:

command status