io.micronaut.security.token

Class TokenAuthenticationFetcher

java.lang.Object

io.micronaut.security.token.TokenAuthenticationFetcher

All Implemented Interfaces:

Ordered, AuthenticationFetcher

@Singleton
public class TokenAuthenticationFetcher
extends Object
implements AuthenticationFetcher

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 and Description
protected ApplicationEventPublisher	eventPublisher
static Integer	ORDER The order of the fetcher.
protected Collection<TokenValidator>	tokenValidators

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
TokenAuthenticationFetcher(Collection<TokenValidator> tokenValidators, Collection<TokenReader> tokenReaders, ApplicationEventPublisher eventPublisher) Deprecated. Use TokenAuthenticationFetcher(Collection, TokenResolver, ApplicationEventPublisher) instead. A TokenResolver can be created using DefaultTokenResolver.DefaultTokenResolver(Collection).
TokenAuthenticationFetcher(Collection<TokenValidator> tokenValidators, TokenResolver tokenResolver, ApplicationEventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
Publisher<Authentication>	fetchAuthentication(HttpRequest<?> request) Attempts to read an Authentication from a HttpRequest being executed.
int	getOrder()

Methods inherited from class java.lang.Object

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

Field Detail

ORDER

public static final Integer ORDER

The order of the fetcher.

tokenValidators

protected final Collection<TokenValidator> tokenValidators

eventPublisher

protected final ApplicationEventPublisher eventPublisher

Constructor Detail

TokenAuthenticationFetcher

@Inject
public TokenAuthenticationFetcher(Collection<TokenValidator> tokenValidators,
                                          TokenResolver tokenResolver,
                                          ApplicationEventPublisher eventPublisher)

Parameters:

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

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

eventPublisher - The Application event publisher

TokenAuthenticationFetcher

@Deprecated
public TokenAuthenticationFetcher(Collection<TokenValidator> tokenValidators,
                                              Collection<TokenReader> tokenReaders,
                                              ApplicationEventPublisher eventPublisher)

Deprecated. Use TokenAuthenticationFetcher(Collection, TokenResolver, ApplicationEventPublisher) instead. A TokenResolver can be created using DefaultTokenResolver.DefaultTokenResolver(Collection).

Parameters:

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

tokenReaders - The list TokenReader which attempt to read the request

eventPublisher - The Application event publisher

Method Detail

fetchAuthentication

public Publisher<Authentication> fetchAuthentication(HttpRequest<?> request)

Description copied from interface: AuthenticationFetcher

Attempts to read an Authentication from a HttpRequest being executed.

Specified by:

fetchAuthentication in interface AuthenticationFetcher

Parameters:

request - HttpRequest being executed.

Returns:

Authentication if found

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

Returns:

The order of the object. Defaults to zero (no order).