Package io.vertx.mutiny.ext.web.handler

Class FormLoginHandler

java.lang.Object

io.vertx.mutiny.ext.web.handler.FormLoginHandler

All Implemented Interfaces:

MutinyDelegate, io.vertx.core.Handler<RoutingContext>, AuthenticationHandler, Consumer<RoutingContext>

public class FormLoginHandler
extends Object
implements MutinyDelegate, AuthenticationHandler, io.vertx.core.Handler<RoutingContext>, Consumer<RoutingContext>

Handler that handles login from a form on a custom login page.

Used in conjunction with the RedirectAuthHandler.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field	Description
static final TypeArg<FormLoginHandler>	__TYPE_ARG
static final String	DEFAULT_PASSWORD_PARAM	The default value of the form attribute which will contain the password
static final String	DEFAULT_RETURN_URL_PARAM	The default value of the session attribute which will contain the return url
static final String	DEFAULT_USERNAME_PARAM	The default value of the form attribute which will contain the username

Constructor Summary

Constructors

Constructor	Description
FormLoginHandler(io.vertx.ext.web.handler.FormLoginHandler delegate)
FormLoginHandler(Object delegate)

Method Summary

Modifier and Type	Method	Description
void	accept(RoutingContext item)
static FormLoginHandler	create(AuthenticationProvider authProvider)
static FormLoginHandler	create(AuthenticationProvider authProvider, String usernameParam, String passwordParam, String returnURLParam, String directLoggedInOKURL)
boolean	equals(Object o)
io.vertx.ext.web.handler.FormLoginHandler	getDelegate()
void	handle(RoutingContext arg0)
int	hashCode()
static FormLoginHandler	newInstance(io.vertx.ext.web.handler.FormLoginHandler arg)
FormLoginHandler	setDirectLoggedInOKURL(String directLoggedInOKURL)
FormLoginHandler	setPasswordParam(String passwordParam)
FormLoginHandler	setReturnURLParam(String returnURLParam)
FormLoginHandler	setUsernameParam(String usernameParam)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Consumer

andThen

Field Details

__TYPE_ARG

public static final TypeArg<FormLoginHandler> __TYPE_ARG

DEFAULT_USERNAME_PARAM

public static final String DEFAULT_USERNAME_PARAM

The default value of the form attribute which will contain the username

See Also:

• Constant Field Values

DEFAULT_PASSWORD_PARAM

public static final String DEFAULT_PASSWORD_PARAM

The default value of the form attribute which will contain the password

See Also:

• Constant Field Values

DEFAULT_RETURN_URL_PARAM

public static final String DEFAULT_RETURN_URL_PARAM

The default value of the session attribute which will contain the return url

See Also:

• Constant Field Values

Constructor Details

FormLoginHandler

public FormLoginHandler(io.vertx.ext.web.handler.FormLoginHandler delegate)

FormLoginHandler

public FormLoginHandler(Object delegate)

Method Details

getDelegate

public io.vertx.ext.web.handler.FormLoginHandler getDelegate()

Specified by:

getDelegate in interface AuthenticationHandler

Specified by:

getDelegate in interface MutinyDelegate

Returns:

the delegate used by this Mutiny object of generated type

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

handle

public void handle(RoutingContext arg0)

Specified by:

handle in interface AuthenticationHandler

Specified by:

handle in interface io.vertx.core.Handler<RoutingContext>

create

public static FormLoginHandler create(AuthenticationProvider authProvider)

Parameters:

authProvider - the auth service to use

Returns:

the handler

create

public static FormLoginHandler create(AuthenticationProvider authProvider,
 String usernameParam,
 String passwordParam,
 String returnURLParam,
 String directLoggedInOKURL)

Parameters:

authProvider - the auth service to use

usernameParam - the value of the form attribute which will contain the username

passwordParam - the value of the form attribute which will contain the password

returnURLParam - the value of the session attribute which will contain the return url

directLoggedInOKURL - a url to redirect to if the user logs in directly at the url of the form login handler without being redirected here first

Returns:

the handler

setUsernameParam

public FormLoginHandler setUsernameParam(String usernameParam)

Parameters:

usernameParam - the name of the param

Returns:

a reference to this for a fluent API

setPasswordParam

public FormLoginHandler setPasswordParam(String passwordParam)

Parameters:

passwordParam - the name of the param

Returns:

a reference to this for a fluent API

setReturnURLParam

public FormLoginHandler setReturnURLParam(String returnURLParam)

Parameters:

returnURLParam - the name of the param

Returns:

a reference to this for a fluent API

setDirectLoggedInOKURL

public FormLoginHandler setDirectLoggedInOKURL(String directLoggedInOKURL)

Parameters:

directLoggedInOKURL - the URL to redirect to

Returns:

a reference to this for a fluent API

accept

public void accept(RoutingContext item)

Specified by:

accept in interface AuthenticationHandler

Specified by:

accept in interface Consumer<RoutingContext>

newInstance

public static FormLoginHandler newInstance(io.vertx.ext.web.handler.FormLoginHandler arg)