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(value="${micronaut.security.endpoints.login.path:/login}")
 @Secured(value="isAnonymous()")
 @Validated
public class LoginController
extends java.lang.Object

Handles login requests.

Since:

1.0

Author:

Sergio del Amo, Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
protected Authenticator	authenticator
protected io.micronaut.context.event.ApplicationEventPublisher	eventPublisher
protected LoginHandler	loginHandler

Constructor Summary

Constructors

Constructor and Description
LoginController(Authenticator authenticator, LoginHandler loginHandler, io.micronaut.context.event.ApplicationEventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<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 Detail

authenticator

protected final Authenticator authenticator

loginHandler

protected final LoginHandler loginHandler

eventPublisher

protected final io.micronaut.context.event.ApplicationEventPublisher eventPublisher

Constructor Detail

LoginController

public LoginController(Authenticator authenticator,
                       LoginHandler loginHandler,
                       io.micronaut.context.event.ApplicationEventPublisher eventPublisher)

Parameters:

authenticator - Authenticator collaborator

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

eventPublisher - The application event publisher

Method Detail

login

@Consumes(value={"application/x-www-form-urlencoded","application/json"})
 @Post
public io.reactivex.Single<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