# Class: FormLoginHandler

## vertx-web-js/form_login_handler~ FormLoginHandler

#### new FormLoginHandler()

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

  Source:
    - form_login_handler.js, line 31

### Methods

#### handle(arg0)

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `arg0` | RoutingContext |

  Source:
    - form_login_handler.js, line 41

#### setDirectLoggedInOKURL(directLoggedInOKURL) → {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

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `directLoggedInOKURL` | string | the URL to redirect to

  Source:
    - form_login_handler.js, line 98

  ##### Returns:

  a reference to this for a fluent API
  Type
    FormLoginHandler

#### setPasswordParam(passwordParam) → {FormLoginHandler}

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

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `passwordParam` | string | the name of the param

  Source:
    - form_login_handler.js, line 69

  ##### Returns:

  a reference to this for a fluent API
  Type
    FormLoginHandler

#### setReturnURLParam(returnURLParam) → {FormLoginHandler}

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

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `returnURLParam` | string | the name of the param

  Source:
    - form_login_handler.js, line 83

  ##### Returns:

  a reference to this for a fluent API
  Type
    FormLoginHandler

#### setUsernameParam(usernameParam) → {FormLoginHandler}

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

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `usernameParam` | string | the name of the param

  Source:
    - form_login_handler.js, line 55

  ##### Returns:

  a reference to this for a fluent API
  Type
    FormLoginHandler