Package org.apache.wicket.authroles.authentication.panel

Class SignInPanel

  • All Implemented Interfaces:
    Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IMetadataContext<Serializable,​org.apache.wicket.Component>, org.apache.wicket.IQueueRegion, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable
    public class SignInPanel
extends org.apache.wicket.markup.html.panel.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:
    IAuthenticationStrategy, SecuritySettings.getAuthenticationStrategy(), DefaultAuthenticationStrategy, Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      class  SignInPanel.SignInForm
      Sign in form.

    • Field Summary

      • Fields inherited from class org.apache.wicket.markup.html.panel.Panel

        PANEL

      • Fields inherited from class org.apache.wicket.Component

        ENABLE, FLAG_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected SignInPanel.SignInForm getForm()  
      String getPassword()
      Convenience method to access the password.
      boolean getRememberMe()
      Get model object of the rememberMe checkbox
      String getUsername()
      Convenience method to access the username.
      protected void onConfigure()
      Try to sign-in with remembered credentials.
      protected void onSignInFailed()
      Called when sign in failed
      protected void onSignInRemembered()
      Called when sign-in was remembered.
      protected void onSignInSucceeded()
      Called when sign in was successful
      void setPassword​(String password)
      Set the password
      void setRememberMe​(boolean rememberMe)  
      void setUsername​(String username)
      Set the username

      • Methods inherited from class org.apache.wicket.markup.html.panel.Panel

        getRegionMarkup, newMarkupSourcingStrategy

      • Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

        getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

      • Methods inherited from class org.apache.wicket.MarkupContainer

        add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

      • Methods inherited from class org.apache.wicket.Component

        add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMarkupTag, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap

      • Methods inherited from interface org.apache.wicket.IQueueRegion

        dequeue, newDequeueContext

    • Constructor Detail

      • SignInPanel

        public SignInPanel​(String id,
                   boolean includeRememberMe)
        Parameters:
        id - See Component constructor
        includeRememberMe - True if form should include a remember-me checkbox
        See Also:
        Component(String)

    • Method Detail

      • onConfigure

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

      • 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:
        onConfigure()