com.nimbusds.jose

Interface ReadOnlyHeader

All Known Subinterfaces:

com.nimbusds.jose.ReadOnlyCommonSEHeader, ReadOnlyJWEHeader, ReadOnlyJWSHeader, ReadOnlyPlainHeader

All Known Implementing Classes:

Header, JWEHeader, JWSHeader, PlainHeader

public interface ReadOnlyHeader

Read-only view of a header.

Version:

$version$ (2013-10-07)

Author:

Vladimir Dzhuvinov

Method Summary

Methods

Modifier and Type	Method and Description
Algorithm	getAlgorithm() Gets the algorithm (alg) parameter.
java.lang.String	getContentType() Gets the content type (cty) parameter.
java.util.Set<java.lang.String>	getCriticalHeaders() Gets the critical headers (crit) parameter.
java.lang.Object	getCustomParameter(java.lang.String name) Gets a custom (non-registered) parameter.
java.util.Map<java.lang.String,java.lang.Object>	getCustomParameters() Gets the custom (non-registered) parameters.
java.util.Set<java.lang.String>	getIncludedParameters() Gets the names of all included parameters (registered and custom) in the header instance.
JOSEObjectType	getType() Gets 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.
java.lang.String	toString() Returns a JSON string representation of the header.

Method Detail

getAlgorithm

Algorithm getAlgorithm()

Gets the algorithm (alg) parameter.

Returns:

The algorithm parameter.

getType

JOSEObjectType getType()

Gets the type (typ) parameter.

Returns:

The type parameter, null if not specified.

getContentType

java.lang.String getContentType()

Gets the content type (cty) parameter.

Returns:

The content type parameter, null if not specified.

getCriticalHeaders

java.util.Set<java.lang.String> getCriticalHeaders()

Gets the critical headers (crit) parameter.

Returns:

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

getCustomParameter

java.lang.Object getCustomParameter(java.lang.String name)

Gets a custom (non-registered) parameter.

Parameters:

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

Returns:

The custom parameter, null if not specified.

getCustomParameters

java.util.Map<java.lang.String,java.lang.Object> getCustomParameters()

Gets the custom (non-registered) parameters.

Returns:

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

getIncludedParameters

java.util.Set<java.lang.String> getIncludedParameters()

Gets the names of all included parameters (registered and custom) in the header instance.

Returns:

The included parameters.

toJSONObject

net.minidev.json.JSONObject toJSONObject()

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 registered ones.

Returns:

The JSON object representation of the header.

toString

java.lang.String toString()

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 registered ones.

Overrides:

toString in class java.lang.Object

Returns:

The JSON string representation of the header.

toBase64URL

Base64URL toBase64URL()

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).

Returns:

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