Package org.forgerock.json.crypto.simple

Class SimpleEncryptor

java.lang.Object

org.forgerock.json.crypto.simple.SimpleEncryptor

All Implemented Interfaces:

JsonEncryptor

public class SimpleEncryptor
extends Object
implements JsonEncryptor

Encrypts a JSON value into an x-simple-encryption type $crypto JSON object.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	The type of cryptographic representation that this encryptor supports.

Constructor Summary

Constructors

Constructor	Description
SimpleEncryptor(String cipher, Key key, String alias)	Constructs a new simple encryptor for the specified cipher, key and alias.
SimpleEncryptor(String cipher, Key key, Purpose<? extends CryptoKey> purpose, String stableId)	Constructor.

Method Summary

Modifier and Type	Method	Description
JsonValue	encrypt(JsonValue value)	Encrypts the specified value.
String	getType()	Returns the type of cryptographic representation that this JSON encryptor supports.

Methods inherited from class java.lang.Object

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

Field Details

TYPE

public static final String TYPE

The type of cryptographic representation that this encryptor supports.

See Also:

• Constant Field Values

Constructor Details

SimpleEncryptor

public SimpleEncryptor(String cipher,
 Key key,
 String alias)

Constructs a new simple encryptor for the specified cipher, key and alias.

Parameters:

cipher - the cipher to encrypt with.

key - the key to encrypt with.

alias - the key alias to list in the encrypted object.

SimpleEncryptor

public SimpleEncryptor(String cipher,
 Key key,
 Purpose<? extends CryptoKey> purpose,
 String stableId)

Constructor.

Parameters:

cipher - The cipher to encrypt with.

key - The key to encrypt with.

purpose - The key Purpose to lise in the encrypted object.

stableId - The key id to list in the encrypted object.

Method Details

getType

public String getType()

Description copied from interface: JsonEncryptor

Returns the type of cryptographic representation that this JSON encryptor supports. Expressed in the type property of a JsonCrypto object.

Specified by:

getType in interface JsonEncryptor

Returns:

The type.

encrypt

public JsonValue encrypt(JsonValue value)
                  throws JsonCryptoException

Description copied from interface: JsonEncryptor

Encrypts the specified value.

Specified by:

encrypt in interface JsonEncryptor

Parameters:

value - the JSON value to be encrypted.

Returns:

the encrypted value.

Throws:

JsonCryptoException - if the encryptor fails to encrypt the value.