Module org.apache.wicket.auth.roles
Package org.apache.wicket.authroles.authentication.panel

Class SignInPanel

java.lang.Object
org.apache.wicket.Component
org.apache.wicket.MarkupContainer
org.apache.wicket.markup.html.WebMarkupContainer
org.apache.wicket.markup.html.panel.Panel
org.apache.wicket.authroles.authentication.panel.SignInPanel
All Implemented Interfaces:
Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IQueueRegion, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable
public class SignInPanel extends Panel
Reusable user sign in panel with username and password as well as support for persistence of the both. When the SignInPanel's form is submitted, the method signIn(String, String) is called, passing the username and password submitted. The signIn() method should authenticate the user's session.
Author:
Jonathan Locke, Juergen Donnerstag, Eelco Hillenius
See Also:

  • Constructor Details

  • Method Details

    • getForm

      protected SignInPanel.SignInForm getForm()
      Returns:
      signin form

    • onConfigure

      protected void onConfigure()
      Try to sign-in with remembered credentials.
      Overrides:
      onConfigure in class Component
      See Also:

    • getPassword

      public String getPassword()
      Convenience method to access the password.
      Returns:
      The password

    • setPassword

      public void setPassword(String password)
      Set the password
      Parameters:
      password -

    • getUsername

      public String getUsername()
      Convenience method to access the username.
      Returns:
      The user name

    • setUsername

      public void setUsername(String username)
      Set the username
      Parameters:
      username -

    • getRememberMe

      public boolean getRememberMe()
      Get model object of the rememberMe checkbox
      Returns:
      True if user should be remembered in the future

    • setRememberMe

      public void setRememberMe(boolean rememberMe)
      Parameters:
      rememberMe - If true, rememberMe will be enabled (username and password will be persisted somewhere)

    • onSignInFailed

      protected void onSignInFailed()
      Called when sign in failed

    • onSignInSucceeded

      protected void onSignInSucceeded()
      Called when sign in was successful

    • onSignInRemembered

      protected void onSignInRemembered()
      Called when sign-in was remembered.

      By default tries to continue to the original destination or switches to the application's home page.

      Note: This method will be called during rendering of this panel, thus a RestartResponseException has to be used to switch to a different page.

      See Also: