Package io.micronaut.security.endpoints

Class LoginController

java.lang.Object

io.micronaut.security.endpoints.LoginController

@Requires(property="micronaut.security.endpoints.login.enabled",notEquals="false",defaultValue="true") @Requires(beans=LoginHandler.class) @Requires(beans=Authenticator.class)
@Controller("${micronaut.security.endpoints.login.path:/login}")
@Secured("isAnonymous()")
@Validated
public class LoginController
extends Object

Handles login requests.

Since:

1.0

Author:

Sergio del Amo, Graeme Rocher

Field Summary

Fields

Modifier and Type	Field	Description
protected final Authenticator	authenticator
protected final io.micronaut.context.event.ApplicationEventPublisher<LoginFailedEvent>	loginFailedEventPublisher
protected final LoginHandler	loginHandler
protected final io.micronaut.context.event.ApplicationEventPublisher<LoginSuccessfulEvent>	loginSuccessfulEventPublisher

Constructor Summary

Constructors

Constructor	Description
LoginController(Authenticator authenticator, LoginHandler loginHandler, io.micronaut.context.event.ApplicationEventPublisher<LoginSuccessfulEvent> loginSuccessfulEventPublisher, io.micronaut.context.event.ApplicationEventPublisher<LoginFailedEvent> loginFailedEventPublisher)

Method Summary

Modifier and Type	Method	Description
org.reactivestreams.Publisher<io.micronaut.http.MutableHttpResponse<?>>	login(@Valid UsernamePasswordCredentials usernamePasswordCredentials, io.micronaut.http.HttpRequest<?> request)

Methods inherited from class java.lang.Object

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

Field Details

authenticator

protected final Authenticator authenticator

loginHandler

protected final LoginHandler loginHandler

loginSuccessfulEventPublisher

protected final io.micronaut.context.event.ApplicationEventPublisher<LoginSuccessfulEvent> loginSuccessfulEventPublisher

loginFailedEventPublisher

protected final io.micronaut.context.event.ApplicationEventPublisher<LoginFailedEvent> loginFailedEventPublisher

Constructor Details

LoginController

public LoginController(Authenticator authenticator,
 LoginHandler loginHandler,
 io.micronaut.context.event.ApplicationEventPublisher<LoginSuccessfulEvent> loginSuccessfulEventPublisher,
 io.micronaut.context.event.ApplicationEventPublisher<LoginFailedEvent> loginFailedEventPublisher)

Parameters:

authenticator - Authenticator collaborator

loginHandler - A collaborator which helps to build HTTP response depending on success or failure.

loginSuccessfulEventPublisher - Application event publisher for LoginSuccessfulEvent.

loginFailedEventPublisher - Application event publisher for LoginFailedEvent.

Method Details

login

@Consumes({"application/x-www-form-urlencoded","application/json"})
@Post
@SingleResult
public org.reactivestreams.Publisher<io.micronaut.http.MutableHttpResponse<?>> login(@Valid @Body
 @Valid UsernamePasswordCredentials usernamePasswordCredentials,
 io.micronaut.http.HttpRequest<?> request)

Parameters:

usernamePasswordCredentials - An instance of UsernamePasswordCredentials in the body payload

request - The HttpRequest being executed

Returns:

An AccessRefreshToken encapsulated in the HttpResponse or a failure indicated by the HTTP status