Class JwtClaims

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    AutoValue_JwtClaims

    public abstract class JwtClaims
    extends java.lang.Object
    implements java.io.Serializable
    Value class representing the set of fields used as the payload of a JWT token.

    To create and customize claims, use the builder:

    
     Claims claims = Claims.newBuilder()
         .setAudience("https://example.com/some-audience")
         .setIssuer("some-issuer@example.com")
         .setSubject("some-subject@example.com")
         .build();
     
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  JwtClaims.Builder  
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static long serialVersionUID  
    • Constructor Summary

      Constructors 
      Constructor Description
      JwtClaims()  
    • Constructor Detail

      • JwtClaims

        public JwtClaims()
    • Method Detail

      • getAudience

        @Nullable
        abstract java.lang.String getAudience()
      • getIssuer

        @Nullable
        abstract java.lang.String getIssuer()
      • getSubject

        @Nullable
        abstract java.lang.String getSubject()
      • getAdditionalClaims

        abstract java.util.Map<java.lang.String,​java.lang.String> getAdditionalClaims()
        Returns additional claims for this object. The returned map is not guaranteed to be mutable.
        Returns:
        additional claims
      • merge

        public JwtClaims merge​(JwtClaims other)
        Returns a new Claims instance with overridden fields.

        Any non-null field will overwrite the value from the original claims instance.

        Parameters:
        other - claims to override
        Returns:
        new claims