Module io.inverno.mod.security.http

Package io.inverno.mod.security.http.form

Class FormLoginPageHandler<A extends ExchangeContext,B extends Exchange<A>>

java.lang.Object

io.inverno.mod.security.http.form.FormLoginPageHandler<A,B>

Type Parameters:

A - the type of the exchange context

B - the type of exchange handled by the handler

All Implemented Interfaces:

ExchangeHandler<A,B>, ReactiveExchangeHandler<A,B>

public class FormLoginPageHandler<A extends ExchangeContext,B extends Exchange<A>>
extends Object
implements ExchangeHandler<A,B>

An exhange handler that serves a whitelabel login HTML page.

The resulting HTML page contains a login form with username and password parameters that can be used by a user to submit login credentials and enter an application.

Providing a custom login page is recommended.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_LOGIN_ACTION_URI	The default login action URI: /login.
static final String	PARAMETER_ERROR	The error query parameter name.
static final String	PARAMETER_REDIRECT_URI	The redirect URI query parameter name.

Constructor Summary

Constructors

Constructor	Description
FormLoginPageHandler()	Creates a form login page handler targeting the default login action URI.
FormLoginPageHandler(String loginActionUri)	Creates a form login page handler targeting the specified login action URI.

Method Summary

Modifier and Type	Method	Description
String	getLoginActionUri()	Returns the login action URI targeted by the login form.
void	handle(B 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.ExchangeHandler

defer

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

intercept

Field Details

DEFAULT_LOGIN_ACTION_URI

public static final String DEFAULT_LOGIN_ACTION_URI

The default login action URI: /login.

See Also:

• Constant Field Values

PARAMETER_REDIRECT_URI

public static final String PARAMETER_REDIRECT_URI

The redirect URI query parameter name.

This constant is also used in FormAuthenticationErrorInterceptor, RedirectLoginSuccessHandler and RedirectLoginFailureHandler.

See Also:

• Constant Field Values

PARAMETER_ERROR

public static final String PARAMETER_ERROR

The error query parameter name.

This constant is also used in FormAuthenticationErrorInterceptor, RedirectLoginSuccessHandler and RedirectLoginFailureHandler.

See Also:

• Constant Field Values

Constructor Details

FormLoginPageHandler

public FormLoginPageHandler()

Creates a form login page handler targeting the default login action URI.

FormLoginPageHandler

public FormLoginPageHandler(String loginActionUri)

Creates a form login page handler targeting the specified login action URI.

Parameters:

loginActionUri - the login action URI targeted by the login form

Method Details

getLoginActionUri

public String getLoginActionUri()

Returns the login action URI targeted by the login form.

Returns:

a login action URI

handle

public void handle(B 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 ExchangeContext,B extends Exchange<A>>

Parameters:

exchange - the exchange to process

Throws:

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