com.fr.cert.token.impl

类 DefaultJwtBuilder

java.lang.Object

com.fr.cert.token.impl.DefaultJwtBuilder

所有已实现的接口:

ClaimsMutator<JwtBuilder>, JwtBuilder

public class DefaultJwtBuilder
extends java.lang.Object
implements JwtBuilder

构造器概要

构造器

构造器和说明
DefaultJwtBuilder()

方法概要

方法

限定符和类型	方法和说明
JwtBuilder	addClaims(java.util.Map<java.lang.String,java.lang.Object> claims) Adds all given name/value pairs to the JSON Claims in the payload.
protected java.lang.String	base64UrlEncode(java.lang.Object o, java.lang.String errMsg)
JwtBuilder	claim(java.lang.String name, java.lang.Object value) Sets a custom JWT Claims parameter value.
java.lang.String	compact() Actually builds the JWT and serializes it to a compact, URL-safe string according to the JWT Compact Serialization rules.
JwtBuilder	compressWith(CompressionCodec compressionCodec) Compresses the JWT body using the specified CompressionCodec.
protected JwtSigner	createSigner(SignatureAlgorithm alg, java.security.Key key)
protected Claims	ensureClaims()
protected Header	ensureHeader()
JwtBuilder	setAudience(java.lang.String aud) Sets the JWT Claims aud (audience) value.
JwtBuilder	setClaims(Claims claims) Sets the JWT payload to be a JSON Claims instance.
JwtBuilder	setClaims(java.util.Map<java.lang.String,java.lang.Object> claims) Sets the JWT payload to be a JSON Claims instance populated by the specified name/value pairs.
JwtBuilder	setDescription(java.lang.String description)
JwtBuilder	setExpiration(java.util.Date exp) Sets the JWT Claims exp (expiration) value.
JwtBuilder	setHeader(Header header) Sets (and replaces) any existing header with the specified header.
JwtBuilder	setHeader(java.util.Map<java.lang.String,java.lang.Object> header) Sets (and replaces) any existing header with the specified header.
JwtBuilder	setHeaderParam(java.lang.String name, java.lang.Object value) Applies the specified name/value pair to the header.
JwtBuilder	setHeaderParams(java.util.Map<java.lang.String,java.lang.Object> params) Applies the specified name/value pairs to the header.
JwtBuilder	setId(java.lang.String jti) Sets the JWT Claims jti (JWT ID) value.
JwtBuilder	setIssuedAt(java.util.Date iat) Sets the JWT Claims iat (issued at) value.
JwtBuilder	setIssuer(java.lang.String iss) Sets the JWT Claims iss (issuer) value.
JwtBuilder	setNotBefore(java.util.Date nbf) Sets the JWT Claims nbf (not before) value.
JwtBuilder	setPayload(java.lang.String payload) Sets the JWT's payload to be a plaintext (non-JSON) string.
JwtBuilder	setSubject(java.lang.String sub) Sets the JWT Claims sub (subject) value.
JwtBuilder	signWith(SignatureAlgorithm alg, byte[] secretKey) Signs the constructed JWT using the specified algorithm with the specified key, producing a JWS.
JwtBuilder	signWith(SignatureAlgorithm alg, java.security.Key key) Signs the constructed JWT using the specified algorithm with the specified key, producing a JWS.
JwtBuilder	signWith(SignatureAlgorithm alg, java.lang.String base64EncodedSecretKey) Signs the constructed JWT using the specified algorithm with the specified key, producing a JWS.
protected byte[]	toJson(java.lang.Object object)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

DefaultJwtBuilder

public DefaultJwtBuilder()

方法详细资料

setHeader

public JwtBuilder setHeader(Header header)

从接口复制的说明: JwtBuilder

Sets (and replaces) any existing header with the specified header. If you do not want to replace the existing header and only want to append to it, use the JwtBuilder.setHeaderParams(java.util.Map) method instead.

指定者:

setHeader 在接口中 JwtBuilder

参数:

header - the header to set (and potentially replace any existing header).

返回:

the builder for method chaining.

setHeader

public JwtBuilder setHeader(java.util.Map<java.lang.String,java.lang.Object> header)

从接口复制的说明: JwtBuilder

Sets (and replaces) any existing header with the specified header. If you do not want to replace the existing header and only want to append to it, use the JwtBuilder.setHeaderParams(java.util.Map) method instead.

指定者:

setHeader 在接口中 JwtBuilder

参数:

header - the header to set (and potentially replace any existing header).

返回:

the builder for method chaining.

setHeaderParams

public JwtBuilder setHeaderParams(java.util.Map<java.lang.String,java.lang.Object> params)

