io.micronaut.security.authentication

Class BasicAuthAuthenticationFetcher

java.lang.Object

io.micronaut.security.authentication.BasicAuthAuthenticationFetcher

All Implemented Interfaces:

io.micronaut.core.order.Ordered, AuthenticationFetcher

@Requires(property="micronaut.security.basic-auth.enabled",
          notEquals="false")
 @Singleton
public class BasicAuthAuthenticationFetcher
extends java.lang.Object
implements AuthenticationFetcher

An implementation of AuthenticationFetcher that decodes a username and password from the Authorization header and authenticates the credentials against any AuthenticationProviders available.

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
BasicAuthAuthenticationFetcher(Authenticator authenticator, TokenConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.Publisher<Authentication>	fetchAuthentication(io.micronaut.http.HttpRequest<?> request) Attempts to read an Authentication from a HttpRequest being executed.
java.util.Optional<UsernamePasswordCredentials>	parseCredentials(java.lang.String authorization)

Methods inherited from class java.lang.Object

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

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

getOrder

Constructor Detail

BasicAuthAuthenticationFetcher

public BasicAuthAuthenticationFetcher(Authenticator authenticator,
                                      TokenConfiguration configuration)

Parameters:

authenticator - The authenticator to authenticate the credentials

configuration - The basic authentication configuration

Method Detail

fetchAuthentication

public org.reactivestreams.Publisher<Authentication> fetchAuthentication(io.micronaut.http.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

parseCredentials

@NonNull
public java.util.Optional<UsernamePasswordCredentials> parseCredentials(@NonNull
                                                                                 java.lang.String authorization)

Parameters:

authorization - Authorization HTTP Header value

Returns:

Extracted Credentials as a UsernamePasswordCredentials or an empty optional if not possible.