io.micronaut.security.token.jwt.validator

Class JwtValidator

java.lang.Object

io.micronaut.security.token.jwt.validator.JwtValidator

public final class JwtValidator
extends java.lang.Object

A builder style class for validating JWT tokens against any number of provided encryption or signature configurations and any claim validators.

Since:

1.4.0

Author:

James Kleeh

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JwtValidator.Builder A builder for JwtValidator.

Method Summary

Modifier and Type	Method and Description
static JwtValidator.Builder	builder()
java.util.Optional<com.nimbusds.jwt.JWT>	validate(com.nimbusds.jwt.JWT token) Deprecated. Use validate(JWT, HttpRequest) instead
java.util.Optional<com.nimbusds.jwt.JWT>	validate(com.nimbusds.jwt.JWT token, io.micronaut.http.HttpRequest<?> request) Validates the supplied token with any configurations and claim validators present.
java.util.Optional<com.nimbusds.jwt.JWT>	validate(java.lang.String token) Deprecated. Use validate(String, HttpRequest) instead.
java.util.Optional<com.nimbusds.jwt.JWT>	validate(java.lang.String token, io.micronaut.http.HttpRequest<?> request) Validates the supplied token with any configurations and claim validators present.

Methods inherited from class java.lang.Object

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

Method Detail

validate

@Deprecated
public java.util.Optional<com.nimbusds.jwt.JWT> validate(java.lang.String token)

Deprecated. Use validate(String, HttpRequest) instead.

Validates the supplied token with any configurations and claim validators present.

Parameters:

token - The JWT string

Returns:

An optional JWT token if validation succeeds

validate

public java.util.Optional<com.nimbusds.jwt.JWT> validate(java.lang.String token,
                                                         @Nullable
                                                         io.micronaut.http.HttpRequest<?> request)

Validates the supplied token with any configurations and claim validators present.

Parameters:

token - The JWT string

request - HTTP Request

Returns:

An optional JWT token if validation succeeds

validate

@Deprecated
public java.util.Optional<com.nimbusds.jwt.JWT> validate(com.nimbusds.jwt.JWT token)

Deprecated. Use validate(JWT, HttpRequest) instead

Validates the supplied token with any configurations and claim validators present.

Parameters:

token - The JWT token

Returns:

An optional JWT token if validation succeeds

validate

public java.util.Optional<com.nimbusds.jwt.JWT> validate(@NonNull
                                                         com.nimbusds.jwt.JWT token,
                                                         @Nullable
                                                         io.micronaut.http.HttpRequest<?> request)

Validates the supplied token with any configurations and claim validators present.

Parameters:

token - The JWT token

request - The HTTP Request which contained the JWT token

Returns:

An optional JWT token if validation succeeds

builder

public static JwtValidator.Builder builder()

Returns:

A new JWT validator builder