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()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

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