io.jsonwebtoken

Interface ClaimsMutator<T extends ClaimsMutator>

Type Parameters:

T - the type of mutator

All Known Subinterfaces:

Claims, JwtBuilder

public interface ClaimsMutator<T extends ClaimsMutator>

Mutation (modifications) to a Claims instance.

Since:

0.2

See Also:

JwtBuilder, Claims

Method Summary

Modifier and Type	Method and Description
T	setAudience(String aud) Sets the JWT aud (audience) value.
T	setExpiration(Date exp) Sets the JWT exp (expiration) timestamp.
T	setId(String jti) Sets the JWT jti (JWT ID) value.
T	setIssuedAt(Date iat) Sets the JWT iat (issued at) timestamp.
T	setIssuer(String iss) Sets the JWT iss (issuer) value.
T	setNotBefore(Date nbf) Sets the JWT nbf (not before) timestamp.
T	setSubject(String sub) Sets the JWT sub (subject) value.

Method Detail

setIssuer

T setIssuer(String iss)

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

Parameters:

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

Returns:

the Claims instance for method chaining.

setSubject

T setSubject(String sub)

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

Parameters:

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

Returns:

the Claims instance for method chaining.

setAudience

T setAudience(String aud)

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

Parameters:

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

Returns:

the Claims instance for method chaining.

setExpiration

T setExpiration(Date exp)

Sets the JWT exp (expiration) timestamp. A null value will remove the property from the JSON map.

A JWT obtained after this timestamp should not be used.

Parameters:

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

Returns:

the Claims instance for method chaining.

setNotBefore

T setNotBefore(Date nbf)

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

A JWT obtained before this timestamp should not be used.

Parameters:

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

Returns:

the Claims instance for method chaining.

setIssuedAt

T setIssuedAt(Date iat)

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

The value is the timestamp when the JWT was created.

Parameters:

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

Returns:

the Claims instance for method chaining.

setId

T setId(String jti)

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

This 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.

Parameters:

jti - the JWT jti value or null to remove the property from the JSON map.

Returns:

the Claims instance for method chaining.