Package org.symbol.sdk.nem

Class MessageEncoder

java.lang.Object

org.symbol.sdk.nem.MessageEncoder

---

public final class MessageEncoder extends Object

MessageEncoder

Encrypts / encodes messages between two NEM parties; tryDecode tries AES-GCM ([tag(16) | iv(12) | cipherText]) then falls back to deprecated AES-CBC ([salt(32) | iv(16) | cipherText], the salt randomising the deprecated shared-key derivation).

• Constructor Summary

  Constructors

  Constructor

  Description

  MessageEncoder(KeyPair keyPair)

  Creates a message encoder around a key pair.

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  Message

  encode(CryptoTypes.PublicKey recipientPublicKey, byte[] message)

  Encodes a message to a recipient using the recommended format.

  Message

  encodeDeprecated(CryptoTypes.PublicKey recipientPublicKey, byte[] message)

  Encodes a message using the deprecated AES-CBC format; only for compatibility with older NEM messages — new code should use encode(CryptoTypes.PublicKey, byte[]).

  CryptoTypes.PublicKey

  getPublicKey()

  Returns the public key used for message encoding.

  MessageEncoderResult

  tryDecode(CryptoTypes.PublicKey recipientPublicKey, Message encodedMessage)

  Tries to decode an encoded message.

  Methods inherited from class java.lang.Object

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

• Constructor Details

  • MessageEncoder

    public MessageEncoder(KeyPair keyPair)

    Creates a message encoder around a key pair.

    Parameters:

    keyPair - Key pair.

• Method Details

  • getPublicKey

    public CryptoTypes.PublicKey getPublicKey()

    MessageEncoder.publicKey

    Returns the public key used for message encoding.

    Returns:

    Public key used for message encoding.

  • tryDecode

    public MessageEncoderResult tryDecode(CryptoTypes.PublicKey recipientPublicKey, Message encodedMessage)

    MessageEncoder.tryDecode

    Tries to decode an encoded message.

    Parameters:

    recipientPublicKey - Recipient public key.

    encodedMessage - Encoded message.

    Returns:

    Decoded result; falls back to the original message when both GCM and CBC fail.

    Throws:

    IllegalArgumentException - When encodedMessage.messageType is not MessageType.ENCRYPTED, or when a non-GCM payload is shorter than the CBC salt.

  • encode

    public Message encode(CryptoTypes.PublicKey recipientPublicKey, byte[] message)

    MessageEncoder.encode

    Encodes a message to a recipient using the recommended format.

    Parameters:

    recipientPublicKey - Recipient public key.

    message - Message to encode.

    Returns:

    Encrypted and encoded message.

  • encodeDeprecated

    public Message encodeDeprecated(CryptoTypes.PublicKey recipientPublicKey, byte[] message)

    MessageEncoder.encodeDeprecated

    Encodes a message using the deprecated AES-CBC format; only for compatibility with older NEM messages — new code should use encode(CryptoTypes.PublicKey, byte[]).

    Parameters:

    recipientPublicKey - Recipient public key.

    message - Message to encode.

    Returns:

    Encrypted and encoded message.