public class FormLoginHandler extends Object implements Handler<RoutingContext>
Used in conjunction with the RedirectAuthHandler
.
original
non RX-ified interface using Vert.x codegen.Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<FormLoginHandler> |
__TYPE_ARG |
static String |
DEFAULT_PASSWORD_PARAM
The default value of the form attribute which will contain the password
|
static String |
DEFAULT_RETURN_URL_PARAM
The default value of the session attribute which will contain the return url
|
static String |
DEFAULT_USERNAME_PARAM
The default value of the form attribute which will contain the username
|
Constructor and Description |
---|
FormLoginHandler(FormLoginHandler delegate) |
FormLoginHandler(Object delegate) |
Modifier and Type | Method and Description |
---|---|
static FormLoginHandler |
create(AuthenticationProvider authProvider)
Create a handler
|
static FormLoginHandler |
create(AuthenticationProvider authProvider,
String usernameParam,
String passwordParam,
String returnURLParam,
String directLoggedInOKURL)
Create a handler
|
boolean |
equals(Object o) |
FormLoginHandler |
getDelegate() |
void |
handle(RoutingContext event)
Something has happened, so handle it.
|
int |
hashCode() |
static FormLoginHandler |
newInstance(FormLoginHandler arg) |
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
|
String |
toString() |
public static final io.vertx.lang.rx.TypeArg<FormLoginHandler> __TYPE_ARG
public static final String DEFAULT_USERNAME_PARAM
public static final String DEFAULT_PASSWORD_PARAM
public static final String DEFAULT_RETURN_URL_PARAM
public FormLoginHandler(FormLoginHandler delegate)
public FormLoginHandler(Object delegate)
public FormLoginHandler getDelegate()
public void handle(RoutingContext event)
handle
in interface Handler<RoutingContext>
event
- the event to handlepublic static FormLoginHandler create(AuthenticationProvider authProvider)
authProvider
- the auth service to usepublic static FormLoginHandler create(AuthenticationProvider authProvider, String usernameParam, String passwordParam, String returnURLParam, String directLoggedInOKURL)
authProvider
- the auth service to useusernameParam
- the value of the form attribute which will contain the usernamepasswordParam
- the value of the form attribute which will contain the passwordreturnURLParam
- the value of the session attribute which will contain the return urldirectLoggedInOKURL
- a url to redirect to if the user logs in directly at the url of the form login handler without being redirected here firstpublic FormLoginHandler setUsernameParam(String usernameParam)
usernameParam
- the name of the parampublic FormLoginHandler setPasswordParam(String passwordParam)
passwordParam
- the name of the parampublic FormLoginHandler setReturnURLParam(String returnURLParam)
returnURLParam
- the name of the parampublic FormLoginHandler setDirectLoggedInOKURL(String directLoggedInOKURL)
directLoggedInOKURL
- the URL to redirect topublic static FormLoginHandler newInstance(FormLoginHandler arg)
Copyright © 2022 Eclipse. All rights reserved.