io.jsonwebtoken

Interface ClaimsMutator.AudienceCollection<P>

Type Parameters:

P - the type of ClaimsMutator to return for method chaining.

All Superinterfaces:

CollectionMutator<String,NestedCollection<String,P>>, Conjunctor<P>, NestedCollection<String,P>

Enclosing interface:

ClaimsMutator<T extends ClaimsMutator<T>>

public static interface ClaimsMutator.AudienceCollection<P>
extends NestedCollection<String,P>

A NestedCollection for setting ClaimsMutator.audience() values that also allows overriding the collection to be a single string value for legacy JWT recipients if necessary.

Because this interface extends NestedCollection, the Conjunctor.and() method may be used to continue parent configuration. For example:

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

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

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

Since:

0.12.0

See Also:

single(String)

Method Summary

Methods

Modifier and Type	Method and Description
P	single(String aud) Deprecated. This is technically not deprecated because the JWT RFC mandates support for single string values, but it is marked as deprecated to discourage its use when possible.

Methods inherited from interface io.jsonwebtoken.lang.CollectionMutator

add, add, clear, remove

Methods inherited from interface io.jsonwebtoken.lang.Conjunctor

and

Method Detail

single

@Deprecated
P single(String aud)

Deprecated. This is technically not deprecated because the JWT RFC mandates support for single string values, but it is marked as deprecated to discourage its use when possible.

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 add(String) or CollectionMutator.add(Collection) methods instead, as they ensure a single deterministic data type for recipients.

Parameters:

aud - the value to use as the aud Claim single-String value (and not an array of Strings), or null, empty or whitespace to remove the property from the JSON map.

Returns:

the instance for method chaining

Since:

0.12.0