Package org.forgerock.json.crypto

Interface JsonEncryptor

All Known Implementing Classes:
SimpleEncryptor
public interface JsonEncryptor
Encrypts a JSON value.

  • 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.

  • Method Details

    • getType

      String getType()
      Returns the type of cryptographic representation that this JSON encryptor supports. Expressed in the type property of a JsonCrypto object.
      Returns:
      The type.

    • encrypt

      JsonValue encrypt(JsonValue value) throws JsonCryptoException
      Encrypts the specified value.
      Parameters:
      value - the JSON value to be encrypted.
      Returns:
      the encrypted value.
      Throws:
      JsonCryptoException - if the encryptor fails to encrypt the value.