io.jsonwebtoken

Interface JwsHeader

All Superinterfaces:

Header, Map<String,Object>, ProtectedHeader, X509Accessor

public interface JwsHeader
extends ProtectedHeader

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 Deprecated. since 0.12.0 in favor of Header.getAlgorithm()
static String	CRITICAL Deprecated. since 0.12.0 in favor of ProtectedHeader.getCritical()
static String	JSON_WEB_KEY Deprecated. since 0.12.0 in favor of ProtectedHeader.getJwk()
static String	JWK_SET_URL Deprecated. since 0.12.0 in favor of ProtectedHeader.getJwkSetUrl()
static String	KEY_ID Deprecated. since 0.12.0 in favor of ProtectedHeader.getKeyId()
static String	X509_CERT_CHAIN Deprecated. since 0.12.0 in favor of X509Accessor.getX509Chain()
static String	X509_CERT_SHA1_THUMBPRINT Deprecated. since 0.12.0 in favor of X509Accessor.getX509Sha1Thumbprint()
static String	X509_CERT_SHA256_THUMBPRINT Deprecated. since 0.12.0 in favor of X509Accessor.getX509Sha256Thumbprint()
static String	X509_URL Deprecated. since 0.12.0 in favor of X509Accessor.getX509Url()

Fields inherited from interface io.jsonwebtoken.Header

COMPRESSION_ALGORITHM, CONTENT_TYPE, DEPRECATED_COMPRESSION_ALGORITHM, JWT_TYPE, TYPE

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isPayloadEncoded() Returns true if the payload is Base64Url-encoded per standard JWS rules, or false if the RFC 7797: JSON Web Signature (JWS) Unencoded Payload Option has been specified.

Methods inherited from interface io.jsonwebtoken.ProtectedHeader

getCritical, getJwk, getJwkSetUrl, getKeyId

Methods inherited from interface io.jsonwebtoken.Header

getAlgorithm, getCompressionAlgorithm, getContentType, getType

Methods inherited from interface java.util.Map

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

Methods inherited from interface io.jsonwebtoken.security.X509Accessor

getX509Chain, getX509Sha1Thumbprint, getX509Sha256Thumbprint, getX509Url

Field Detail

ALGORITHM

@Deprecated
static final String ALGORITHM

Deprecated. since 0.12.0 in favor of Header.getAlgorithm()

JWS Algorithm Header name: the string literal alg

See Also:

Constant Field Values

JWK_SET_URL

@Deprecated
static final String JWK_SET_URL

Deprecated. since 0.12.0 in favor of ProtectedHeader.getJwkSetUrl()

JWS JWK Set URL Header name: the string literal jku

See Also:

Constant Field Values

JSON_WEB_KEY

@Deprecated
static final String JSON_WEB_KEY

Deprecated. since 0.12.0 in favor of ProtectedHeader.getJwk()

JWS JSON Web Key Header name: the string literal jwk

See Also:

Constant Field Values

KEY_ID

@Deprecated
static final String KEY_ID

Deprecated. since 0.12.0 in favor of ProtectedHeader.getKeyId()

JWS Key ID Header name: the string literal kid

See Also:

Constant Field Values

X509_URL

@Deprecated
static final String X509_URL

Deprecated. since 0.12.0 in favor of X509Accessor.getX509Url()

JWS X.509 URL Header name: the string literal x5u

See Also:

Constant Field Values

X509_CERT_CHAIN

@Deprecated
static final String X509_CERT_CHAIN

Deprecated. since 0.12.0 in favor of X509Accessor.getX509Chain()

JWS X.509 Certificate Chain Header name: the string literal x5c

See Also:

Constant Field Values

X509_CERT_SHA1_THUMBPRINT

@Deprecated
static final String X509_CERT_SHA1_THUMBPRINT

Deprecated. since 0.12.0 in favor of X509Accessor.getX509Sha1Thumbprint()

JWS X.509 Certificate SHA-1 Thumbprint Header name: the string literal x5t

See Also:

Constant Field Values

X509_CERT_SHA256_THUMBPRINT

@Deprecated
static final String X509_CERT_SHA256_THUMBPRINT

Deprecated. since 0.12.0 in favor of X509Accessor.getX509Sha256Thumbprint()

JWS X.509 Certificate SHA-256 Thumbprint Header name: the string literal x5t#S256

See Also:

Constant Field Values

CRITICAL

@Deprecated
static final String CRITICAL

Deprecated. since 0.12.0 in favor of ProtectedHeader.getCritical()

JWS Critical Header name: the string literal crit

See Also:

Constant Field Values

Method Detail

isPayloadEncoded

boolean isPayloadEncoded()

Returns true if the payload is Base64Url-encoded per standard JWS rules, or false if the RFC 7797: JSON Web Signature (JWS) Unencoded Payload Option has been specified.

Returns:

true if the payload is Base64Url-encoded per standard JWS rules, or false if the RFC 7797: JSON Web Signature (JWS) Unencoded Payload Option has been specified.