org.apache.wicket.examples.panels.signin
Class SignInPanel

java.lang.Object
  extended by org.apache.wicket.Component
      extended by org.apache.wicket.MarkupContainer
          extended by org.apache.wicket.markup.html.WebMarkupContainer
              extended by org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup
                  extended by org.apache.wicket.markup.html.panel.Panel
                      extended by org.apache.wicket.examples.panels.signin.SignInPanel
All Implemented Interfaces:
java.io.Serializable, IClusterable, IConverterLocator, IHeaderPartContainerProvider

public abstract class SignInPanel
extends Panel

Reusable user sign in panel with username and password as well as support for cookie persistence of the both. When the SignInPanel's form is submitted, the abstract method signIn(String, String) is called, passing the username and password submitted. The signIn() method should sign the user in and return null if no error ocurred, or a descriptive String in the event that the sign in fails.

Author:
Jonathan Locke, Juergen Donnerstag, Eelco Hillenius
See Also:
Serialized Form

Nested Class Summary
 class SignInPanel.SignInForm
          Sign in form.
 
Nested classes/interfaces inherited from class org.apache.wicket.Component
Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor, Component.VisibilityChange
 
Field Summary
 
Fields inherited from class org.apache.wicket.Component
ENABLE, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER
 
Constructor Summary
SignInPanel(java.lang.String id)
           
SignInPanel(java.lang.String id, boolean includeRememberMe)
           
 
Method Summary
 void forgetMe()
          Removes persisted form data for the signin panel (forget me)
 java.lang.String getPassword()
          Convenience method to access the password.
 boolean getRememberMe()
          Get model object of the rememberMe checkbox
 java.lang.String getUsername()
          Convenience method to access the username.
 void setPersistent(boolean enable)
          Convenience method set persistence for username and password.
 void setRememberMe(boolean rememberMe)
          Set model object for rememberMe checkbox
abstract  boolean signIn(java.lang.String username, java.lang.String password)
          Sign in user if possible.
 
Methods inherited from class org.apache.wicket.markup.html.panel.Panel
onComponentTag, onComponentTagBody, renderHead
 
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup
newHeaderPartContainer, renderHeadFromAssociatedMarkupFile
 
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer
getMarkupType, getWebPage
 
Methods inherited from class org.apache.wicket.MarkupContainer
add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren
 
Methods inherited from class org.apache.wicket.Component
add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getModelObjectAsString, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onDetach, onEndRequest, onModelChanged, onModelChanging, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMetaData, setModelObject, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SignInPanel

public SignInPanel(java.lang.String id)
See Also:
Component.Component(String)

SignInPanel

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

forgetMe

public final void forgetMe()
Removes persisted form data for the signin panel (forget me)


getPassword

public java.lang.String getPassword()
Convenience method to access the password.

Returns:
The password

getRememberMe

public boolean getRememberMe()
Get model object of the rememberMe checkbox

Returns:
True if user should be remembered in the future

getUsername

public java.lang.String getUsername()
Convenience method to access the username.

Returns:
The user name

setPersistent

public void setPersistent(boolean enable)
Convenience method set persistence for username and password.

Parameters:
enable - Whether the fields should be persistent

setRememberMe

public void setRememberMe(boolean rememberMe)
Set model object for rememberMe checkbox

Parameters:
rememberMe -

signIn

public abstract boolean signIn(java.lang.String username,
                               java.lang.String password)
Sign in user if possible.

Parameters:
username - The username
password - The password
Returns:
True if signin was successful


Copyright © 2004-2010 Apache Software Foundation. All Rights Reserved.