com.nimbusds.jose

Class JWEObjectJSON

java.lang.Object

com.nimbusds.jose.JOSEObject

com.nimbusds.jose.JWEObjectJSON

All Implemented Interfaces:

JSONSerializable, Serializable

@ThreadSafe
public class JWEObjectJSON
extends JOSEObject
implements JSONSerializable

JSON Web Encryption (JWE) secured object. Provides JWE JSON Serialization This class is thread-safe.

Version:

2021-08-17

Author:

Alexander Martynov

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JWEObjectJSON.State Enumeration of the states of a JSON Web Encryption (JWE) object.

Field Summary

Fields inherited from class com.nimbusds.jose.JOSEObject

MIME_TYPE_COMPACT, MIME_TYPE_JS

Constructor Summary

Constructors

Constructor and Description
JWEObjectJSON(Base64URL header, List<JWERecipient> recipients, Base64URL iv, Base64URL ciphertext, Base64URL tag) Creates a new encrypted JSON Web Encryption (JWE) object with the specified serialised parts.
JWEObjectJSON(JWEHeader header, Payload payload) Creates a new to-be-encrypted JSON Web Encryption (JWE) object with the specified header and payload.

Method Summary

Modifier and Type	Method and Description
void	decrypt(JWEDecrypterMulti decrypter) Decrypts this JWE object with the specified decrypter.
void	encrypt(JWEEncrypterMulti encrypter) Encrypts this JWE object with the specified encrypter.
Base64URL	getAuthTag() Returns the authentication tag of this JWE object.
Base64URL	getCipherText() Returns the cipher text of this JWE object.
JWEHeader	getHeader() Returns the header of this JOSE object.
Base64URL	getIV() Returns the initialisation vector (IV) of this JWE object.
List<JWERecipient>	getRecipients() Returns the recipients of this JWE object.
JWEObjectJSON.State	getState() Returns the state of this JWE object.
static JWEObjectJSON	parse(Map<String,Object> jsonObject) Parses a JWE object from the map.
static JWEObjectJSON	parse(String s) Parses a JWE object from the specified string in json form.
String	serialize() Serialises this JWE object to General JSON format.
Map<String,Object>	toFlattenedJSONObject() Returns a Flattened JSON object representation of the JOSE Object.
Map<String,Object>	toGeneralJSONObject() Returns a General JSON object representation of the JOSE Object.

Methods inherited from class com.nimbusds.jose.JOSEObject

getParsedParts, getParsedString, getPayload, setParsedParts, setPayload, split

Methods inherited from class java.lang.Object

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

Constructor Detail

JWEObjectJSON

public JWEObjectJSON(JWEHeader header,
                     Payload payload)

Creates a new to-be-encrypted JSON Web Encryption (JWE) object with the specified header and payload. The initial state will be unencrypted.

Parameters:

header - The JWE header. Must not be null.

payload - The payload. Must not be null.

JWEObjectJSON

public JWEObjectJSON(Base64URL header,
                     List<JWERecipient> recipients,
                     Base64URL iv,
                     Base64URL ciphertext,
                     Base64URL tag)
              throws ParseException

Creates a new encrypted JSON Web Encryption (JWE) object with the specified serialised parts. The state will be encrypted.

Parameters:

header - The JWE Protected header. Must not be null.

recipients - The recipients array. Empty or null if none.

iv - The initialisation vector. Empty or null if none.

ciphertext - The cipher text. Must not be null.

tag - The authentication tag. Empty of null if none.

Throws:

ParseException - If parsing of the serialised parts failed.

Method Detail

getHeader

public JWEHeader getHeader()

Description copied from class: JOSEObject

Returns the header of this JOSE object.

Specified by:

getHeader in class JOSEObject

Returns:

The header.

getRecipients

public List<JWERecipient> getRecipients()

Returns the recipients of this JWE object.

Returns:

The recipients, null if not applicable or the JWE object has not been encrypted yet.

getIV

public Base64URL getIV()

Returns the initialisation vector (IV) of this JWE object.

Returns:

The initialisation vector (IV), null if not applicable or the JWE object has not been encrypted yet.

getCipherText

public Base64URL getCipherText()

Returns the cipher text of this JWE object.

Returns:

The cipher text, null if the JWE object has not been encrypted yet.

getAuthTag

public Base64URL getAuthTag()

Returns the authentication tag of this JWE object.

Returns:

The authentication tag, null if not applicable or the JWE object has not been encrypted yet.

getState

public JWEObjectJSON.State getState()

Returns the state of this JWE object.

Returns:

The state.

encrypt

public void encrypt(JWEEncrypterMulti encrypter)
             throws JOSEException

Encrypts this JWE object with the specified encrypter. The JWE object must be in an unencrypted state.

Parameters:

encrypter - The JWE encrypter. Must not be null.

Throws:

IllegalStateException - If the JWE object is not in an unencrypted state.

JOSEException - If the JWE object couldn't be encrypted.

decrypt

public void decrypt(JWEDecrypterMulti decrypter)
             throws JOSEException

Decrypts this JWE object with the specified decrypter. The JWE object must be in a encrypted state.

Parameters:

decrypter - The JWE decrypter. Must not be null.

Throws:

IllegalStateException - If the JWE object is not in an encrypted state.

JOSEException - If the JWE object couldn't be decrypted.

serialize

public String serialize()

Serialises this JWE object to General JSON format.

Specified by:

serialize in class JOSEObject

Returns:

The serialised JWE object.

Throws:

IllegalStateException - If the JWS object is not in a signed or verified state.

parse

public static JWEObjectJSON parse(String s)
                           throws ParseException

Parses a JWE object from the specified string in json form. The parsed JWE object will be given an JWEObjectJSON.State.ENCRYPTED state. NOTE: Supports only General Serialization Syntax

Parameters:

s - The string to parse. Must not be null.

Returns:

The JWE object.

Throws:

ParseException - If the string couldn't be parsed to a valid JWE object.

parse

public static JWEObjectJSON parse(Map<String,Object> jsonObject)
                           throws ParseException

Parses a JWE object from the map. The parsed JWE object will be given an JWEObjectJSON.State.ENCRYPTED state. NOTE: Supports only General Serialization Syntax

Parameters:

jsonObject - The json map. Must not be null.

Returns:

The JWE object.

Throws:

ParseException - If the string couldn't be parsed to a valid JWE object.

toGeneralJSONObject

public Map<String,Object> toGeneralJSONObject()

Description copied from interface: JSONSerializable

Returns a General JSON object representation of the JOSE Object.

Specified by:

toGeneralJSONObject in interface JSONSerializable

Returns:

The JSON object.

toFlattenedJSONObject

public Map<String,Object> toFlattenedJSONObject()

Description copied from interface: JSONSerializable

Returns a Flattened JSON object representation of the JOSE Object.

Specified by:

toFlattenedJSONObject in interface JSONSerializable

Returns:

The JSON object.