Class JWEHeader

• TopLevel.Object
  • dw.crypto.JWEHeader

This class represents an immutable header of a JWE (JSON Web Encryption) object.

Property Summary 

Property	Description
algorithm: String (read-only)	Get the value of the algorithm parameter (alg).
encryptionAlgorithm: String (read-only)	Get the value of the encryption algorithm parameter (enc).

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

Method	Description
getAlgorithm()	Get the value of the algorithm parameter (alg).
getEncryptionAlgorithm()	Get the value of the encryption algorithm parameter (enc).
static parse(Object)	Convert the given Map or JavaScript object into a JWE header.
static parseEncoded(String)	Parse the given string as a Base64URL-encoded JWE header.
static parseJSON(String)	Parse the given string as a JWE header.
toMap()	Get a copy of these headers as a Map.
toString()	Get the content of the headers as a JSON String.

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Property Details 

algorithm 

algorithm: String (read-only)

Get the value of the algorithm parameter (alg).

---

encryptionAlgorithm 

encryptionAlgorithm: String (read-only)

Get the value of the encryption algorithm parameter (enc).

---

Method Details 

getAlgorithm() 

getAlgorithm(): String

Get the value of the algorithm parameter (alg).

Returns:

• Algorithm parameter from this header.

---

getEncryptionAlgorithm() 

getEncryptionAlgorithm(): String

Get the value of the encryption algorithm parameter (enc).

Returns:

• Encryption algorithm parameter from this header.

---

parse(Object) 

static parse(map: Object): JWEHeader

Convert the given Map or JavaScript object into a JWE header.

All keys correspond to JWE parameters. The algorithm (alg) and encryption method (enc) parameters are required. See JWE.decrypt(KeyRef) for supported values.

Parameters:

• map - Map or object data to convert.

Returns:

• JWE Header.

---

parseEncoded(String) 

static parseEncoded(base64encoded: String): JWEHeader

Parse the given string as a Base64URL-encoded JWE header.

The algorithm (alg) and encryption method (enc) parameters are required. See JWE.decrypt(KeyRef) for supported values.

Parameters:

• base64encoded - Base64URL string to parse.

Returns:

• JWE Header.

---

parseJSON(String) 

static parseJSON(json: String): JWEHeader

Parse the given string as a JWE header.

The algorithm (alg) and encryption method (enc) parameters are required. See JWE.decrypt(KeyRef) for supported values.

Parameters:

• json - JSON string to parse.

Returns:

• JWE Header.

---

toMap() 

toMap(): Map

Get a copy of these headers as a Map.

Returns:

• Copy of the JWE headers.

---

toString() 

toString(): String

Get the content of the headers as a JSON String.

Returns:

• JSON String.

---