Interface JWTService

  • All Known Implementing Classes:
    JWTServiceImpl

    public interface JWTService
    The JSON Web Token (JWT) Service.
    Since:
    10.3
    • Method Detail

      • newBuilder

        JWTService.JWTBuilder newBuilder()
        Creates a new builder for a JSON Web Token.
        Returns:
        the new builder
      • verifyToken

        Map<String,​Object> verifyToken​(String token)
        Verifies the token and returns its claims, or null if the token is invalid (corrupted, constructed from an invalid secret, or expired).

        The claim JWTClaims.CLAIM_SUBJECT contains the token's creator user id.

        The token hash algorithm is based on a secret provided by the service configuration.

        Parameters:
        token - the token
        Returns:
        the claims if the token is valid, or null if the token is invalid