com.fr.cert.token

接口 JwsHeader<T extends JwsHeader<T>>

类型参数:

T - header type

所有超级接口:

Header<T>, java.util.Map<java.lang.String,java.lang.Object>

所有已知实现类:

DefaultJwsHeader

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

A JWS header.

从以下版本开始:

0.1

嵌套类概要

从接口继承的嵌套类/接口 java.util.Map

java.util.Map.Entry<K,V>

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	ALGORITHM JWS Algorithm header parameter name: "alg"
static java.lang.String	CRITICAL JWS Critical header parameter name: "crit"
static java.lang.String	JSON_WEB_KEY JWS JSON Web Key header parameter name: "jwk"
static java.lang.String	JWK_SET_URL JWS JWT Set URL header parameter name: "jku"
static java.lang.String	KEY_ID JWS Key ID header parameter name: "kid"
static java.lang.String	X509_CERT_CHAIN JWS X.509 Certificate Chain header parameter name: "x5c"
static java.lang.String	X509_CERT_SHA1_THUMBPRINT JWS X.509 Certificate SHA-1 Thumbprint header parameter name: "x5t"
static java.lang.String	X509_CERT_SHA256_THUMBPRINT JWS X.509 Certificate SHA-256 Thumbprint header parameter name: "x5t#S256"
static java.lang.String	X509_URL JWS X.509 URL header parameter name: "x5u"

从接口继承的字段 com.fr.cert.token.Header

COMPRESSION_ALGORITHM, CONTENT_TYPE, DEPRECATED_COMPRESSION_ALGORITHM, JWT_TYPE, TYPE

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getAlgorithm() Returns the JWS alg (algorithm) header value or null if not present.
java.lang.String	getKeyId() Returns the JWS kid (Key ID) header value or null if not present.
T	setAlgorithm(java.lang.String alg) Sets the JWT alg (Algorithm) header value.
T	setKeyId(java.lang.String kid) Sets the JWT kid (Key ID) header value.

从接口继承的方法 com.fr.cert.token.Header

getCompressionAlgorithm, getContentType, getType, setCompressionAlgorithm, setContentType, setType

从接口继承的方法 java.util.Map

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

字段详细资料

ALGORITHM

static final java.lang.String ALGORITHM

JWS Algorithm header parameter name: "alg"

另请参阅:

常量字段值

JWK_SET_URL

static final java.lang.String JWK_SET_URL

JWS JWT Set URL header parameter name: "jku"

另请参阅:

常量字段值

JSON_WEB_KEY

static final java.lang.String JSON_WEB_KEY

JWS JSON Web Key header parameter name: "jwk"

另请参阅:

常量字段值

KEY_ID

static final java.lang.String KEY_ID

JWS Key ID header parameter name: "kid"

另请参阅:

常量字段值

X509_URL

static final java.lang.String X509_URL

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

另请参阅:

常量字段值

X509_CERT_CHAIN

static final java.lang.String X509_CERT_CHAIN

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

另请参阅:

常量字段值

X509_CERT_SHA1_THUMBPRINT

static final java.lang.String X509_CERT_SHA1_THUMBPRINT

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

另请参阅:

常量字段值

X509_CERT_SHA256_THUMBPRINT

static final java.lang.String X509_CERT_SHA256_THUMBPRINT

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

另请参阅:

常量字段值

CRITICAL

static final java.lang.String CRITICAL

JWS Critical header parameter name: "crit"

另请参阅:

常量字段值

方法详细资料

getAlgorithm

java.lang.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.

返回:

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(java.lang.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.

参数:

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

返回:

the Header instance for method chaining.

getKeyId

java.lang.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.

返回:

the JWS kid header value or null if not present.

setKeyId

T setKeyId(java.lang.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.

参数:

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

返回:

the Header instance for method chaining.