net.spy.memcached.protocol.binary
Class SASLBaseOperationImpl

java.lang.Object
  net.spy.memcached.compat.SpyObject
      net.spy.memcached.protocol.BaseOperationImpl
          net.spy.memcached.protocol.binary.SASLBaseOperationImpl

All Implemented Interfaces:

Operation

Direct Known Subclasses:

SASLAuthOperationImpl, SASLStepOperationImpl

public abstract class SASLBaseOperationImpl
extends BaseOperationImpl

Field Summary

protected CallbackHandler	cbh
protected byte[]	challenge
protected static byte[]	EMPTY_BYTES
protected static int	ERR_2BIG
protected static int	ERR_BUSY
protected static int	ERR_DELTA_BADVAL
protected static int	ERR_EXISTS
protected static int	ERR_INTERNAL
protected static int	ERR_INVAL
protected static int	ERR_NO_MEM
protected static int	ERR_NOT_FOUND
protected static int	ERR_NOT_MY_VBUCKET
protected static int	ERR_NOT_STORED
protected static int	ERR_NOT_SUPPORTED
protected static int	ERR_TEMP_FAIL
protected static int	ERR_UNKNOWN_COMMAND
protected int	errorCode
protected int	keyLen
protected String[]	mech
protected static int	MIN_RECV_PACKET
protected int	opaque
protected Map<String,?>	props
protected static byte	REQ_MAGIC
protected static byte	RES_MAGIC
protected long	responseCas
protected int	responseCmd
protected int	responseOpaque
protected String	serverName
protected static OperationStatus	STATUS_OK
protected static int	SUCCESS Error code for operations.
protected short	vbucket

Fields inherited from class net.spy.memcached.protocol.BaseOperationImpl

callback, CANCELLED, notMyVbucketNodes

Constructor Summary

SASLBaseOperationImpl(int c, String[] m, byte[] ch, String s, Map<String,?> p, CallbackHandler h, OperationCallback cb)

Method Summary

protected abstract byte[]	buildResponse(SaslClient sc)
protected void	decodePayload(byte[] pl) Decode the given payload for this command.
protected void	finishedPayload(byte[] pl)
protected OperationStatus	getStatusForErrorCode(int errCode, byte[] errPl) Get the OperationStatus object for the given error code.
void	initialize() Initialize this operation.
protected boolean	opaqueIsValid() Validate an opaque value from the header.
protected void	prepareBuffer(String key, long cas, byte[] val, Object... extraHeaders) Prepare a send buffer.
void	readFromBuffer(ByteBuffer b) Read data from the given byte buffer and dispatch to the appropriate read mechanism.
protected void	resetInput()

Methods inherited from class net.spy.memcached.protocol.BaseOperationImpl

cancel, getBuffer, getCallback, getException, getHandlingNode, getState, handleError, handleRead, hasErrored, isCancelled, isTimedOut, isTimedOut, isTimedOutUnsent, setBuffer, setCallback, setHandlingNode, timeOut, transitionState, wasCancelled, writeComplete

Methods inherited from class net.spy.memcached.compat.SpyObject

getLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.spy.memcached.ops.Operation

cancel, getBuffer, getCallback, getException, getHandlingNode, getState, handleRead, hasErrored, isCancelled, isTimedOut, isTimedOut, isTimedOutUnsent, setHandlingNode, timeOut, writeComplete

Field Detail

mech

protected final String[] mech

challenge

protected final byte[] challenge

serverName

protected final String serverName

props

protected final Map<String,?> props

cbh

protected final CallbackHandler cbh

REQ_MAGIC

protected static final byte REQ_MAGIC

See Also:

Constant Field Values

RES_MAGIC

protected static final byte RES_MAGIC

See Also:

Constant Field Values

MIN_RECV_PACKET

protected static final int MIN_RECV_PACKET

See Also:

Constant Field Values

SUCCESS

protected static final int SUCCESS

Error code for operations.

See Also:

Constant Field Values

ERR_NOT_FOUND

protected static final int ERR_NOT_FOUND

See Also:

Constant Field Values

ERR_EXISTS

protected static final int ERR_EXISTS

See Also:

Constant Field Values

ERR_2BIG

protected static final int ERR_2BIG

See Also:

Constant Field Values

ERR_INVAL

protected static final int ERR_INVAL

See Also:

Constant Field Values

ERR_NOT_STORED

protected static final int ERR_NOT_STORED

See Also:

Constant Field Values

ERR_DELTA_BADVAL

protected static final int ERR_DELTA_BADVAL

See Also:

Constant Field Values

ERR_NOT_MY_VBUCKET

protected static final int ERR_NOT_MY_VBUCKET

See Also:

Constant Field Values

ERR_UNKNOWN_COMMAND

protected static final int ERR_UNKNOWN_COMMAND

See Also:

Constant Field Values

ERR_NO_MEM

protected static final int ERR_NO_MEM

See Also:

Constant Field Values

ERR_NOT_SUPPORTED

protected static final int ERR_NOT_SUPPORTED

See Also:

Constant Field Values

ERR_INTERNAL

protected static final int ERR_INTERNAL

See Also:

Constant Field Values

ERR_BUSY

protected static final int ERR_BUSY

See Also:

Constant Field Values

ERR_TEMP_FAIL

protected static final int ERR_TEMP_FAIL

See Also:

Constant Field Values

EMPTY_BYTES

protected static final byte[] EMPTY_BYTES

STATUS_OK

protected static final OperationStatus STATUS_OK

vbucket

protected short vbucket

opaque

protected final int opaque

keyLen

protected int keyLen

responseCmd

protected int responseCmd

errorCode

protected int errorCode

responseOpaque

protected int responseOpaque

responseCas

protected long responseCas

Constructor Detail

SASLBaseOperationImpl

public SASLBaseOperationImpl(int c,
                             String[] m,
                             byte[] ch,
                             String s,
                             Map<String,?> p,
                             CallbackHandler h,
                             OperationCallback cb)

Method Detail

initialize

public void initialize()

Description copied from interface: Operation

Initialize this operation. This is used to prepare output byte buffers and stuff.

Specified by:

initialize in interface Operation

Specified by:

initialize in class BaseOperationImpl

buildResponse

protected abstract byte[] buildResponse(SaslClient sc)
                                 throws SaslException

Throws:

SaslException

decodePayload

protected void decodePayload(byte[] pl)

Decode the given payload for this command.

Parameters:

pl - the payload.

finishedPayload

protected void finishedPayload(byte[] pl)
                        throws IOException

Throws:

IOException

resetInput

protected void resetInput()

readFromBuffer

public void readFromBuffer(ByteBuffer b)
                    throws IOException

Description copied from interface: Operation

Read data from the given byte buffer and dispatch to the appropriate read mechanism.

Specified by:

readFromBuffer in interface Operation

Specified by:

readFromBuffer in class BaseOperationImpl

Throws:

IOException

getStatusForErrorCode

protected OperationStatus getStatusForErrorCode(int errCode,
                                                byte[] errPl)
                                         throws IOException

Get the OperationStatus object for the given error code.

Parameters:

errCode - the error code

Returns:

the status to return, or null if this is an exceptional case

Throws:

IOException

opaqueIsValid

protected boolean opaqueIsValid()

Validate an opaque value from the header. This may be overridden from a subclass where the opaque isn't expected to always be the same as the request opaque.

prepareBuffer

protected void prepareBuffer(String key,
                             long cas,
                             byte[] val,
                             Object... extraHeaders)

Prepare a send buffer.

Parameters:

key - the key (for keyed ops)

cas - the cas value

val - the data payload

extraHeaders - any additional headers that need to be sent