Package io.micronaut.security.authentication

Interface AuthenticationProvider

All Known Implementing Classes:
LdapAuthenticationProvider, OauthPasswordAuthenticationProvider, OpenIdPasswordAuthenticationProvider
public interface AuthenticationProvider
Defines an authentication provider.
Since:
1.0
Author:
Sergio del Amo, Graeme Rocher

  • Method Summary

    Modifier and Type
    Method
    Description
    org.reactivestreams.Publisher<AuthenticationResponse>
    authenticate(io.micronaut.http.HttpRequest<?> httpRequest, AuthenticationRequest<?,?> authenticationRequest)
    Authenticates a user with the given request.

  • Method Details

    • authenticate

      org.reactivestreams.Publisher<AuthenticationResponse> authenticate(@Nullable io.micronaut.http.HttpRequest<?> httpRequest, AuthenticationRequest<?,?> authenticationRequest)
      Authenticates a user with the given request. If a successful authentication is returned, the object must be an instance of Authentication. Publishers MUST emit cold observables! This method will be called for all authenticators for each authentication request and it is assumed no work will be done until the publisher is subscribed to.
      Parameters:
      httpRequest - The http request
      authenticationRequest - The credentials to authenticate
      Returns:
      A publisher that emits 0 or 1 responses