Package io.micronaut.security.authentication

Class Authenticator<T>

java.lang.Object

io.micronaut.security.authentication.Authenticator<T>

Type Parameters:

T - Request Context Type

@Requires(condition=io.micronaut.security.authentication.AuthenticatorCondition.class)
@Singleton
public class Authenticator<T>
extends Object

An Authenticator operates on several ReactiveAuthenticationProvider instances returning the first authenticated AuthenticationResponse.

Since:

1.0

Author:

Sergio del Amo, Graeme Rocher

Field Summary

Fields

Modifier and Type	Field	Description
protected final Collection<AuthenticationProvider<T>>	authenticationProviders	Deprecated, for removal: This API element is subject to removal in a future version. Unused.

Constructor Summary

Constructors

Constructor	Description
Authenticator(io.micronaut.context.BeanContext beanContext, List<ReactiveAuthenticationProvider<T,?,?>> reactiveAuthenticationProviders, List<AuthenticationProvider<T,?,?>> authenticationProviders, SecurityConfiguration securityConfiguration)	Deprecated. Use Authenticator(BeanContext, List, List, List, SecurityConfiguration) instead.
Authenticator(io.micronaut.context.BeanContext beanContext, List<ReactiveAuthenticationProvider<T,?,?>> reactiveAuthenticationProviders, List<AuthenticationProvider<T,?,?>> authenticationProviders, List<AuthenticationProvider<T>> deprecatedAuthenticationProviders, SecurityConfiguration securityConfiguration)
Authenticator(Collection<AuthenticationProvider<T>> deprecatedAuthenticationProviders, SecurityConfiguration securityConfiguration)	Deprecated, for removal: This API element is subject to removal in a future version. Use Authenticator(BeanContext, List, List, SecurityConfiguration) instead.

Method Summary

Modifier and Type	Method	Description
org.reactivestreams.Publisher<AuthenticationResponse>	authenticate(T requestContext, AuthenticationRequest<?,?> authenticationRequest)	Authenticates the user with the provided credentials.
protected boolean	isImperativeAuthenticationProviderIsBlocking(AuthenticationProvider<?,?,?> authenticationProvider)	If ExecutorAuthenticationProvider.getExecutorName() equals `blocking` or `io` returns `true`.

Methods inherited from class java.lang.Object

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

Field Details

authenticationProviders

@Deprecated(forRemoval=true,
            since="4.5.0")
protected final Collection<AuthenticationProvider<T>> authenticationProviders

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

Unused. To be removed in the next major version.

Constructor Details

Authenticator

@Inject
public Authenticator(io.micronaut.context.BeanContext beanContext,
 List<ReactiveAuthenticationProvider<T,?,?>> reactiveAuthenticationProviders,
 List<AuthenticationProvider<T,?,?>> authenticationProviders,
 List<AuthenticationProvider<T>> deprecatedAuthenticationProviders,
 SecurityConfiguration securityConfiguration)

Parameters:

beanContext - Bean Context

reactiveAuthenticationProviders - A list of available Reactive authentication providers

authenticationProviders - A list of available imperative authentication providers

deprecatedAuthenticationProviders - A list of available deprecated authentication providers

securityConfiguration - The security configuration

Authenticator

public Authenticator(io.micronaut.context.BeanContext beanContext,
 List<ReactiveAuthenticationProvider<T,?,?>> reactiveAuthenticationProviders,
 List<AuthenticationProvider<T,?,?>> authenticationProviders,
 SecurityConfiguration securityConfiguration)

Deprecated.

Use Authenticator(BeanContext, List, List, List, SecurityConfiguration) instead.

Parameters:

beanContext - Bean Context

reactiveAuthenticationProviders - A list of available Reactive authentication providers

authenticationProviders - A list of available imperative authentication providers

securityConfiguration - The security configuration

Authenticator

@Deprecated(forRemoval=true,
            since="4.5.0")
public Authenticator(Collection<AuthenticationProvider<T>> deprecatedAuthenticationProviders,
 SecurityConfiguration securityConfiguration)

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

Use Authenticator(BeanContext, List, List, SecurityConfiguration) instead.

Parameters:

deprecatedAuthenticationProviders - A list of available authentication providers

securityConfiguration - The security configuration

Method Details

authenticate

public org.reactivestreams.Publisher<AuthenticationResponse> authenticate(T requestContext,
 AuthenticationRequest<?,?> authenticationRequest)

Authenticates the user with the provided credentials.

Parameters:

requestContext - The HTTP request

authenticationRequest - Represents a request to authenticate.

Returns:

A publisher that emits AuthenticationResponse objects

isImperativeAuthenticationProviderIsBlocking

protected boolean isImperativeAuthenticationProviderIsBlocking(AuthenticationProvider<?,?,?> authenticationProvider)

If ExecutorAuthenticationProvider.getExecutorName() equals `blocking` or `io` returns `true`.

Parameters:

authenticationProvider - An authentication provider

Returns:

Whether any of the authentication provider is blocking.