从接口复制的说明: JwtBuilder

Applies the specified name/value pairs to the header. If a header does not yet exist at the time this method is called, one will be created automatically before applying the name/value pairs.

指定者:

setHeaderParams 在接口中 JwtBuilder

参数:

params - the header name/value pairs to append to the header.

返回:

the builder for method chaining.

ensureHeader

protected Header ensureHeader()

setHeaderParam

public JwtBuilder setHeaderParam(java.lang.String name,
                        java.lang.Object value)

从接口复制的说明: JwtBuilder

Applies the specified name/value pair to the header. If a header does not yet exist at the time this method is called, one will be created automatically before applying the name/value pair.

指定者:

setHeaderParam 在接口中 JwtBuilder

参数:

name - the header parameter name

value - the header parameter value

返回:

the builder for method chaining.

signWith

public JwtBuilder signWith(SignatureAlgorithm alg,
                  byte[] secretKey)

从接口复制的说明: JwtBuilder

Signs the constructed JWT using the specified algorithm with the specified key, producing a JWS.

指定者:

signWith 在接口中 JwtBuilder

参数:

alg - the JWS algorithm to use to digitally sign the JWT, thereby producing a JWS.

secretKey - the algorithm-specific signing key to use to digitally sign the JWT.

返回:

the builder for method chaining.

signWith

public JwtBuilder signWith(SignatureAlgorithm alg,
                  java.lang.String base64EncodedSecretKey)

从接口复制的说明: JwtBuilder

Signs the constructed JWT using the specified algorithm with the specified key, producing a JWS.

This is a convenience method: the string argument is first BASE64-decoded to a byte array and this resulting byte array is used to invoke JwtBuilder.signWith(SignatureAlgorithm, byte[]).

指定者:

signWith 在接口中 JwtBuilder

参数:

alg - the JWS algorithm to use to digitally sign the JWT, thereby producing a JWS.

base64EncodedSecretKey - the BASE64-encoded algorithm-specific signing key to use to digitally sign the JWT.

返回:

the builder for method chaining.

signWith

public JwtBuilder signWith(SignatureAlgorithm alg,
                  java.security.Key key)

从接口复制的说明: JwtBuilder

Signs the constructed JWT using the specified algorithm with the specified key, producing a JWS.

指定者:

signWith 在接口中 JwtBuilder

参数:

alg - the JWS algorithm to use to digitally sign the JWT, thereby producing a JWS.

key - the algorithm-specific signing key to use to digitally sign the JWT.

返回:

the builder for method chaining.

compressWith

public JwtBuilder compressWith(CompressionCodec compressionCodec)

从接口复制的说明: JwtBuilder

Compresses the JWT body using the specified CompressionCodec.

If your compact JWTs are large, and you want to reduce their total size during network transmission, this can be useful. For example, when embedding JWTs in URLs, some browsers may not support URLs longer than a certain length. Using compression can help ensure the compact JWT fits within that length. However, NOTE:

Compatibility Warning

The JWT family of specifications defines compression only for JWE (Json Web Encryption) tokens. Even so, JJWT will also support compression for JWS tokens as well if you choose to use it. However, be aware that if you use compression when creating a JWS token, other libraries may not be able to parse that JWS token. When using compression for JWS tokens, be sure that that all parties accessing the JWS token support compression for JWS.

Compression when creating JWE tokens however should be universally accepted for any library that supports JWE.

指定者:

compressWith 在接口中 JwtBuilder

参数:

compressionCodec - implementation of the CompressionCodec to be used.

返回:

the builder for method chaining.

另请参阅:

CompressionCodecs

setPayload

public JwtBuilder setPayload(java.lang.String payload)

从接口复制的说明: JwtBuilder

Sets the JWT's payload to be a plaintext (non-JSON) string. If you want the JWT body to be JSON, use the JwtBuilder.setClaims(Claims) or JwtBuilder.setClaims(java.util.Map) methods instead.

The payload and claims properties are mutually exclusive - only one of the two may be used.

指定者:

setPayload 在接口中 JwtBuilder

参数:

payload - the plaintext (non-JSON) string that will be the body of the JWT.

返回:

the builder for method chaining.

ensureClaims

protected Claims ensureClaims()

setClaims

public JwtBuilder setClaims(Claims claims)

从接口复制的说明: JwtBuilder

Sets the JWT payload to be a JSON Claims instance. If you do not want the JWT body to be JSON and instead want it to be a plaintext string, use the JwtBuilder.setPayload(String) method instead.

The payload and claims properties are mutually exclusive - only one of the two may be used.

