public interface FormLoginHandler extends Handler<RoutingContext>
Used in conjunction with the RedirectAuthHandler
.
Modifier and Type | Field and Description |
---|---|
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
|
Modifier and Type | Method and Description |
---|---|
static FormLoginHandler |
create(AuthProvider authProvider)
Create a handler
|
static FormLoginHandler |
create(AuthProvider authProvider,
String usernameParam,
String passwordParam,
String returnURLParam,
String directLoggedInOKURL)
Create a handler
|
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
|
static final String DEFAULT_USERNAME_PARAM
static final String DEFAULT_PASSWORD_PARAM
static final String DEFAULT_RETURN_URL_PARAM
static FormLoginHandler create(AuthProvider authProvider)
authProvider
- the auth service to usestatic FormLoginHandler create(AuthProvider 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 firstFormLoginHandler setUsernameParam(String usernameParam)
usernameParam
- the name of the paramFormLoginHandler setPasswordParam(String passwordParam)
passwordParam
- the name of the paramFormLoginHandler setReturnURLParam(String returnURLParam)
returnURLParam
- the name of the paramFormLoginHandler setDirectLoggedInOKURL(String directLoggedInOKURL)
directLoggedInOKURL
- the URL to redirect toCopyright © 2023 Eclipse. All rights reserved.