Package io.micronaut.security.token.jwt.generator.claims

Class JWTClaimsSetGenerator

java.lang.Object
io.micronaut.security.token.jwt.generator.claims.JWTClaimsSetGenerator
All Implemented Interfaces:
io.micronaut.security.token.claims.ClaimsGenerator
@Singleton public class JWTClaimsSetGenerator extends Object implements io.micronaut.security.token.claims.ClaimsGenerator
Since:
1.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    JWTClaimsSetGenerator(io.micronaut.security.token.config.TokenConfiguration tokenConfiguration, @Nullable io.micronaut.security.token.claims.JtiGenerator jwtIdGenerator, @Nullable io.micronaut.security.token.claims.ClaimsAudienceProvider claimsAudienceProvider, @Nullable io.micronaut.runtime.ApplicationConfiguration applicationConfiguration)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,Object>
    generateClaims(io.micronaut.security.authentication.Authentication authentication, @Nullable Integer expiration)
     
    Map<String,Object>
    generateClaimsSet(Map<String,?> oldClaims, Integer expiration)
     
    protected void
    populateAud(com.nimbusds.jwt.JWTClaimsSet.Builder builder)
    Populates aud claim.
    protected void
    populateExp(com.nimbusds.jwt.JWTClaimsSet.Builder builder, @Nullable Integer expiration)
    Populates exp claim.
    protected void
    populateIat(com.nimbusds.jwt.JWTClaimsSet.Builder builder)
    Populates iat claim.
    protected void
    populateIss(com.nimbusds.jwt.JWTClaimsSet.Builder builder)
    Populates iss claim.
    protected void
    populateJti(com.nimbusds.jwt.JWTClaimsSet.Builder builder)
    Populates jti claim.
    protected void
    populateNbf(com.nimbusds.jwt.JWTClaimsSet.Builder builder)
    Populates nbf claim.
    protected void
    populateSub(com.nimbusds.jwt.JWTClaimsSet.Builder builder, io.micronaut.security.authentication.Authentication authentication)
    Populates sub claim.
    protected void
    populateWithAuthentication(com.nimbusds.jwt.JWTClaimsSet.Builder builder, io.micronaut.security.authentication.Authentication authentication)
    Populates Claims with Authentication object.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • JWTClaimsSetGenerator

      public JWTClaimsSetGenerator(io.micronaut.security.token.config.TokenConfiguration tokenConfiguration, @Nullable @Nullable io.micronaut.security.token.claims.JtiGenerator jwtIdGenerator, @Nullable @Nullable io.micronaut.security.token.claims.ClaimsAudienceProvider claimsAudienceProvider, @Nullable @Nullable io.micronaut.runtime.ApplicationConfiguration applicationConfiguration)
      Parameters:
      tokenConfiguration - Token Configuration
      jwtIdGenerator - Generator which creates unique JWT ID
      claimsAudienceProvider - Provider which identifies the recipients that the JWT is intended for.
      applicationConfiguration - The application configuration

  • Method Details

    • generateClaims

      public Map<String,Object> generateClaims(io.micronaut.security.authentication.Authentication authentication, @Nullable @Nullable Integer expiration)
      Specified by:
      generateClaims in interface io.micronaut.security.token.claims.ClaimsGenerator
      Parameters:
      authentication - Authenticated user's representation.
      expiration - expiration time in seconds
      Returns:
      The authentication claims

    • populateIss

      protected void populateIss(com.nimbusds.jwt.JWTClaimsSet.Builder builder)
      Populates iss claim.
      Parameters:
      builder - The Claims Builder
      See Also:

    • populateSub

      protected void populateSub(com.nimbusds.jwt.JWTClaimsSet.Builder builder, io.micronaut.security.authentication.Authentication authentication)
      Populates sub claim.
      Parameters:
      builder - The Claims Builder
      authentication - Authenticated user's representation.
      See Also:

    • populateAud

      protected void populateAud(com.nimbusds.jwt.JWTClaimsSet.Builder builder)
      Populates aud claim.
      Parameters:
      builder - The Claims Builder
      See Also:

    • populateExp

      protected void populateExp(com.nimbusds.jwt.JWTClaimsSet.Builder builder, @Nullable @Nullable Integer expiration)
      Populates exp claim.
      Parameters:
      builder - The Claims Builder
      expiration - expiration time in seconds
      See Also:

    • populateNbf

      protected void populateNbf(com.nimbusds.jwt.JWTClaimsSet.Builder builder)
      Populates nbf claim.
      Parameters:
      builder - The Claims Builder
      See Also:

    • populateIat

      protected void populateIat(com.nimbusds.jwt.JWTClaimsSet.Builder builder)
      Populates iat claim.
      Parameters:
      builder - The Claims Builder
      See Also:

    • populateJti

      protected void populateJti(com.nimbusds.jwt.JWTClaimsSet.Builder builder)
      Populates jti claim.
      Parameters:
      builder - The Claims Builder
      See Also:

    • populateWithAuthentication

      protected void populateWithAuthentication(com.nimbusds.jwt.JWTClaimsSet.Builder builder, io.micronaut.security.authentication.Authentication authentication)
      Populates Claims with Authentication object.
      Parameters:
      builder - the Claims Builder
      authentication - Authenticated user's representation.

    • generateClaimsSet

      public Map<String,Object> generateClaimsSet(Map<String,?> oldClaims, Integer expiration)
      Specified by:
      generateClaimsSet in interface io.micronaut.security.token.claims.ClaimsGenerator
      Parameters:
      oldClaims - The old claims to use as a base in the new token generation.
      expiration - expiration time in seconds
      Returns:
      Instance of JWTClaimsSet