指定者:

setClaims 在接口中 JwtBuilder

参数:

claims - the JWT claims to be set as the JWT body.

返回:

the builder for method chaining.

setClaims

public JwtBuilder setClaims(java.util.Map<java.lang.String,java.lang.Object> claims)

从接口复制的说明: JwtBuilder

Sets the JWT payload to be a JSON Claims instance populated by the specified name/value pairs. If you do not want the JWT body to be JSON and instead want it to be a plaintext string, use the JwtBuilder.setPayload(String) method instead.

The payload* and claims* properties are mutually exclusive - only one of the two may be used.

指定者:

setClaims 在接口中 JwtBuilder

参数:

claims - the JWT claims to be set as the JWT body.

返回:

the builder for method chaining.

addClaims

public JwtBuilder addClaims(java.util.Map<java.lang.String,java.lang.Object> claims)

从接口复制的说明: JwtBuilder

Adds all given name/value pairs to the JSON Claims in the payload. If a Claims instance does not yet exist at the time this method is called, one will be created automatically before applying the name/value pairs.

The payload and claims properties are mutually exclusive - only one of the two may be used.

指定者:

addClaims 在接口中 JwtBuilder

参数:

claims - the JWT claims to be added to the JWT body.

返回:

the builder for method chaining.

setIssuer

public JwtBuilder setIssuer(java.lang.String iss)

从接口复制的说明: JwtBuilder

Sets the JWT Claims iss (issuer) value. A null value will remove the property from the Claims.

This is a convenience method. It will first ensure a Claims instance exists as the JWT body and then set the Claims issuer field with the specified value. This allows you to write code like this:

 String jwt = Jwts.builder().setIssuer("Joe").compact();
 

instead of this:

 Claims claims = Jwts.claims().setIssuer("Joe");
 String jwt = Jwts.builder().setClaims(claims).compact();
 

if desired.

指定者:

setIssuer 在接口中 ClaimsMutator<JwtBuilder>

指定者:

setIssuer 在接口中 JwtBuilder

参数:

iss - the JWT iss value or null to remove the property from the Claims map.

返回:

the builder instance for method chaining.

setSubject

public JwtBuilder setSubject(java.lang.String sub)

从接口复制的说明: JwtBuilder

Sets the JWT Claims sub (subject) value. A null value will remove the property from the Claims.

This is a convenience method. It will first ensure a Claims instance exists as the JWT body and then set the Claims subject field with the specified value. This allows you to write code like this:

 String jwt = Jwts.builder().setSubject("Me").compact();
 

instead of this:

 Claims claims = Jwts.claims().setSubject("Me");
 String jwt = Jwts.builder().setClaims(claims).compact();
 

if desired.

指定者:

setSubject 在接口中 ClaimsMutator<JwtBuilder>

指定者:

setSubject 在接口中 JwtBuilder

参数:

sub - the JWT sub value or null to remove the property from the Claims map.

返回:

the builder instance for method chaining.

setAudience

public JwtBuilder setAudience(java.lang.String aud)

从接口复制的说明: JwtBuilder

Sets the JWT Claims aud (audience) value. A null value will remove the property from the Claims.

This is a convenience method. It will first ensure a Claims instance exists as the JWT body and then set the Claims audience field with the specified value. This allows you to write code like this:

 String jwt = Jwts.builder().setAudience("You").compact();
 

instead of this:

 Claims claims = Jwts.claims().setSubject("You");
 String jwt = Jwts.builder().setClaims(claims).compact();
 

if desired.

指定者:

setAudience 在接口中 ClaimsMutator<JwtBuilder>

指定者:

setAudience 在接口中 JwtBuilder

参数:

aud - the JWT aud value or null to remove the property from the Claims map.

返回:

the builder instance for method chaining.

setExpiration

public JwtBuilder setExpiration(java.util.Date exp)

从接口复制的说明: JwtBuilder

Sets the JWT Claims exp (expiration) value. A null value will remove the property from the Claims.

A JWT obtained after this timestamp should not be used.

This is a convenience method. It will first ensure a Claims instance exists as the JWT body and then set the Claims expiration field with the specified value. This allows you to write code like this:

 String jwt = Jwts.builder().setExpiration(new Date(System.currentTimeMillis() + 3600000)).compact();
 

instead of this:

 Claims claims = Jwts.claims().setExpiration(new Date(System.currentTimeMillis() + 3600000));
 String jwt = Jwts.builder().setClaims(claims).compact();
 

if desired.

指定者:

setExpiration 在接口中 ClaimsMutator<JwtBuilder>

指定者:

