Interface LoginFormAction

All Superinterfaces:
Action
All Known Implementing Classes:
LoginFormBean, PasswordLoginFormFactory

public interface LoginFormAction
extends Action
An action for customizing the login form.
Since:
3.3
Author:
Nicklas
  • Method Summary

    Modifier and Type Method Description
    default String getDisplayName()
    Get a name that can be displayed for users in a selection list or similar to switch between different login methods.
    default FieldInfo getExtraField()
    An optional extra field on the login form.
    String getHelp()
    Optional help text that is displayed on the login form to aid the user when logging in.
    default String getId()
    Get the ID of this login form.
    FieldInfo getLoginField()
    Get attributes for the login field on the form.
    FieldInfo getPasswordField()
    Get attributes for the password field on the form.
    boolean rememberLastLogin()
    If TRUE, the browser is asked to remember the last login used.
  • Method Details

    • getId

      default String getId()
      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.
      Since:
      3.14
    • getDisplayName

      default String getDisplayName()
      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.
      Since:
      3.14
    • getHelp

      String getHelp()
      Optional help text that is displayed on the login form to aid the user when logging in.
    • getLoginField

      FieldInfo getLoginField()
      Get attributes for the login field on the form.
    • getPasswordField

      FieldInfo getPasswordField()
      Get attributes for the password field on the form.
    • getExtraField

      default FieldInfo getExtraField()
      An optional extra field on the login form. A default implementation that returns null is provided by this interface to provide backwards compatibility.
      Since:
      3.13
    • rememberLastLogin

      boolean rememberLastLogin()
      If TRUE, the browser is asked to remember the last login used.