io.jsonwebtoken

Interface ClaimsMutator<T extends ClaimsMutator<T>>

Type Parameters:

T - the type of mutator

All Known Subinterfaces:

ClaimsBuilder, JwtBuilder, JwtBuilder.BuilderClaims

public interface ClaimsMutator<T extends ClaimsMutator<T>>

Mutation (modifications) to a Claims instance.

Since:

0.2

See Also:

JwtBuilder, Claims

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ClaimsMutator.AudienceCollection<P> A NestedCollection for setting audience() values that also allows overriding the collection to be a single string value for legacy JWT recipients if necessary.

Method Summary

Methods

Modifier and Type	Method and Description
ClaimsMutator.AudienceCollection<T>	audience() Configures the JWT aud (audience) Claim set, quietly ignoring any null, empty, whitespace-only, or existing value already in the set.
T	expiration(Date exp) Sets the JWT exp (expiration) timestamp claim.
T	id(String jti) Sets the JWT jti (JWT ID) claim.
T	issuedAt(Date iat) Sets the JWT iat (issued at) timestamp claim.
T	issuer(String iss) Sets the JWT iss (issuer) claim.
T	notBefore(Date nbf) Sets the JWT nbf (not before) timestamp claim.
T	setAudience(String aud) Deprecated. since 0.12.0 in favor of audience(). This method will be removed before the JJWT 1.0 release.
T	setExpiration(Date exp) Deprecated. since 0.12.0 in favor of the shorter and more modern builder-style named expiration(Date). This method will be removed before the JJWT 1.0 release.
T	setId(String jti) Deprecated. since 0.12.0 in favor of the shorter and more modern builder-style named id(String). This method will be removed before the JJWT 1.0 release.
T	setIssuedAt(Date iat) Deprecated. since 0.12.0 in favor of the shorter and more modern builder-style named issuedAt(Date). This method will be removed before the JJWT 1.0 release.
T	setIssuer(String iss) Deprecated. since 0.12.0 in favor of the shorter and more modern builder-style named issuer(String). This method will be removed before the JJWT 1.0 release.
T	setNotBefore(Date nbf) Deprecated. since 0.12.0 in favor of the shorter and more modern builder-style named notBefore(Date). This method will be removed before the JJWT 1.0 release.
T	setSubject(String sub) Deprecated. since 0.12.0 in favor of the shorter and more modern builder-style named subject(String). This method will be removed before the JJWT 1.0 release.
T	subject(String sub) Sets the JWT sub (subject) claim.

Method Detail

setIssuer

@Deprecated
T setIssuer(String iss)

Deprecated. since 0.12.0 in favor of the shorter and more modern builder-style named issuer(String). This method will be removed before the JJWT 1.0 release.

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

Parameters:

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

Returns:

the Claims instance for method chaining.

issuer

T issuer(String iss)

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

Parameters:

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

Returns:

the Claims instance for method chaining.

Since:

0.12.0

setSubject

@Deprecated
T setSubject(String sub)

Deprecated. since 0.12.0 in favor of the shorter and more modern builder-style named subject(String). This method will be removed before the JJWT 1.0 release.

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

Parameters:

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

Returns:

the Claims instance for method chaining.

subject

T subject(String sub)

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

Parameters:

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

Returns:

the Claims instance for method chaining.

Since:

0.12.0

setAudience

@Deprecated
T setAudience(String aud)

Deprecated. since 0.12.0 in favor of audience(). This method will be removed before the JJWT 1.0 release.

Sets the JWT aud (audience) claim as a single String, NOT a String array. This method exists only for producing JWTs sent to legacy recipients that are unable to interpret the aud value as a JSON String Array; it is strongly recommended to avoid calling this method whenever possible and favor the audience().add(String) and add(Collection) methods instead, as they ensure a single deterministic data type for recipients.

Parameters:

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

Returns:

the Claims instance for method chaining.

audience

ClaimsMutator.AudienceCollection<T> audience()

Configures the JWT aud (audience) Claim set, quietly ignoring any null, empty, whitespace-only, or existing value already in the set.

When finished, the audience collection's and() method may be used to continue configuration. For example:

  Jwts.builder() // or Jwts.claims()

     .audience().add("anAudience").and() // return parent

  .subject("Joe") // resume configuration...
  // etc...
 

Returns:

the AudienceCollection to use for aud configuration.

Since:

0.12.0

See Also:

AudienceCollection, AudienceCollection.single(String)

setExpiration

@Deprecated
T setExpiration(Date exp)

Deprecated. since 0.12.0 in favor of the shorter and more modern builder-style named expiration(Date). This method will be removed before the JJWT 1.0 release.

Sets the JWT exp (expiration) timestamp claim. A null value will remove the property from the JSON Claims 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.

expiration

T expiration(Date exp)

Sets the JWT exp (expiration) timestamp claim. A null value will remove the property from the JSON Claims 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.

Since:

0.12.0

setNotBefore

@Deprecated
T setNotBefore(Date nbf)

Deprecated. since 0.12.0 in favor of the shorter and more modern builder-style named notBefore(Date). This method will be removed before the JJWT 1.0 release.

Sets the JWT nbf (not before) timestamp claim. A null value will remove the property from the JSON Claims 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.

notBefore

T notBefore(Date nbf)

Sets the JWT nbf (not before) timestamp claim. A null value will remove the property from the JSON Claims 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.

Since:

0.12.0

setIssuedAt

@Deprecated
T setIssuedAt(Date iat)

Deprecated. since 0.12.0 in favor of the shorter and more modern builder-style named issuedAt(Date). This method will be removed before the JJWT 1.0 release.

Sets the JWT iat (issued at) timestamp claim. A null value will remove the property from the JSON Claims 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.

issuedAt

T issuedAt(Date iat)

Sets the JWT iat (issued at) timestamp claim. A null value will remove the property from the JSON Claims 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.

Since:

0.12.0

setId

@Deprecated
T setId(String jti)

Deprecated. since 0.12.0 in favor of the shorter and more modern builder-style named id(String). This method will be removed before the JJWT 1.0 release.

Sets the JWT jti (JWT ID) claim. A null value will remove the property from the JSON Claims 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.

id

T id(String jti)

Sets the JWT jti (JWT ID) claim. A null value will remove the property from the JSON Claims 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.

Since:

0.12.0