Class JWSHeader
dw.crypto
Class JWSHeader
Object
dw.crypto.JWSHeader
This class represents an immutable header of a JWS (JSON Web Signature) object.
Properties
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
getAlgorithm() : String
Get the value of the algorithm parameter (alg).
static parse(map : Map) : JWSHeader
Convert the given map into a JWS header.
static parseEncoded(base64encoded : String) : JWSHeader
Parse the given string as a Base64URL-encoded JWS header.
static parseJSON(json : String) : JWSHeader
Parse the given string as a JWS header.
toMap() : Map
Get a copy of these headers as a Map.
toString() : String
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
Method Detail
getAlgorithm
getAlgorithm() : String
Get the value of the algorithm parameter (alg).
Returns:
Algorithm parameter from this header.
parse
static parse(map : Map) : JWSHeader
Convert the given map 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 data to convert.
Returns:
JWS Header.
parseEncoded
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
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.