Module io.inverno.mod.security.http

Package io.inverno.mod.security.http.login

Class LoginActionHandler<A extends LoginCredentials,B extends Authentication,C extends ExchangeContext,D extends Exchange<C>>

java.lang.Object

io.inverno.mod.security.http.login.LoginActionHandler<A,B,C,D>

Type Parameters:

A - the login credentials type

B - the authentication type

C - the context type

D - the exchange type

All Implemented Interfaces:

ExchangeHandler<C,D>, ReactiveExchangeHandler<C,D>

public class LoginActionHandler<A extends LoginCredentials,B extends Authentication,C extends ExchangeContext,D extends Exchange<C>>
extends Object
implements ExchangeHandler<C,D>

An exchange handler that authenticates login credentials and delegates further processing to success and failure handlers.

A login action handler is typically used in a form login authentication to authenticate the credentials sent by a user in a POST request.

It relies on a CredentialsExtractor to extract login credentials from the request, an Authenticator to authenticate them, a LoginSuccessHandler and a LoginFailureHandler to respectively handle successful authentications and failed authentications.

Since:

1.5

Author:

Jeremy Kuhn

Constructor Summary

Constructors

Constructor	Description
LoginActionHandler(CredentialsExtractor<A> credentialsExtractor, Authenticator<A,B> authenticator)	Creates a login action handler with the specified credentials extractor and authenticator.
LoginActionHandler(CredentialsExtractor<A> credentialsExtractor, Authenticator<A,B> authenticator, LoginSuccessHandler<B,C,D> loginSuccessHandler, LoginFailureHandler<C,D> loginFailureHandler)	Creates a login action handler with the specified credentials extractor, authenticator, login success handler and login failure handler.

Method Summary

Modifier and Type	Method	Description
Mono<Void>	defer(D exchange)	By default, returns a Mono that defers the execution of ExchangeHandler.handle(io.inverno.mod.http.server.Exchange).
Authenticator<A,B>	getAuthenticator()	Returns the authenticator.
CredentialsExtractor<A>	getCredentialsExtractor()	Returns the credentials extractor.
LoginFailureHandler<C,D>	getLoginFailureHandler()	Returns the login failure handler.
LoginSuccessHandler<B,C,D>	getLoginSuccessHandler()	Returns the login success handler.
void	handle(D exchange)	Processes the specified server exchange.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.inverno.mod.http.server.ReactiveExchangeHandler

intercept

Constructor Details

LoginActionHandler

public LoginActionHandler(CredentialsExtractor<A> credentialsExtractor,
 Authenticator<A,B> authenticator)

Creates a login action handler with the specified credentials extractor and authenticator.

Parameters:

credentialsExtractor - a credentials extractor

authenticator - an authenticator

LoginActionHandler

public LoginActionHandler(CredentialsExtractor<A> credentialsExtractor,
 Authenticator<A,B> authenticator,
 LoginSuccessHandler<B,C,D> loginSuccessHandler,
 LoginFailureHandler<C,D> loginFailureHandler)

Creates a login action handler with the specified credentials extractor, authenticator, login success handler and login failure handler.

Parameters:

credentialsExtractor - a credentials extractor

authenticator - an authenticator

loginSuccessHandler - a login success handler

loginFailureHandler - a login failure handler

Method Details

getCredentialsExtractor

public CredentialsExtractor<A> getCredentialsExtractor()

Returns the credentials extractor.

Returns:

the credentials extractor

getAuthenticator

public Authenticator<A,B> getAuthenticator()

Returns the authenticator.

Returns:

the authenticator

getLoginSuccessHandler

public LoginSuccessHandler<B,C,D> getLoginSuccessHandler()

Returns the login success handler.

Returns:

the login success handler

getLoginFailureHandler

public LoginFailureHandler<C,D> getLoginFailureHandler()

Returns the login failure handler.

Returns:

the login failure handler

defer

public Mono<Void> defer(D exchange)

Description copied from interface: ExchangeHandler

By default, returns a Mono that defers the execution of ExchangeHandler.handle(io.inverno.mod.http.server.Exchange).

Specified by:

defer in interface ExchangeHandler<A extends LoginCredentials,B extends Authentication>

Specified by:

defer in interface ReactiveExchangeHandler<A extends LoginCredentials,B extends Authentication>

Parameters:

exchange - the exchange to process

Returns:

an empty mono that completes when the exchange has been processed

handle

public void handle(D exchange)
            throws HttpException

Description copied from interface: ExchangeHandler

Processes the specified server exchange.

This method is more convenient than ExchangeHandler.defer(io.inverno.mod.http.server.Exchange) when the handling logic does not need to be reactive.

Specified by:

handle in interface ExchangeHandler<A extends LoginCredentials,B extends Authentication>

Parameters:

exchange - the exchange to process

Throws:

HttpException - if an error occurs during the processing of the exchange