Class PasswordLoginFormFactory

All Implemented Interfaces:
DynamicActionAttributes, LoginFormAction, Action, ActionFactory<LoginFormAction>

public class PasswordLoginFormFactory
extends AbstractJspActionFactory<LoginFormAction>
implements LoginFormAction
A version of the default login form that can be installed as an extension. This extension should be disabled by default. It should be enabled only to provide regular password login functionality after installing another login manager.
Since:
3.14
Author:
nicklas
  • Field Details

    • INSTANCE

      public static final LoginFormAction INSTANCE
      The default password login form.
  • Constructor Details

    • PasswordLoginFormFactory

      public PasswordLoginFormFactory()
  • Method Details

    • getActions

      public LoginFormAction[] getActions​(InvokationContext<? super LoginFormAction> context)
      Description copied from interface: ActionFactory
      This method may be called one or several times for each request. This is decided by the extension point. If, for example, the extension point is a pure single-item extension point then this method is probably only called once. If the extension point is a per-item extension point in a list context, then this method may be called once for every item in the list. The context parameter contains all information about the context of the extension point, including the current item, if any.
      Specified by:
      getActions in interface ActionFactory<LoginFormAction>
      Parameters:
      context - The current invokation context
      Returns:
      A single LoginFormBean instance
    • getId

      public String getId()
      Description copied from interface: LoginFormAction
      Get the ID of this login form. It's main use it to enable support for multiple installed authentication managers. Clients that supports this should submit the id of the login form via the "login-form" LoginRequest attribute. Authentication managers should check this id before determining if they should handle the login request or not. Since this is a new method in BASE 3.14 a default implementation that returns null is provided for backwards compatibility. If this method returns null, the id from the extension is used instead.
      Specified by:
      getId in interface LoginFormAction
    • getDisplayName

      public String getDisplayName()
      Description copied from interface: LoginFormAction
      Get a name that can be displayed for users in a selection list or similar to switch between different login methods. Since this is a new method in BASE 3.14 a default implementation that returns null is provided for backwards compatibility. If this method returns null, the name from the extension is used instead.
      Specified by:
      getDisplayName in interface LoginFormAction
    • getHelp

      public String getHelp()
      Description copied from interface: LoginFormAction
      Optional help text that is displayed on the login form to aid the user when logging in.
      Specified by:
      getHelp in interface LoginFormAction
    • getLoginField

      public FieldInfo getLoginField()
      Description copied from interface: LoginFormAction
      Get attributes for the login field on the form.
      Specified by:
      getLoginField in interface LoginFormAction
    • getPasswordField

      public FieldInfo getPasswordField()
      Description copied from interface: LoginFormAction
      Get attributes for the password field on the form.
      Specified by:
      getPasswordField in interface LoginFormAction
    • rememberLastLogin

      public boolean rememberLastLogin()
      Description copied from interface: LoginFormAction
      If TRUE, the browser is asked to remember the last login used.
      Specified by:
      rememberLastLogin in interface LoginFormAction