io.nem.symbol.sdk.model.message

Class EncryptedMessage

java.lang.Object

io.nem.symbol.sdk.model.message.Message

io.nem.symbol.sdk.model.message.TypedMessage

io.nem.symbol.sdk.model.message.EncryptedMessage

public class EncryptedMessage
extends TypedMessage

A message that has been encrypted using the NEM's SDK libraries.

Constructor Summary

Constructors

Constructor and Description
EncryptedMessage(java.lang.String encryptedPayload) It creates a Encrypted Message from the encryptedPayload.

Method Summary

Modifier and Type	Method and Description
static EncryptedMessage	create(java.lang.String plainTextMessage, PrivateKey senderPrivateKey, PublicKey recipientPublicKey) Helper constructor that allow users to easily encrypt a message using the SDK provided CryptoEngine and BlockCipher.
java.lang.String	decryptPayload(PublicKey senderPublicKey, PrivateKey recipientPrivateKey) Utility method that allow users to decrypt a message if it was created using the Java SDK or the Typescript SDK.

Methods inherited from class io.nem.symbol.sdk.model.message.TypedMessage

getPayloadByteBuffer, getText

Methods inherited from class io.nem.symbol.sdk.model.message.Message

createFromHexPayload, createFromPayload, equals, getPayload, getPayloadByteBuffer, getPayloadHex, getType, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

EncryptedMessage

public EncryptedMessage(java.lang.String encryptedPayload)

It creates a Encrypted Message from the encryptedPayload.

Parameters:

encryptedPayload - the encrypted payload.

Method Detail

create

public static EncryptedMessage create(java.lang.String plainTextMessage,
                                      PrivateKey senderPrivateKey,
                                      PublicKey recipientPublicKey)

Helper constructor that allow users to easily encrypt a message using the SDK provided CryptoEngine and BlockCipher.

Note, the strategy to encrypt and decrypt should be shared between the different SDKs. A client may send a transaction using a sdk and the recipient may be using a different one.

The strategy is:

"plain text" string - utf8 byte array - encrypted byte array - hex string (the encrypted message string)

Parameters:

plainTextMessage - Plain message to be encrypted

senderPrivateKey - Sender private key

recipientPublicKey - Recipient public key

Returns:

EncryptedMessage

decryptPayload

public java.lang.String decryptPayload(PublicKey senderPublicKey,
                                       PrivateKey recipientPrivateKey)

Utility method that allow users to decrypt a message if it was created using the Java SDK or the Typescript SDK.

Parameters:

senderPublicKey - Sender public key.

recipientPrivateKey - Recipient private key

Returns:

plain string message.