com.nimbusds.jose

Class Header

java.lang.Object

com.nimbusds.jose.Header

All Implemented Interfaces:

ReadOnlyHeader

Direct Known Subclasses:

JWEHeader, JWSHeader, PlainHeader

public abstract class Header
extends Object
implements ReadOnlyHeader

The base abstract class for plaintext, JSON Web Signature (JWS) and JSON Web Encryption (JWE) headers.

The header may also carry custom parameters; these will be serialised and parsed along the reserved ones.

Version:

$version$ (2013-08-20)

Author:

Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field and Description
protected Algorithm	alg The algorithm (alg) parameter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Header(Algorithm alg) Creates a new header with the specified algorithm (alg) parameter.

Method Summary

Methods

Modifier and Type	Method and Description
String	getContentType() Gets the content type (cty) parameter.
Set<String>	getCriticalHeaders() Gets the critical headers (crit) parameter.
Object	getCustomParameter(String name) Gets a custom (non-reserved) parameter.
Map<String,Object>	getCustomParameters() Gets the custom (non-reserved) parameters.
JOSEObjectType	getType() Gets the type (typ) parameter.
static Header	parse(Base64URL base64URL) Parses a PlainHeader, JWSHeader or JWEHeader from the specified Base64URL.
static Header	parse(net.minidev.json.JSONObject json) Parses a PlainHeader, JWSHeader or JWEHeader from the specified JSON object.
static Header	parse(String s) Parses a PlainHeader, JWSHeader or JWEHeader from the specified JSON object string.
static Algorithm	parseAlgorithm(net.minidev.json.JSONObject json) Parses an algorithm (alg) parameter from the specified header JSON object.
void	setContentType(String cty) Sets the content type (cty) parameter.
void	setCriticalHeaders(Set<String> crit) Sets the critical headers (crit) parameter.
protected void	setCustomParameter(String name, Object value) Sets a custom (non-reserved) parameter.
void	setCustomParameters(Map<String,Object> customParameters) Sets the custom (non-reserved) parameters.
protected void	setParsedBase64URL(Base64URL parsedBase64URL) Sets the original parsed Base64URL used to create this header.
void	setType(JOSEObjectType typ) Sets the type (typ) parameter.
Base64URL	toBase64URL() Returns a Base64URL representation of the header.
net.minidev.json.JSONObject	toJSONObject() Returns a JSON object representation of the header.
String	toString() Returns a JSON string representation of the header.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.nimbusds.jose.ReadOnlyHeader

getAlgorithm, getIncludedParameters

Field Detail

alg

protected final Algorithm alg

The algorithm (alg) parameter.

Constructor Detail

Header

protected Header(Algorithm alg)

Creates a new header with the specified algorithm (alg) parameter.

Parameters:

alg - The algorithm parameter. Must not be null.

Method Detail

getType

public JOSEObjectType getType()

Description copied from interface: ReadOnlyHeader

Gets the type (typ) parameter.

Specified by:

getType in interface ReadOnlyHeader

Returns:

The type parameter, null if not specified.

setType

public void setType(JOSEObjectType typ)

Sets the type (typ) parameter.

Parameters:

typ - The type parameter, null if not specified.

getContentType

public String getContentType()

Description copied from interface: ReadOnlyHeader

Gets the content type (cty) parameter.

Specified by:

getContentType in interface ReadOnlyHeader

Returns:

The content type parameter, null if not specified.

setContentType

public void setContentType(String cty)

Sets the content type (cty) parameter.

Parameters:

cty - The content type parameter, null if not specified.

getCriticalHeaders

public Set<String> getCriticalHeaders()

Description copied from interface: ReadOnlyHeader

Gets the critical headers (crit) parameter.

Specified by:

getCriticalHeaders in interface ReadOnlyHeader

Returns:

The names of the critical header parameters, empty set or null if none.

setCriticalHeaders

public void setCriticalHeaders(Set<String> crit)

Sets the critical headers (crit) parameter.

Parameters:

crit - The names of the critical header parameters, empty set null if none.

getCustomParameter

public Object getCustomParameter(String name)

