com.fr.cert.token

接口 Header<T extends Header<T>>

所有超级接口:

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

所有已知子接口:

JwsHeader<T>

所有已知实现类:

DefaultHeader, DefaultJwsHeader

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

A JWT JOSE header.

This is ultimately a JSON map and any values can be added to it, but JWT JOSE standard names are provided as type-safe getters and setters for convenience.

Because this interface extends Map<String, Object>, if you would like to add your own properties, you simply use map methods, for example:

 header.put("headerParamName", "headerParamValue");
 

Creation

It is easiest to create a Header instance by calling one of the JWTs.header() factory methods.

从以下版本开始:

0.1

嵌套类概要

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

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

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	COMPRESSION_ALGORITHM JWT Compression Algorithm header parameter name: "zip"
static java.lang.String	CONTENT_TYPE JWT Content Type header parameter name: "cty"
static java.lang.String	DEPRECATED_COMPRESSION_ALGORITHM 已过时。 use COMPRESSION_ALGORITHM instead.
static java.lang.String	JWT_TYPE JWT Type (typ) value: "JWT"
static java.lang.String	TYPE JWT Type header parameter name: "typ"

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getCompressionAlgorithm() Returns the JWT calg (Compression Algorithm) header value or null if not present.
java.lang.String	getContentType() Returns the cty (Content Type) header value or null if not present.
java.lang.String	getType() Returns the typ (type) header value or null if not present.
T	setCompressionAlgorithm(java.lang.String calg) Sets the JWT calg (Compression Algorithm) header parameter value.
T	setContentType(java.lang.String cty) Sets the JWT cty (Content Type) header parameter value.
T	setType(java.lang.String typ) Sets the JWT typ (Type) header value.

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

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

字段详细资料

JWT_TYPE

static final java.lang.String JWT_TYPE

JWT Type (typ) value: "JWT"

另请参阅:

常量字段值

TYPE

static final java.lang.String TYPE

JWT Type header parameter name: "typ"

另请参阅:

常量字段值

CONTENT_TYPE

static final java.lang.String CONTENT_TYPE

JWT Content Type header parameter name: "cty"

另请参阅:

常量字段值

COMPRESSION_ALGORITHM

static final java.lang.String COMPRESSION_ALGORITHM

JWT Compression Algorithm header parameter name: "zip"

另请参阅:

常量字段值

DEPRECATED_COMPRESSION_ALGORITHM

@Deprecated
static final java.lang.String DEPRECATED_COMPRESSION_ALGORITHM

已过时。 use COMPRESSION_ALGORITHM instead.

JJWT legacy/deprecated compression algorithm header parameter name: "calg"

另请参阅:

常量字段值

方法详细资料

getType

java.lang.String getType()

Returns the typ (type) header value or null if not present.

返回:

the typ header value or null if not present.

setType

T setType(java.lang.String typ)

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

参数:

typ - the JWT JOSE typ header value or null to remove the property from the JSON map.

返回:

the Header instance for method chaining.

getContentType

java.lang.String getContentType()

Returns the cty (Content Type) header value or null if not present.

In the normal case where nested signing or encryption operations are not employed (i.e. a compact serialization JWT), the use of this header parameter is NOT RECOMMENDED. In the case that nested signing or encryption is employed, this Header Parameter MUST be present; in this case, the value MUST be JWT, to indicate that a Nested JWT is carried in this JWT. While media type names are not case-sensitive, it is RECOMMENDED that JWT always be spelled using uppercase characters for compatibility with legacy implementations. See JWT Appendix A.2 for an example of a Nested JWT.

返回:

the typ header parameter value or null if not present.

setContentType

T setContentType(java.lang.String cty)

Sets the JWT cty (Content Type) header parameter value. A null value will remove the property from the JSON map.

In the normal case where nested signing or encryption operations are not employed (i.e. a compact serialization JWT), the use of this header parameter is NOT RECOMMENDED. In the case that nested signing or encryption is employed, this Header Parameter MUST be present; in this case, the value MUST be JWT, to indicate that a Nested JWT is carried in this JWT. While media type names are not case-sensitive, it is RECOMMENDED that JWT always be spelled using uppercase characters for compatibility with legacy implementations. See JWT Appendix A.2 for an example of a Nested JWT.

参数:

cty - the JWT JOSE cty header value or null to remove the property from the JSON map.

getCompressionAlgorithm

java.lang.String getCompressionAlgorithm()

Returns the JWT calg (Compression Algorithm) header value or null if not present.

返回:

the calg header parameter value or null if not present.

从以下版本开始:

0.6.0

setCompressionAlgorithm

T setCompressionAlgorithm(java.lang.String calg)

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

The compression algorithm is NOT part of the JWT specification and must be used carefully since, is not expected that other libraries (including previous versions of this one) be able to deserialize a compressed JTW body correctly.

参数:

calg - the JWT compression algorithm calg value or null to remove the property from the JSON map.

从以下版本开始:

0.6.0