io.jsonwebtoken

Interface JwsHeader<T extends JwsHeader<T>>

Type Parameters:

T - header type

All Superinterfaces:

Header<T>, Map<String,Object>

All Known Implementing Classes:

DefaultJwsHeader

public interface JwsHeader<T extends JwsHeader<T>>
extends Header<T>

A JWS header.

Since:

0.1

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALGORITHM JWS Algorithm header parameter name: "alg"
static String	CRITICAL JWS Critical header parameter name: "crit"
static String	JSON_WEB_KEY JWS JSON Web Key header parameter name: "jwk"
static String	JWK_SET_URL JWS JWT Set URL header parameter name: "jku"
static String	KEY_ID JWS Key ID header parameter name: "kid"
static String	X509_CERT_CHAIN JWS X.509 Certificate Chain header parameter name: "x5c"
static String	X509_CERT_SHA1_THUMBPRINT JWS X.509 Certificate SHA-1 Thumbprint header parameter name: "x5t"
static String	X509_CERT_SHA256_THUMBPRINT JWS X.509 Certificate SHA-256 Thumbprint header parameter name: "x5t#S256"
static String	X509_URL JWS X.509 URL header parameter name: "x5u"

Fields inherited from interface io.jsonwebtoken.Header

COMPRESSION_ALGORITHM, CONTENT_TYPE, DEPRECATED_COMPRESSION_ALGORITHM, JWT_TYPE, TYPE

Method Summary

Modifier and Type	Method and Description
String	getAlgorithm() Returns the JWS alg (algorithm) header value or null if not present.
String	getKeyId() Returns the JWS kid (Key ID) header value or null if not present.
T	setAlgorithm(String alg) Sets the JWT alg (Algorithm) header value.
T	setKeyId(String kid) Sets the JWT kid (Key ID) header value.

Methods inherited from interface io.jsonwebtoken.Header

getCompressionAlgorithm, getContentType, getType, setCompressionAlgorithm, setContentType, setType

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Field Detail

ALGORITHM

static final String ALGORITHM

JWS Algorithm header parameter name: "alg"

See Also:

Constant Field Values

JWK_SET_URL

static final String JWK_SET_URL

JWS JWT Set URL header parameter name: "jku"

See Also:

Constant Field Values

JSON_WEB_KEY

static final String JSON_WEB_KEY

JWS JSON Web Key header parameter name: "jwk"

See Also:

Constant Field Values

KEY_ID

static final String KEY_ID

JWS Key ID header parameter name: "kid"

See Also:

Constant Field Values

X509_URL

static final String X509_URL

JWS X.509 URL header parameter name: "x5u"

See Also:

Constant Field Values

X509_CERT_CHAIN

static final String X509_CERT_CHAIN

JWS X.509 Certificate Chain header parameter name: "x5c"

See Also:

Constant Field Values

X509_CERT_SHA1_THUMBPRINT

static final String X509_CERT_SHA1_THUMBPRINT

JWS X.509 Certificate SHA-1 Thumbprint header parameter name: "x5t"

See Also:

Constant Field Values

X509_CERT_SHA256_THUMBPRINT

static final String X509_CERT_SHA256_THUMBPRINT

JWS X.509 Certificate SHA-256 Thumbprint header parameter name: "x5t#S256"

See Also:

Constant Field Values

CRITICAL

static final String CRITICAL

JWS Critical header parameter name: "crit"

See Also:

Constant Field Values

Method Detail

getAlgorithm

String getAlgorithm()

Returns the JWS alg (algorithm) header value or null if not present.

The algorithm header parameter identifies the cryptographic algorithm used to secure the JWS. Consider using SignatureAlgorithm.forName to convert this string value to a type-safe enum instance.

Returns:

the JWS alg header value or null if not present. This will always be non-null on validly constructed JWS instances, but could be null during construction.

setAlgorithm

T setAlgorithm(String alg)

Sets the JWT alg (Algorithm) header value. A null value will remove the property from the JSON map.

The algorithm header parameter identifies the cryptographic algorithm used to secure the JWS. Consider using a type-safe SignatureAlgorithm instance and using its value as the argument to this method.

Parameters:

alg - the JWS alg header value or null to remove the property from the JSON map.

Returns:

the Header instance for method chaining.

getKeyId

String getKeyId()

Returns the JWS kid (Key ID) header value or null if not present.

The keyId header parameter is a hint indicating which key was used to secure the JWS. This parameter allows originators to explicitly signal a change of key to recipients. The structure of the keyId value is unspecified.

When used with a JWK, the keyId value is used to match a JWK keyId parameter value.

Returns:

the JWS kid header value or null if not present.

setKeyId

T setKeyId(String kid)

Sets the JWT kid (Key ID) header value. A null value will remove the property from the JSON map.

The keyId header parameter is a hint indicating which key was used to secure the JWS. This parameter allows originators to explicitly signal a change of key to recipients. The structure of the keyId value is unspecified.

When used with a JWK, the keyId value is used to match a JWK keyId parameter value.

Parameters:

kid - the JWS kid header value or null to remove the property from the JSON map.

Returns:

the Header instance for method chaining.