W3cubDocs

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:

See Also:

Constructor Summary

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 java.lang.Object

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

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.

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/javax/crypto/KEM.Encapsulated.html