Package com.vaadin.flow.component.login

Class AbstractLogin

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.login.AbstractLogin
All Implemented Interfaces:
AttachNotifier, DetachNotifier, HasElement, HasEnabled, HasStyle, Serializable
Direct Known Subclasses:
LoginForm, LoginOverlay
public abstract class AbstractLogin extends Component implements HasEnabled
Abstract component for the <vaadin-login-overlay> and <vaadin-login-form> components. On AbstractLogin.LoginEvent component becomes disabled. Disabled component stops to process login events, however the AbstractLogin.ForgotPasswordEvent event is processed anyway. To enable use the HasEnabled.setEnabled(boolean) method. Setting error setError(boolean) true makes component automatically enabled for the next login attempt.

Server side login listener do not work in combination with HTML form submission configured by setting the action attribute. The reason is that form submission, depending on the authentication process result, will cause a redirection to a different page or to current login view. In both cases a new Flow UI will be created and the event will potentially be forwarded to a dismissed UI. In addition, if the HTTP session ID is changed as a consequence of the authentication process, the server may respond to the login event with a session expiration error, cause a client resynchronization that can in turn cancel a potential redirect issued by the form submission.
Author:
Vaadin Ltd
See Also:

  • Constructor Details

    • AbstractLogin

      public AbstractLogin()
      Initializes a new AbstractLogin with a default localization.

    • AbstractLogin

      public AbstractLogin(LoginI18n i18n)
      Initializes a new AbstractLogin.
      Parameters:
      i18n - internationalized messages to be used by this instance.

  • Method Details

    • setAction

      public void setAction(String action)
      Sets the path where to send the form-data when a form is submitted. Once action is defined a AbstractLogin.LoginEvent is not fired anymore.

      The action attribute should not be used together with login listeners added with addLoginListener(ComponentEventListener). See class Javadoc for more information.

      See Also:

    • getAction

      public String getAction()
      Returns the action defined for a login form.
      Returns:
      the value of action property

    • setError

      public void setError(boolean error)
      Sets whether to show or hide the error message. The message can be set via setI18n(LoginI18n) Calling this method with true will also enable the component.
      Parameters:
      error - true to show the error message and enable component for next login attempt, false to hide an error
      See Also:

    • isError

      @Synchronize(property="error", value="error-changed") public boolean isError()
      Returns whether the error message is displayed or not
      Returns:
      the value of error property

    • setForgotPasswordButtonVisible

      public void setForgotPasswordButtonVisible(boolean forgotPasswordButtonVisible)
      Sets whether to show or hide the forgot password button. The button is visible by default
      Parameters:
      forgotPasswordButtonVisible - whether to display or hide the button
      See Also:

    • isForgotPasswordButtonVisible

      public boolean isForgotPasswordButtonVisible()
      Returns whether the forgot password button is visible or not
      Returns:
      true if the forgot password button is visible false otherwise

    • setI18n

      public void setI18n(LoginI18n i18n)
      Sets the internationalized messages to be used by this instance.
      Parameters:
      i18n - the internationalized messages
      See Also:

    • showErrorMessage

      public void showErrorMessage(String title, String message)
      Shows given error message and sets setError(boolean) to true.
      Parameters:
      title - the error message title, may be null.
      message - the error message, may be null.

    • addLoginListener

      public Registration addLoginListener(ComponentEventListener<AbstractLogin.LoginEvent> listener)
      Adds `login` event listener.

      Login listeners should not be used together with the action attribute. See class Javadoc for more information.

      See Also:

    • addForgotPasswordListener

      public Registration addForgotPasswordListener(ComponentEventListener<AbstractLogin.ForgotPasswordEvent> listener)
      Adds `forgotPassword` event listener. Event continues being process even if the component is not HasEnabled.isEnabled().

    • onEnabledStateChanged

      public void onEnabledStateChanged(boolean enabled)
      Description copied from class: Component
      Handle component enable state when the enabled state changes.

      By default this sets or removes the 'disabled' attribute from the element. This can be overridden to have custom handling.

      Overrides:
      onEnabledStateChanged in class Component
      Parameters:
      enabled - the new enabled state of the component