Class JWSHeader

• TopLevel.Object
  • dw.crypto.JWSHeader

This class represents an immutable header of a JWS (JSON Web Signature) object.

Property Summary 

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

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).
static parse(Object)	Convert the given Map or JavaScript object into a JWS header.
static parseEncoded(String)	Parse the given string as a Base64URL-encoded JWS header.
static parseJSON(String)	Parse the given string as a JWS 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).

---

Method Details 

getAlgorithm() 

getAlgorithm(): String

Get the value of the algorithm parameter (alg).

Returns:

• Algorithm parameter from this header.

---

parse(Object) 

static parse(map: Object): JWSHeader

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

All keys correspond to JWS parameters. The algorithm parameter (alg) is required. See JWS.verify(CertificateRef) for supported values.

Parameters:

• map - Map or object data to convert.

Returns:

• JWS Header.

---

parseEncoded(String) 

static parseEncoded(base64encoded: String): JWSHeader

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

The algorithm parameter (alg) is required. See JWS.verify(CertificateRef) for supported values.

Parameters:

• base64encoded - Base64URL string to parse.

Returns:

• JWS Header.

---

parseJSON(String) 

static parseJSON(json: String): JWSHeader

Parse the given string as a JWS header.

The algorithm parameter (alg) is required. See JWS.verify(CertificateRef) for supported values.

Parameters:

• json - JSON string to parse.

Returns:

• JWS Header.

---

toMap() 

toMap(): Map

Get a copy of these headers as a Map.

Returns:

• Copy of the JWS headers.

---

toString() 

toString(): String

Get the content of the headers as a JSON String.

Returns:

• JSON String.

---