Package io.micronaut.security.token

Class TokenAuthenticationFetcher

java.lang.Object

io.micronaut.security.token.TokenAuthenticationFetcher

All Implemented Interfaces:

io.micronaut.core.order.Ordered, AuthenticationFetcher<io.micronaut.http.HttpRequest<?>>

@Requires(classes=io.micronaut.http.HttpRequest.class) @Requires(beans=io.micronaut.http.server.util.HttpHostResolver.class)
@Singleton
public class TokenAuthenticationFetcher
extends Object
implements AuthenticationFetcher<io.micronaut.http.HttpRequest<?>>

Attempts to retrieve a token form the HttpRequest and if existing validated. It uses a TokenResolver and the list of TokenValidator registered in the ApplicationContext.

Since:

1.0

Author:

Sergio del Amo, Graeme Rocher

Field Summary

Fields

Modifier and Type	Field	Description
protected final io.micronaut.http.server.util.HttpHostResolver	httpHostResolver
protected final io.micronaut.http.server.util.locale.HttpLocaleResolver	httpLocaleResolver
static final Integer	ORDER	The order of the fetcher.
protected final io.micronaut.context.event.ApplicationEventPublisher<TokenValidatedEvent>	tokenValidatedEventPublisher
protected final Collection<TokenValidator<io.micronaut.http.HttpRequest<?>>>	tokenValidators

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
TokenAuthenticationFetcher(Collection<TokenValidator<io.micronaut.http.HttpRequest<?>>> tokenValidators, TokenResolver<io.micronaut.http.HttpRequest<?>> tokenResolver, io.micronaut.context.event.ApplicationEventPublisher<TokenValidatedEvent> tokenValidatedEventPublisher)	Deprecated, for removal: This API element is subject to removal in a future version. Use TokenAuthenticationFetcher(java.util.List<io.micronaut.security.token.validator.TokenValidator<io.micronaut.http.HttpRequest<?>>>,io.micronaut.security.token.reader.TokenResolver<io.micronaut.http.HttpRequest<?>>,io.micronaut.context.event.ApplicationEventPublisher<io.micronaut.security.event.TokenValidatedEvent>) instead.
TokenAuthenticationFetcher(List<TokenValidator<io.micronaut.http.HttpRequest<?>>> tokenValidators, TokenResolver<io.micronaut.http.HttpRequest<?>> tokenResolver, io.micronaut.context.event.ApplicationEventPublisher<TokenValidatedEvent> tokenValidatedEventPublisher)	Deprecated, for removal: This API element is subject to removal in a future version. Use TokenAuthenticationFetcher(java.util.List<io.micronaut.security.token.validator.TokenValidator<io.micronaut.http.HttpRequest<?>>>,io.micronaut.security.token.reader.TokenResolver<io.micronaut.http.HttpRequest<?>>,io.micronaut.context.event.ApplicationEventPublisher<io.micronaut.security.event.TokenValidatedEvent>,io.micronaut.http.server.util.HttpHostResolver,io.micronaut.http.server.util.locale.HttpLocaleResolver) instead.
TokenAuthenticationFetcher(List<TokenValidator<io.micronaut.http.HttpRequest<?>>> tokenValidators, TokenResolver<io.micronaut.http.HttpRequest<?>> tokenResolver, io.micronaut.context.event.ApplicationEventPublisher<TokenValidatedEvent> tokenValidatedEventPublisher, io.micronaut.http.server.util.HttpHostResolver httpHostResolver, io.micronaut.http.server.util.locale.HttpLocaleResolver httpLocaleResolver)

Method Summary

Modifier and Type	Method	Description
org.reactivestreams.Publisher<Authentication>	fetchAuthentication(io.micronaut.http.HttpRequest<?> request)	Attempts to read an Authentication from an HTTP Request being executed.
int	getOrder()

Methods inherited from class java.lang.Object

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

Field Details

ORDER

public static final Integer ORDER

The order of the fetcher.

tokenValidators

protected final Collection<TokenValidator<io.micronaut.http.HttpRequest<?>>> tokenValidators

httpHostResolver

protected final io.micronaut.http.server.util.HttpHostResolver httpHostResolver

