net.spy.memcached.protocol.ascii

Class AsciiOperationFactory

java.lang.Object

net.spy.memcached.ops.BaseOperationFactory

net.spy.memcached.protocol.ascii.AsciiOperationFactory

All Implemented Interfaces:

OperationFactory

public class AsciiOperationFactory
extends BaseOperationFactory

Operation factory for the ascii protocol.

Constructor Summary

Constructors

Constructor and Description
AsciiOperationFactory()

Method Summary

Modifier and Type	Method and Description
CASOperation	cas(StoreType type, java.lang.String key, long casId, int flags, int exp, byte[] data, StoreOperation.Callback cb) Create a CAS operation.
ConcatenationOperation	cat(ConcatenationType catType, long casId, java.lang.String key, byte[] data, OperationCallback cb) Get a concatenation operation.
protected java.util.Collection<? extends Operation>	cloneGet(KeyedOperation op)
DeleteOperation	delete(java.lang.String key, DeleteOperation.Callback cb) Create a deletion operation.
DeleteOperation	delete(java.lang.String key, long cas, DeleteOperation.Callback cb) Create a deletion operation with CAS.
DeleteConfigOperation	deleteConfig(ConfigurationType type, OperationCallback cb) Create a deletion operation for config.
FlushOperation	flush(int delay, OperationCallback cb) Create a flush operation.
GetOperation	get(java.util.Collection<java.lang.String> keys, GetOperation.Callback cb) Create a get operation.
GetOperation	get(java.lang.String key, GetOperation.Callback cb) Create a get operation.
GetAndTouchOperation	getAndTouch(java.util.Collection<java.lang.String> keys, int expiration, GetAndTouchOperation.Callback cb)
GetAndTouchOperation	getAndTouch(java.lang.String key, int expiration, GetAndTouchOperation.Callback cb) Gets the value of a key and resets its timeout.
GetConfigOperation	getConfig(ConfigurationType type, GetConfigOperation.Callback cb) Create a getConfig operation.
GetlOperation	getl(java.lang.String key, int exp, GetlOperation.Callback cb) Create a getl operation.
GetsOperation	gets(java.lang.String key, GetsOperation.Callback cb) Create a gets operation.
StatsOperation	keyStats(java.lang.String key, StatsOperation.Callback cb) Get a new KeyStatsOperation.
MutatorOperation	mutate(Mutator m, java.lang.String key, long by, long exp, int def, OperationCallback cb) Create a mutator operation.
NoopOperation	noop(OperationCallback cb) Create a NOOP operation.
ObserveOperation	observe(java.lang.String key, long casId, int index, ObserveOperation.Callback cb) Create an Observe operation.
Operation	refreshCertificate(OperationCallback cb) Refresh the TLS certificate
ReplicaGetOperation	replicaGet(java.lang.String key, int index, ReplicaGetOperation.Callback callback) Create a replica get operation.
ReplicaGetsOperation	replicaGets(java.lang.String key, int index, ReplicaGetsOperation.Callback callback) Create a replica gets operation.
SASLAuthOperation	saslAuth(java.lang.String[] mech, java.lang.String serverName, java.util.Map<java.lang.String,?> props, javax.security.auth.callback.CallbackHandler cbh, OperationCallback cb) Create a new sasl auth operation.
SASLMechsOperation	saslMechs(OperationCallback cb) Create a new SASL mechs operation.
SASLStepOperation	saslStep(java.lang.String[] mech, byte[] challenge, java.lang.String serverName, java.util.Map<java.lang.String,?> props, javax.security.auth.callback.CallbackHandler cbh, OperationCallback cb) Create a new sasl step operation.
SetConfigOperation	setConfig(ConfigurationType type, int flags, byte[] data, OperationCallback cb) Create a setConfig operation.
StatsOperation	stats(java.lang.String arg, StatsOperation.Callback cb) Get a new StatsOperation.
StoreOperation	store(StoreType storeType, java.lang.String key, int flags, int exp, byte[] data, StoreOperation.Callback cb) Create a store operation.
TapOperation	tapAck(TapOpcode opcode, int opaque, OperationCallback cb) Sends a tap ack message to the server.
TapOperation	tapBackfill(java.lang.String id, long date, OperationCallback cb) Creates a tap backfill stream.
TapOperation	tapCustom(java.lang.String id, RequestMessage message, OperationCallback cb) Creates a custom tap stream.
TapOperation	tapDump(java.lang.String id, OperationCallback cb) Sends a tap dump message to the server.
TouchOperation	touch(java.lang.String key, int expiration, OperationCallback cb) Resets a keys expiration time.
UnlockOperation	unlock(java.lang.String key, long casId, OperationCallback cb) Create a Unlock operation.
VersionOperation	version(OperationCallback cb) Create a new version operation.

