com.sleepycat.je.rep.utilint

Class BinaryProtocol.SimpleMessage

java.lang.Object

com.sleepycat.je.rep.utilint.BinaryProtocol.Message

com.sleepycat.je.rep.utilint.BinaryProtocol.SimpleMessage

Direct Known Subclasses:

BaseProtocol.HandshakeMessage, BaseProtocol.RestoreResponse, BaseProtocol.ShutdownRequest, BinaryNodeStateProtocol.BinaryNodeStateRequest, BinaryNodeStateProtocol.BinaryNodeStateResponse, BinaryProtocol.ClientVersion, BinaryProtocol.RejectMessage, BinaryProtocol.ServerVersion, Protocol.BlockInfo, Protocol.BlockListEnd, Protocol.BlockListStart, Protocol.DbBlocks, Protocol.DBIdRequest, Protocol.DBIdResponse, Protocol.DiffAreaEnd, Protocol.DiffAreaStart, Protocol.Done, Protocol.Done, Protocol.EnvDiff, Protocol.EnvInfo, Protocol.FeederInfoReq, Protocol.FeederInfoResp, Protocol.FileListReq, Protocol.FileListResp, Protocol.FileReq, Protocol.FileStart, Protocol.ReAuthenticate, Protocol.RemoteDiffRequest, Protocol.RemoteRecord, Protocol.SecurityFailureResponse

Enclosing class:

BinaryProtocol

protected abstract class BinaryProtocol.SimpleMessage
extends BinaryProtocol.Message

Base class for simple messages. Ones where performance is not of the utmost importance and reflection can be used to simplify message serialization and de-serialization.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleMessage()

Method Summary

Modifier and Type	Method and Description
protected boolean	getBoolean(ByteBuffer buffer)
protected byte[]	getByteArray(ByteBuffer buffer)
protected Double	getDouble(ByteBuffer buffer)
protected <T extends Enum<T>> T	getEnum(Class<T> enumType, ByteBuffer buffer)
protected NameIdPair	getNameIdPair(ByteBuffer buffer)
protected String[]	getStringArray(ByteBuffer buffer) Reconstitutes an array of strings.
protected VLSN	getVLSN(ByteBuffer buffer)
protected void	putByteArray(ByteBuffer buffer, byte[] ba) Put the bytes for the wire format of the specified byte array into the current position in the buffer.
protected void	putWireFormat(ByteBuffer buffer, Object obj) Put the bytes of the wire format for the object into the current position in the buffer.
protected ByteBuffer	wireFormat(Object... arguments) Assembles a sequence of arguments into its byte based wire format.
protected int	wireFormatSize(Object obj) Return the wire format size of the specified object.

Methods inherited from class com.sleepycat.je.rep.utilint.BinaryProtocol.Message

allocateInitializedBuffer, getOp, match, toString, wireFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleMessage

protected SimpleMessage()

Method Detail

wireFormat

protected ByteBuffer wireFormat(Object... arguments)

Assembles a sequence of arguments into its byte based wire format. The method does the serialization in two steps. In step 1, it calculates the length of the buffer. In step 2, it assembles the bytes into the allocated buffer. The interpretive approach used here is suitable for the low performance requirements of the handshake protocol, but not for the core data stream itself. It's for this reason that the method is associated with the Handshake message class and not the Message class.

Parameters:

arguments - the arguments to be passed in the message

Returns:

a byte buffer containing the serialized form of the message

putWireFormat

protected void putWireFormat(ByteBuffer buffer,
                             Object obj)

Put the bytes of the wire format for the object into the current position in the buffer.

Parameters:

buffer - the buffer

obj - the object

Throws:

EnvironmentFailureException - if the object is not supported

putByteArray

protected void putByteArray(ByteBuffer buffer,
                            byte[] ba)

Put the bytes for the wire format of the specified byte array into the current position in the buffer.

Parameters:

buffer - the buffer

ba - the byte array

wireFormatSize

protected int wireFormatSize(Object obj)

Return the wire format size of the specified object.

Parameters:

obj - the object

Returns:

the size

Throws:

EnvironmentFailureException - if the object is not supported

getStringArray

protected String[] getStringArray(ByteBuffer buffer)

Reconstitutes an array of strings.

Parameters:

buffer -

Returns:

getByteArray

protected byte[] getByteArray(ByteBuffer buffer)

getBoolean

protected boolean getBoolean(ByteBuffer buffer)

getVLSN

protected VLSN getVLSN(ByteBuffer buffer)

getEnum

protected <T extends Enum<T>> T getEnum(Class<T> enumType,
                                        ByteBuffer buffer)

getDouble

protected Double getDouble(ByteBuffer buffer)

getNameIdPair

protected NameIdPair getNameIdPair(ByteBuffer buffer)