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

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.MarkupContainer
          org.apache.wicket.markup.html.WebMarkupContainer
              org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup
                  org.apache.wicket.markup.html.panel.Panel
                      org.apache.wicket.examples.panels.signin.SignInPanel

All Implemented Interfaces:

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<T extends Component>, Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

SignInPanel(String id)

SignInPanel(String id, boolean includeRememberMe)

Method Summary

void	forgetMe() Removes persisted form data for the signin panel (forget me)
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.
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(String username, 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, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onAfterRenderChildren, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, 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, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onConfigure, onDetach, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, 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(String id)

See Also:

Component.Component(String)

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.Component(String)

Method Detail

forgetMe

public final void forgetMe()

Removes persisted form data for the signin panel (forget me)

getPassword

public 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 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(String username,
                               String password)

Sign in user if possible.

Parameters:

username - The username

password - The password

Returns:

True if signin was successful