Description copied from interface: ReadOnlyHeader

Gets a custom (non-reserved) parameter.

Specified by:

getCustomParameter in interface ReadOnlyHeader

Parameters:

name - The name of the custom parameter. Must not be null.

Returns:

The custom parameter, null if not specified.

setCustomParameter

protected void setCustomParameter(String name,
                      Object value)

Sets a custom (non-reserved) parameter. Callers and extending classes should ensure the parameter name doesn't match a reserved parameter name.

Parameters:

name - The name of the custom parameter. Must not match a reserved parameter name and must not be null.

value - The value of the custom parameter, should map to a valid JSON entity, null if not specified.

getCustomParameters

public Map<String,Object> getCustomParameters()

Description copied from interface: ReadOnlyHeader

Gets the custom (non-reserved) parameters.

Specified by:

getCustomParameters in interface ReadOnlyHeader

Returns:

The custom parameters, as a unmodifiable map, empty map if none.

setCustomParameters

public void setCustomParameters(Map<String,Object> customParameters)

Sets the custom (non-reserved) parameters. The values must be serialisable to a JSON entity, otherwise will be ignored.

Parameters:

customParameters - The custom parameters, empty map or null if none.

setParsedBase64URL

protected void setParsedBase64URL(Base64URL parsedBase64URL)

Sets the original parsed Base64URL used to create this header.

Parameters:

parsedBase64URL - The parsed Base64URL, null if the header was created from scratch.

toJSONObject

public net.minidev.json.JSONObject toJSONObject()

Description copied from interface: ReadOnlyHeader

Returns a JSON object representation of the header. All custom parameters are included if they serialise to a JSON entity and their names don't conflict with the reserved ones.

Specified by:

toJSONObject in interface ReadOnlyHeader

Returns:

The JSON object representation of the header.

toString

public String toString()

Description copied from interface: ReadOnlyHeader

Returns a JSON string representation of the header. All custom parameters will be included if they serialise to a JSON entity and their names don't conflict with the reserved ones.

Specified by:

toString in interface ReadOnlyHeader

Overrides:

toString in class Object

Returns:

The JSON string representation of the header.

toBase64URL

public Base64URL toBase64URL()

Description copied from interface: ReadOnlyHeader

Returns a Base64URL representation of the header. If the header was parsed always returns the original Base64URL (required for JWS validation and authenticated JWE decryption).

Specified by:

toBase64URL in interface ReadOnlyHeader

Returns:

The original parsed Base64URL representation of the header, or a new Base64URL representation if the header was created from scratch.

parseAlgorithm

public static Algorithm parseAlgorithm(net.minidev.json.JSONObject json)
                                throws ParseException

Parses an algorithm (alg) parameter from the specified header JSON object. Intended for initial parsing of plain, JWS and JWE headers.

The algorithm type (none, JWS or JWE) is determined by inspecting the algorithm name for "none" and the presence of an "enc" parameter.

Parameters:

json - The JSON object to parse. Must not be null.

Returns:

The algorithm, an instance of Algorithm.NONE, JWSAlgorithm or JWEAlgorithm.

Throws:

ParseException - If the alg parameter couldn't be parsed.

parse

public static Header parse(net.minidev.json.JSONObject json)
                    throws ParseException

Parses a PlainHeader, JWSHeader or JWEHeader from the specified JSON object.

Parameters:

json - The JSON object to parse. Must not be null.

Returns:

The header.

Throws:

ParseException - If the specified JSON object doesn't represent a valid header.

parse

public static Header parse(String s)
                    throws ParseException

Parses a PlainHeader, JWSHeader or JWEHeader from the specified JSON object string.

Parameters:

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

Returns:

The header.

Throws:

ParseException - If the specified JSON object string doesn't represent a valid header.

parse

public static Header parse(Base64URL base64URL)
                    throws ParseException

Parses a PlainHeader, JWSHeader or JWEHeader from the specified Base64URL.

Parameters:

base64URL - The Base64URL to parse. Must not be null.

Returns:

The header.

Throws:

ParseException - If the specified Base64URL doesn't represent a valid header.