io.jsonwebtoken.impl

Class DefaultJwsHeader

java.lang.Object

io.jsonwebtoken.impl.JwtMap

io.jsonwebtoken.impl.DefaultHeader

io.jsonwebtoken.impl.DefaultJwsHeader

All Implemented Interfaces:

Header, JwsHeader, Map<String,Object>

public class DefaultJwsHeader
extends DefaultHeader
implements JwsHeader

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields inherited from interface io.jsonwebtoken.JwsHeader

ALGORITHM, CRITICAL, JSON_WEB_KEY, JWK_SET_URL, KEY_ID, X509_CERT_CHAIN, X509_CERT_SHA1_THUMBPRINT, X509_CERT_SHA256_THUMBPRINT, X509_URL

Fields inherited from interface io.jsonwebtoken.Header

COMPRESSION_ALGORITHM, CONTENT_TYPE, DEPRECATED_COMPRESSION_ALGORITHM, JWT_TYPE, TYPE

Constructor Summary

Constructors

Constructor and Description
DefaultJwsHeader()
DefaultJwsHeader(Map<String,Object> map)

Method Summary

Methods

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.
JwsHeader	setAlgorithm(String alg) Sets the JWT alg (Algorithm) header value.
JwsHeader	setKeyId(String kid) Sets the JWT kid (Key ID) header value.

Methods inherited from class io.jsonwebtoken.impl.DefaultHeader

getCompressionAlgorithm, getContentType, getType, setCompressionAlgorithm, setContentType, setType

Methods inherited from class io.jsonwebtoken.impl.JwtMap

clear, containsKey, containsValue, entrySet, equals, get, getDate, getString, hashCode, isEmpty, keySet, put, putAll, remove, setDate, setValue, size, toDate, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.jsonwebtoken.Header

getCompressionAlgorithm, getContentType, getType, setCompressionAlgorithm, setContentType, setType

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

DefaultJwsHeader

public DefaultJwsHeader()

DefaultJwsHeader

public DefaultJwsHeader(Map<String,Object> map)

Method Detail

getAlgorithm

public String getAlgorithm()

Description copied from interface: JwsHeader

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.

Specified by:

getAlgorithm in interface JwsHeader

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

public JwsHeader setAlgorithm(String alg)

Description copied from interface: JwsHeader

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.

Specified by:

setAlgorithm in interface JwsHeader

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

public String getKeyId()

Description copied from interface: JwsHeader

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.

Specified by:

getKeyId in interface JwsHeader

Returns:

the JWS kid header value or null if not present.

setKeyId

public JwsHeader setKeyId(String kid)

Description copied from interface: JwsHeader

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.

Specified by:

setKeyId in interface JwsHeader

Parameters:

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

Returns:

the Header instance for method chaining.