io.vertx.ext.web.handler.impl

Class FormLoginHandlerImpl

java.lang.Object

io.vertx.ext.web.handler.impl.AuthenticationHandlerImpl<AuthenticationProvider>

io.vertx.ext.web.handler.impl.FormLoginHandlerImpl

All Implemented Interfaces:

Handler<RoutingContext>, AuthenticationHandler, FormLoginHandler

public class FormLoginHandlerImpl
extends AuthenticationHandlerImpl<AuthenticationProvider>
implements FormLoginHandler

Author:

Tim Fox

Field Summary

Fields inherited from class io.vertx.ext.web.handler.impl.AuthenticationHandlerImpl

authProvider, realm

Fields inherited from interface io.vertx.ext.web.handler.FormLoginHandler

DEFAULT_PASSWORD_PARAM, DEFAULT_RETURN_URL_PARAM, DEFAULT_USERNAME_PARAM

Constructor Summary

Constructors

Constructor and Description
FormLoginHandlerImpl(AuthenticationProvider authProvider, String usernameParam, String passwordParam, String returnURLParam, String directLoggedInOKURL)

Method Summary

Modifier and Type	Method and Description
void	parseCredentials(RoutingContext context, Handler<AsyncResult<Credentials>> handler) Parses the credentials from the request into a JsonObject.
void	postAuthentication(RoutingContext ctx) This method is called to perform any post authentication tasks, such as redirects.
FormLoginHandler	setDirectLoggedInOKURL(String directLoggedInOKURL) Set the url to redirect to if the user logs in directly at the url of the form login handler without being redirected here first
FormLoginHandler	setPasswordParam(String passwordParam) Set the name of the form param used to submit the password
FormLoginHandler	setReturnURLParam(String returnURLParam) Set the name of the session attrioute used to specify the return url
FormLoginHandler	setUsernameParam(String usernameParam) Set the name of the form param used to submit the username

Methods inherited from class io.vertx.ext.web.handler.impl.AuthenticationHandlerImpl

getAuthProvider, handle, processException

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.ext.web.handler.FormLoginHandler

create, create

Methods inherited from interface io.vertx.core.Handler

handle

Methods inherited from interface io.vertx.ext.web.handler.AuthenticationHandler

authenticateHeader, parseCredentials

Constructor Detail

FormLoginHandlerImpl

public FormLoginHandlerImpl(AuthenticationProvider authProvider,
                            String usernameParam,
                            String passwordParam,
                            String returnURLParam,
                            String directLoggedInOKURL)

Method Detail

setUsernameParam

public FormLoginHandler setUsernameParam(String usernameParam)

Description copied from interface: FormLoginHandler

Set the name of the form param used to submit the username

Specified by:

setUsernameParam in interface FormLoginHandler

Parameters:

usernameParam - the name of the param

Returns:

a reference to this for a fluent API

setPasswordParam

public FormLoginHandler setPasswordParam(String passwordParam)

Description copied from interface: FormLoginHandler

Set the name of the form param used to submit the password

Specified by:

setPasswordParam in interface FormLoginHandler

Parameters:

passwordParam - the name of the param

Returns:

a reference to this for a fluent API

setReturnURLParam

public FormLoginHandler setReturnURLParam(String returnURLParam)

Description copied from interface: FormLoginHandler

Set the name of the session attrioute used to specify the return url

Specified by:

setReturnURLParam in interface FormLoginHandler

Parameters:

returnURLParam - the name of the param

Returns:

a reference to this for a fluent API

setDirectLoggedInOKURL

public FormLoginHandler setDirectLoggedInOKURL(String directLoggedInOKURL)

Description copied from interface: FormLoginHandler

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

Specified by:

setDirectLoggedInOKURL in interface FormLoginHandler

Parameters:

directLoggedInOKURL - the URL to redirect to

Returns:

a reference to this for a fluent API

parseCredentials

public void parseCredentials(RoutingContext context,
                             Handler<AsyncResult<Credentials>> handler)

Description copied from interface: AuthenticationHandler

Parses the credentials from the request into a JsonObject. The implementation should be able to extract the required info for the auth provider in the format the provider expects.

Specified by:

parseCredentials in interface AuthenticationHandler

Parameters:

context - the routing context

handler - the handler to be called once the information is available.

postAuthentication

public void postAuthentication(RoutingContext ctx)

Description copied from interface: AuthenticationHandler

This method is called to perform any post authentication tasks, such as redirects. Overrides must call context.next() on success.

Specified by:

postAuthentication in interface AuthenticationHandler

Parameters:

ctx - the routing context