Methods inherited from class net.spy.memcached.ops.BaseOperationFactory

clone

Methods inherited from class java.lang.Object

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

Constructor Detail

AsciiOperationFactory

public AsciiOperationFactory()

Method Detail

delete

public DeleteOperation delete(java.lang.String key,
                              DeleteOperation.Callback cb)

Description copied from interface: OperationFactory

Create a deletion operation.

Parameters:

key - the key to delete

cb - the status callback

Returns:

the new DeleteOperation

delete

public DeleteOperation delete(java.lang.String key,
                              long cas,
                              DeleteOperation.Callback cb)

Description copied from interface: OperationFactory

Create a deletion operation with CAS.

Parameters:

key - the key to delete

cas - the CAS value to pass along

cb - the status callback

Returns:

the new DeleteOperation

flush

public FlushOperation flush(int delay,
                            OperationCallback cb)

Description copied from interface: OperationFactory

Create a flush operation.

Parameters:

delay - delay until flush.

cb - the status callback

Returns:

the new FlushOperation

getAndTouch

public GetAndTouchOperation getAndTouch(java.lang.String key,
                                        int expiration,
                                        GetAndTouchOperation.Callback cb)

Description copied from interface: OperationFactory

Gets the value of a key and resets its timeout.

Parameters:

key - the key to get a value for and reset its timeout

expiration - the new expiration for the key

cb - the callback that will contain the result

Returns:

a new GATOperation

getAndTouch

public GetAndTouchOperation getAndTouch(java.util.Collection<java.lang.String> keys,
                                        int expiration,
                                        GetAndTouchOperation.Callback cb)

get

public GetOperation get(java.lang.String key,
                        GetOperation.Callback cb)

Description copied from interface: OperationFactory

Create a get operation.

Parameters:

key - the key to get

cb - the callback that will contain the results

Returns:

a new GetOperation

get

public GetOperation get(java.util.Collection<java.lang.String> keys,
                        GetOperation.Callback cb)

Description copied from interface: OperationFactory

Create a get operation.

Parameters:

keys - the collection of keys to get

cb - the callback that will contain the results

Returns:

a new GetOperation

getl

public GetlOperation getl(java.lang.String key,
                          int exp,
                          GetlOperation.Callback cb)

Description copied from interface: OperationFactory

Create a getl operation. A getl gets the value for a key and then locks the value for a given amount of time. The maximum default lock time is 30 seconds.

Parameters:

key - the key to get and lock

exp - the amount of time the lock should be valid for in seconds.

cb - the callback that will contain the results

Returns:

a new GetOperation

observe

public ObserveOperation observe(java.lang.String key,
                                long casId,
                                int index,
                                ObserveOperation.Callback cb)

Description copied from interface: OperationFactory

Create an Observe operation.

Parameters:

key - the key to observe

casId - the value of CAS

index - the VBucket index of key

cb - the status callback

Returns:

the new ObserveOperation

unlock

public UnlockOperation unlock(java.lang.String key,
                              long casId,
                              OperationCallback cb)

Description copied from interface: OperationFactory

Create a Unlock operation.

Parameters:

key - the key to unlock

casId - the value of CAS

cb - the status callback

Returns:

the new UnlockOperation

gets

public GetsOperation gets(java.lang.String key,
                          GetsOperation.Callback cb)