setExpiration 在接口中 JwtBuilder

参数:

exp - the JWT exp value or null to remove the property from the Claims map.

返回:

the builder instance for method chaining.

setNotBefore

public JwtBuilder setNotBefore(java.util.Date nbf)

从接口复制的说明: JwtBuilder

Sets the JWT Claims nbf (not before) value. A null value will remove the property from the Claims.

A JWT obtained before this timestamp should not be used.

This is a convenience method. It will first ensure a Claims instance exists as the JWT body and then set the Claims notBefore field with the specified value. This allows you to write code like this:

 String jwt = Jwts.builder().setNotBefore(new Date()).compact();
 

instead of this:

 Claims claims = Jwts.claims().setNotBefore(new Date());
 String jwt = Jwts.builder().setClaims(claims).compact();
 

if desired.

指定者:

setNotBefore 在接口中 ClaimsMutator<JwtBuilder>

指定者:

setNotBefore 在接口中 JwtBuilder

参数:

nbf - the JWT nbf value or null to remove the property from the Claims map.

返回:

the builder instance for method chaining.

setIssuedAt

public JwtBuilder setIssuedAt(java.util.Date iat)

从接口复制的说明: JwtBuilder

Sets the JWT Claims iat (issued at) value. A null value will remove the property from the Claims.

The value is the timestamp when the JWT was created.

This is a convenience method. It will first ensure a Claims instance exists as the JWT body and then set the Claims issuedAt field with the specified value. This allows you to write code like this:

 String jwt = Jwts.builder().setIssuedAt(new Date()).compact();
 

instead of this:

 Claims claims = Jwts.claims().setIssuedAt(new Date());
 String jwt = Jwts.builder().setClaims(claims).compact();
 

if desired.

指定者:

setIssuedAt 在接口中 ClaimsMutator<JwtBuilder>

指定者:

setIssuedAt 在接口中 JwtBuilder

参数:

iat - the JWT iat value or null to remove the property from the Claims map.

返回:

the builder instance for method chaining.

setId

public JwtBuilder setId(java.lang.String jti)

从接口复制的说明: JwtBuilder

Sets the JWT Claims jti (JWT ID) value. A null value will remove the property from the Claims.

The value is a CaSe-SenSiTiVe unique identifier for the JWT. If specified, this value MUST be assigned in a manner that ensures that there is a negligible probability that the same value will be accidentally assigned to a different data object. The ID can be used to prevent the JWT from being replayed.

This is a convenience method. It will first ensure a Claims instance exists as the JWT body and then set the Claims id field with the specified value. This allows you to write code like this:

 String jwt = Jwts.builder().setId(UUID.randomUUID().toString()).compact();
 

instead of this:

 Claims claims = Jwts.claims().setIssuedAt(UUID.randomUUID().toString());
 String jwt = Jwts.builder().setClaims(claims).compact();
 

if desired.

指定者:

setId 在接口中 ClaimsMutator<JwtBuilder>

指定者:

setId 在接口中 JwtBuilder

参数:

jti - the JWT jti (id) value or null to remove the property from the Claims map.

返回:

the builder instance for method chaining.

setDescription

public JwtBuilder setDescription(java.lang.String description)

指定者:

setDescription 在接口中 ClaimsMutator<JwtBuilder>

claim

public JwtBuilder claim(java.lang.String name,
               java.lang.Object value)

从接口复制的说明: JwtBuilder

Sets a custom JWT Claims parameter value. A null value will remove the property from the Claims.

This is a convenience method. It will first ensure a Claims instance exists as the JWT body and then set the named property on the Claims instance using the Claims put method. This allows you to write code like this:

 String jwt = Jwts.builder().claim("aName", "aValue").compact();
 

instead of this:

 Claims claims = Jwts.claims().put("aName", "aValue");
 String jwt = Jwts.builder().setClaims(claims).compact();
 

if desired.

指定者:

claim 在接口中 JwtBuilder

参数:

name - the JWT Claims property name

value - the value to set for the specified Claims property name

返回:

the builder instance for method chaining.

compact

public java.lang.String compact()

从接口复制的说明: JwtBuilder

Actually builds the JWT and serializes it to a compact, URL-safe string according to the JWT Compact Serialization rules.

指定者:

compact 在接口中 JwtBuilder

返回:

A compact URL-safe JWT string.

createSigner

protected JwtSigner createSigner(SignatureAlgorithm alg,
                     java.security.Key key)

base64UrlEncode

protected java.lang.String base64UrlEncode(java.lang.Object o,
                               java.lang.String errMsg)

toJson

protected byte[] toJson(java.lang.Object object)