httpLocaleResolver

protected final io.micronaut.http.server.util.locale.HttpLocaleResolver httpLocaleResolver

tokenValidatedEventPublisher

protected final io.micronaut.context.event.ApplicationEventPublisher<TokenValidatedEvent> tokenValidatedEventPublisher

Constructor Details

TokenAuthenticationFetcher

@Deprecated(forRemoval=true,
            since="4.4.0")
public TokenAuthenticationFetcher(Collection<TokenValidator<io.micronaut.http.HttpRequest<?>>> tokenValidators,
 TokenResolver<io.micronaut.http.HttpRequest<?>> tokenResolver,
 io.micronaut.context.event.ApplicationEventPublisher<TokenValidatedEvent> tokenValidatedEventPublisher)

Deprecated, for removal: This API element is subject to removal in a future version.

Use TokenAuthenticationFetcher(java.util.List<io.micronaut.security.token.validator.TokenValidator<io.micronaut.http.HttpRequest<?>>>,io.micronaut.security.token.reader.TokenResolver<io.micronaut.http.HttpRequest<?>>,io.micronaut.context.event.ApplicationEventPublisher<io.micronaut.security.event.TokenValidatedEvent>) instead.

Parameters:

tokenValidators - The list of TokenValidator which attempt to validate the request

tokenResolver - The TokenResolver which returns the first found token in the request.

tokenValidatedEventPublisher - Application event publisher for TokenValidatedEvent.

TokenAuthenticationFetcher

@Deprecated(forRemoval=true,
            since="4.7.0")
public TokenAuthenticationFetcher(List<TokenValidator<io.micronaut.http.HttpRequest<?>>> tokenValidators,
 TokenResolver<io.micronaut.http.HttpRequest<?>> tokenResolver,
 io.micronaut.context.event.ApplicationEventPublisher<TokenValidatedEvent> tokenValidatedEventPublisher)

Deprecated, for removal: This API element is subject to removal in a future version.

Use TokenAuthenticationFetcher(java.util.List<io.micronaut.security.token.validator.TokenValidator<io.micronaut.http.HttpRequest<?>>>,io.micronaut.security.token.reader.TokenResolver<io.micronaut.http.HttpRequest<?>>,io.micronaut.context.event.ApplicationEventPublisher<io.micronaut.security.event.TokenValidatedEvent>,io.micronaut.http.server.util.HttpHostResolver,io.micronaut.http.server.util.locale.HttpLocaleResolver) instead.

Parameters:

tokenValidators - The list of TokenValidator which attempt to validate the request

tokenResolver - The TokenResolver which returns the first found token in the request.

tokenValidatedEventPublisher - Application event publisher for TokenValidatedEvent.

TokenAuthenticationFetcher

@Inject
public TokenAuthenticationFetcher(List<TokenValidator<io.micronaut.http.HttpRequest<?>>> tokenValidators,
 TokenResolver<io.micronaut.http.HttpRequest<?>> tokenResolver,
 io.micronaut.context.event.ApplicationEventPublisher<TokenValidatedEvent> tokenValidatedEventPublisher,
 io.micronaut.http.server.util.HttpHostResolver httpHostResolver,
 io.micronaut.http.server.util.locale.HttpLocaleResolver httpLocaleResolver)

Parameters:

tokenValidators - The list of TokenValidator which attempt to validate the request

tokenResolver - The TokenResolver which returns the first found token in the request.

tokenValidatedEventPublisher - Application event publisher for TokenValidatedEvent.

httpHostResolver - The http host resolver

httpLocaleResolver - The http locale resolver

Since:

4.7.0

Method Details

fetchAuthentication

public org.reactivestreams.Publisher<Authentication> fetchAuthentication(io.micronaut.http.HttpRequest<?> request)

Description copied from interface: AuthenticationFetcher

Attempts to read an Authentication from an HTTP Request being executed.

Specified by:

fetchAuthentication in interface AuthenticationFetcher<io.micronaut.http.HttpRequest<?>>

Parameters:

request - an HTTP Request being executed.

Returns:

Authentication if found

getOrder

public int getOrder()

Specified by:

getOrder in interface io.micronaut.core.order.Ordered