com.exonum.binding.common.message

Interface BinaryMessage

All Superinterfaces:

Message

All Known Implementing Classes:

MessageReader

public interface BinaryMessage
extends Message

A binary Exonum message.

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
static BinaryMessage	fromBytes(byte[] messageBytes) Creates a binary message from a byte array.
default byte[]	getMessageNoSignature() Returns a message without signature, i.e., without the last 64 bytes of the binary message.
java.nio.ByteBuffer	getSignedMessage() Returns the whole binary message.
default HashCode	hash() Returns the SHA-256 hash of this message.
default BinaryMessage	sign(CryptoFunction cryptoFunction, PrivateKey authorSecretKey) Signs this message, creating a new signed binary message.
default boolean	verify(CryptoFunction cryptoFunction, PublicKey authorPublicKey) Verifies the cryptographic signature against the given public key.

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

getBody, getMessageType, getNetworkId, getServiceId, getSignature, getVersion, messageSize, signatureOffset, size

Method Detail

fromBytes

static BinaryMessage fromBytes(byte[] messageBytes)

Creates a binary message from a byte array.

Parameters:

messageBytes - an array with message bytes

Returns:

a binary message

Throws:

java.lang.IllegalArgumentException - if message has invalid size

getMessageNoSignature

default byte[] getMessageNoSignature()

Returns a message without signature, i.e., without the last 64 bytes of the binary message.

sign

@CheckReturnValue
default BinaryMessage sign(CryptoFunction cryptoFunction,
                                             PrivateKey authorSecretKey)

Signs this message, creating a new signed binary message.

Parameters:

cryptoFunction - a cryptographic function to use

authorSecretKey - a secret key of the author of this message

Returns:

a new signed message

Throws:

java.lang.IllegalArgumentException - if the key is not valid for the cryptographic function

verify

@CheckReturnValue
default boolean verify(CryptoFunction cryptoFunction,
                                         PublicKey authorPublicKey)

Verifies the cryptographic signature against the given public key.

Parameters:

cryptoFunction - a cryptographic function to use

authorPublicKey - a public key of the author of this message

Returns:

true if the transaction is valid; false — otherwise

getSignedMessage

java.nio.ByteBuffer getSignedMessage()

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

hash

default HashCode hash()

Returns the SHA-256 hash of this message.