Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FormLoginHandler

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

Used in conjunction with the RedirectAuthHandler.

Hierarchy

  • FormLoginHandler

Implements

Index

Properties

Methods

Properties

Static Readonly DEFAULT_PASSWORD_PARAM

DEFAULT_PASSWORD_PARAM: string

The default value of the form attribute which will contain the password

Static Readonly DEFAULT_RETURN_URL_PARAM

DEFAULT_RETURN_URL_PARAM: string

The default value of the session attribute which will contain the return url

Static Readonly DEFAULT_USERNAME_PARAM

DEFAULT_USERNAME_PARAM: string

The default value of the form attribute which will contain the username

Methods

handle

setDirectLoggedInOKURL

  • 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

    • directLoggedInOKURL: string

    Returns FormLoginHandler

setPasswordParam

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

    Parameters

    • passwordParam: string

    Returns FormLoginHandler

setReturnURLParam

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

    Parameters

    • returnURLParam: string

    Returns FormLoginHandler

setUsernameParam

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

    Parameters

    • usernameParam: string

    Returns FormLoginHandler

Static create

  • create(authProvider: AuthenticationProvider): FormLoginHandler
  • create(authProvider: AuthenticationProvider, usernameParam: string, passwordParam: string, returnURLParam: string, directLoggedInOKURL: string): FormLoginHandler

  • Create a handler

    Parameters

    • authProvider: AuthenticationProvider

    Returns FormLoginHandler

  • Create a handler

    Parameters

    • authProvider: AuthenticationProvider
    • usernameParam: string
    • passwordParam: string
    • returnURLParam: string
    • directLoggedInOKURL: string

    Returns FormLoginHandler

Generated using TypeDoc