com.exonum.binding.common.message

Class MessageReader

java.lang.Object

com.exonum.binding.common.message.MessageReader

All Implemented Interfaces:

BinaryMessage, Message

public final class MessageReader
extends java.lang.Object
implements BinaryMessage

A reader of binary Exonum messages.

See the definition of the message format.

Nested Class Summary

Nested classes/interfaces inherited from interface com.exonum.binding.common.message.Message

Message.Builder

Field Summary

Fields inherited from interface com.exonum.binding.common.message.Message

BODY_OFFSET, HEADER_SIZE, MAX_BODY_SIZE, MESSAGE_TYPE_OFFSET, NET_ID_OFFSET, PAYLOAD_LENGTH_OFFSET, SERVICE_ID_OFFSET, SIGNATURE_SIZE, VERSION_OFFSET

Method Summary

Modifier and Type	Method and Description
java.nio.ByteBuffer	getBody() Returns the body of the message as a view in the underlying byte buffer.
short	getMessageType() Returns the type of this message within a service (e.g., a transaction identifier).
byte	getNetworkId() Returns the blockchain network id.
short	getServiceId() Returns the identifier of the service this message belongs to, or zero if this message is an internal Exonum message.
byte[]	getSignature() Returns the Ed25519 signature over this binary message.
java.nio.ByteBuffer	getSignedMessage() Returns the whole binary message.
byte	getVersion() Returns the major version of the Exonum serialization protocol.
int	size() Returns the size of a binary representation of this message in bytes.
static MessageReader	wrap(java.nio.ByteBuffer buffer) Creates a MessageReader from the given byte buffer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.exonum.binding.common.message.BinaryMessage

fromBytes, getMessageNoSignature, hash, sign, verify

Methods inherited from interface com.exonum.binding.common.message.Message

messageSize, signatureOffset

Method Detail

wrap

public static MessageReader wrap(java.nio.ByteBuffer buffer)

Creates a MessageReader from the given byte buffer.

Parameters:

buffer - a byte buffer to read. Its position must be zero, and the limit must be set to the size of the message

Returns:

a message reader of this byte buffer

Throws:

java.lang.IllegalArgumentException - if the message has invalid size

getNetworkId

public byte getNetworkId()

Description copied from interface: Message

Returns the blockchain network id.

Specified by:

getNetworkId in interface Message

getVersion

public byte getVersion()

Description copied from interface: Message

Returns the major version of the Exonum serialization protocol.

Specified by:

getVersion in interface Message

getServiceId

public short getServiceId()

Description copied from interface: Message

Returns the identifier of the service this message belongs to, or zero if this message is an internal Exonum message.

Specified by:

getServiceId in interface Message

getMessageType

public short getMessageType()

Description copied from interface: Message

Returns the type of this message within a service (e.g., a transaction identifier).

Specified by:

getMessageType in interface Message

getBody

public java.nio.ByteBuffer getBody()

Returns the body of the message as a view in the underlying byte buffer.

The returned byte buffer shares the content of the underlying byte buffer of this message. Its position is zero, limit is set to the position after-the-last element of the body. The buffer is direct iff the underlying buffer is direct, and it is read-only iff the underlying buffer is read-only.

Specified by:

getBody in interface Message

getSignature

public byte[] getSignature()

Returns the Ed25519 signature over this binary message.

The signature is not guaranteed to be valid and must be verified against the signer’s public key.

The returned byte buffer shares the content of the underlying byte buffer of this message, and is read-only.

Specified by:

getSignature in interface Message

See Also:

CryptoFunctions.ed25519()

size

public int size()

Description copied from interface: Message

Returns the size of a binary representation of this message in bytes.

Specified by:

size in interface Message

getSignedMessage

public java.nio.ByteBuffer getSignedMessage()

Returns the whole binary message. It includes a message header, body and signature.

The returned byte buffer shares the content of the underlying byte buffer of this message, and is read-only.

Specified by:

getSignedMessage in interface BinaryMessage