Description copied from interface: OperationFactory

Create a gets operation.

Parameters:

key - the key to get

cb - the callback that will contain the results

Returns:

a new GetsOperation

keyStats

public StatsOperation keyStats(java.lang.String key,
                               StatsOperation.Callback cb)

Description copied from interface: OperationFactory

Get a new KeyStatsOperation.

Parameters:

key - the key to get stats for

cb - the stats callback

Returns:

the new StatsOperation

refreshCertificate

public Operation refreshCertificate(OperationCallback cb)

Description copied from interface: OperationFactory

Refresh the TLS certificate

Parameters:

cb - The status callback

Returns:

A TLS certificate refresh operation

getConfig

public GetConfigOperation getConfig(ConfigurationType type,
                                    GetConfigOperation.Callback cb)

Description copied from interface: OperationFactory

Create a getConfig operation.

Parameters:

type - the config type to get

cb - the callback that will contain the results

Returns:

a new GetConfigOperation

setConfig

public SetConfigOperation setConfig(ConfigurationType type,
                                    int flags,
                                    byte[] data,
                                    OperationCallback cb)

Description copied from interface: OperationFactory

Create a setConfig operation.

Parameters:

type - the config type to set

flags - the config flags

data - the data

cb - the status callback

Returns:

a new SetConfigOperation

deleteConfig

public DeleteConfigOperation deleteConfig(ConfigurationType type,
                                          OperationCallback cb)

Description copied from interface: OperationFactory

Create a deletion operation for config.

Parameters:

type - the configuration type to delete

cb - the status callback

Returns:

the new DeleteConfigOperation

mutate

public MutatorOperation mutate(Mutator m,
                               java.lang.String key,
                               long by,
                               long exp,
                               int def,
                               OperationCallback cb)

Description copied from interface: OperationFactory

Create a mutator operation.

Parameters:

m - the mutator type

key - the mutatee key

by - the amount to increment or decrement

exp - the default value

def - expiration in case we need to default (0 if no default)

cb - the status callback

Returns:

the new mutator operation

stats

public StatsOperation stats(java.lang.String arg,
                            StatsOperation.Callback cb)

Description copied from interface: OperationFactory

Get a new StatsOperation.

Parameters:

arg - the stat parameter (see protocol docs)

cb - the stats callback

Returns:

the new StatsOperation

store

public StoreOperation store(StoreType storeType,
                            java.lang.String key,
                            int flags,
                            int exp,
                            byte[] data,
                            StoreOperation.Callback cb)

Description copied from interface: OperationFactory

Create a store operation.

Parameters:

storeType - the type of store operation

key - the key to store

flags - the storage flags

exp - the expiration time

data - the data

cb - the status callback

Returns:

the new store operation

touch

public TouchOperation touch(java.lang.String key,
                            int expiration,
                            OperationCallback cb)

Description copied from interface: OperationFactory

Resets a keys expiration time.

Parameters:

key - The key whose expiration time is to be reset.

expiration - The new expiration time for the key

cb - The status callback

Returns:

A touch operation

version

public VersionOperation version(OperationCallback cb)

Description copied from interface: OperationFactory

Create a new version operation.

noop

public NoopOperation noop(OperationCallback cb)

Description copied from interface: OperationFactory

Create a NOOP operation.

Parameters:

cb - the operation callback

Returns:

the new NoopOperation

cas

public CASOperation cas(StoreType type,
                        java.lang.String key,
                        long casId,
                        int flags,
                        int exp,
                        byte[] data,
                        StoreOperation.Callback cb)

Description copied from interface: OperationFactory

Create a CAS operation.

key - the key to store

casId - the CAS identifier value (from a gets operation)

flags - the storage flags

exp - the expiration time

data - the data

cb - the status callback

Returns:

the new store operation

cat

public ConcatenationOperation cat(ConcatenationType catType,
                                  long casId,
                                  java.lang.String key,
                                  byte[] data,
                                  OperationCallback cb)

Description copied from interface: OperationFactory

