vertx / io.vertx.ext.web.handler / FormLoginHandler

# FormLoginHandler

`interface FormLoginHandler : Handler<RoutingContext>`

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

Used in conjunction with the RedirectAuthHandler.

Author
Tim Fox

### Properties

DEFAULT_PASSWORD_PARAM | `static val DEFAULT_PASSWORD_PARAM: String` The default value of the form attribute which will contain the password
DEFAULT_RETURN_URL_PARAM | `static val DEFAULT_RETURN_URL_PARAM: String` The default value of the form attribute which will contain the return url
DEFAULT_USERNAME_PARAM | `static val DEFAULT_USERNAME_PARAM: String` The default value of the form attribute which will contain the username

### Functions

create | `open static fun create(authProvider: AuthProvider): FormLoginHandler` `open static fun create(authProvider: AuthProvider, usernameParam: String, passwordParam: String, returnURLParam: String, directLoggedInOKURL: String): FormLoginHandler` Create a handler
setDirectLoggedInOKURL | `abstract fun setDirectLoggedInOKURL(directLoggedInOKURL: String): 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
setPasswordParam | `abstract fun setPasswordParam(passwordParam: String): FormLoginHandler` Set the name of the form param used to submit the password
setReturnURLParam | `abstract fun setReturnURLParam(returnURLParam: String): FormLoginHandler` Set the name of the session attrioute used to specify the return url
setUsernameParam | `abstract fun setUsernameParam(usernameParam: String): FormLoginHandler` Set the name of the form param used to submit the username