Class KEM.Encapsulated

java.lang.Object
javax.crypto.KEM.Encapsulated
Enclosing class:
KEM
public static final class KEM.Encapsulated extends Object
This class specifies the return value of the encapsulate method of a Key Encapsulation Mechanism (KEM), which includes the shared secret (as a SecretKey), the key encapsulation message, and optional parameters.

Note: the key encapsulation message can be also referred to as ciphertext.

Since:
21
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Encapsulated(SecretKey key, byte[] encapsulation, byte[] params)
    Constructs an Encapsulated object.

  • Method Summary

    Modifier and Type
    Method
    Description
    byte[]
    encapsulation()
    Returns the key encapsulation message.
    SecretKey
    key()
    Returns the SecretKey.
    byte[]
    params()
    Returns the optional parameters in a byte array.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Creates and returns a copy of this object.
    boolean
    equals(Object obj)
    Indicates whether some other object is "equal to" this one.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finalization is deprecated and subject to removal in a future release.
    final Class<?>
    getClass()
    Returns the runtime class of this Object.
    int
    hashCode()
    Returns a hash code value for this object.
    final void
    notify()
    Wakes up a single thread that is waiting on this object's monitor.
    final void
    notifyAll()
    Wakes up all threads that are waiting on this object's monitor.
    String
    toString()
    Returns a string representation of the object.
    final void
    wait()
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
    final void
    wait(long timeoutMillis)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
    final void
    wait(long timeoutMillis, int nanos)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

  • Constructor Details

    • Encapsulated

      public Encapsulated(SecretKey key, byte[] encapsulation, byte[] params)
      Constructs an Encapsulated object.
      Parameters:
      key - the shared secret as a key, must not be null.
      encapsulation - the key encapsulation message, must not be null. The contents of the array are copied to protect against subsequent modification.
      params - optional parameters, can be null. The contents of the array are copied to protect against subsequent modification.
      Throws:
      NullPointerException - if key or encapsulation is null

  • Method Details

    • key

      public SecretKey key()
      Returns the SecretKey.
      Returns:
      the secret key

    • encapsulation

      public byte[] encapsulation()
      Returns the key encapsulation message.
      Returns:
      the key encapsulation message. A new copy of the byte array is returned.

    • params

      public byte[] params()
      Returns the optional parameters in a byte array.
      Returns:
      the optional parameters in a byte array or null if not specified. A new copy of the byte array is returned.