Get a concatenation operation.

Parameters:

catType - the type of concatenation to perform.

casId - the CAS value for an atomic compare-and-cat

key - the key

data - the data to store

cb - a callback for reporting the status

Returns:

thew new ConcatenationOperation

cloneGet

protected java.util.Collection<? extends Operation> cloneGet(KeyedOperation op)

Specified by:

cloneGet in class BaseOperationFactory

saslMechs

public SASLMechsOperation saslMechs(OperationCallback cb)

Description copied from interface: OperationFactory

Create a new SASL mechs operation.

saslStep

public SASLStepOperation saslStep(java.lang.String[] mech,
                                  byte[] challenge,
                                  java.lang.String serverName,
                                  java.util.Map<java.lang.String,?> props,
                                  javax.security.auth.callback.CallbackHandler cbh,
                                  OperationCallback cb)

Description copied from interface: OperationFactory

Create a new sasl step operation.

saslAuth

public SASLAuthOperation saslAuth(java.lang.String[] mech,
                                  java.lang.String serverName,
                                  java.util.Map<java.lang.String,?> props,
                                  javax.security.auth.callback.CallbackHandler cbh,
                                  OperationCallback cb)

Description copied from interface: OperationFactory

Create a new sasl auth operation.

tapBackfill

public TapOperation tapBackfill(java.lang.String id,
                                long date,
                                OperationCallback cb)

Description copied from interface: OperationFactory

Creates a tap backfill stream. See http://www.couchbase.org/wiki/display/membase/TAP+Protocol for more details on the tap protocol. TAP connection names are optional, but allow for momentary interruptions in connection to automatically restart. TAP connection names also appear in TAP stats from the given server. Note that according to the protocol, TAP backfill dates are advisory and the protocol guarantees at least data from specified date forward, but earlier mutations may be received.

Parameters:

id - The name for the TAP connection

date - The date to start backfill from.

cb - The status callback.

Returns:

The tap operation used to create and handle the stream.

tapCustom

public TapOperation tapCustom(java.lang.String id,
                              RequestMessage message,
                              OperationCallback cb)

Description copied from interface: OperationFactory

Creates a custom tap stream. See http://www.couchbase.org/wiki/display/membase/TAP+Protocol for more details on the tap protocol. TAP connection names are optional, but allow for momentary interruptions in connection to automatically restart. TAP connection names also appear in TAP stats from the given server.

Parameters:

id - The name for the TAP connection

message - The tap message to send.

cb - The status callback.

Returns:

The tap operation used to create and handle the stream.

tapAck

public TapOperation tapAck(TapOpcode opcode,
                           int opaque,
                           OperationCallback cb)

Description copied from interface: OperationFactory

Sends a tap ack message to the server. See http://www.couchbase.org/wiki/display/membase/TAP+Protocol for more details on the tap protocol.

Parameters:

opcode - the opcode sent to the client by the server.

opaque - the opaque value sent to the client by the server.

cb - the callback for the tap stream.

Returns:

a tap ack operation.

tapDump

public TapOperation tapDump(java.lang.String id,
                            OperationCallback cb)

Description copied from interface: OperationFactory

Sends a tap dump message to the server. See http://www.couchbase.org/wiki/display/membase/TAP+Protocol for more details on the tap protocol.

Parameters:

id - the name for the TAP connection

cb - the callback for the tap stream.

Returns:

a tap dump operation.

replicaGet

public ReplicaGetOperation replicaGet(java.lang.String key,
                                      int index,
                                      ReplicaGetOperation.Callback callback)

Description copied from interface: OperationFactory

Create a replica get operation.

Parameters:

key - the key to get

callback - the callback that will contain the results

Returns:

a new ReplicaGetOperation

replicaGets

public ReplicaGetsOperation replicaGets(java.lang.String key,
                                        int index,
                                        ReplicaGetsOperation.Callback callback)

Description copied from interface: OperationFactory

Create a replica gets operation.

Parameters:

key - the key to get

callback - the callback that will contain the results

Returns:

a new ReplicaGetOperation