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:

java.io.Serializable, java.lang.Iterable<Component>, IEventSink, IEventSource, IClusterable, IConverterLocator, IHeaderContributor, IRequestableComponent, IHierarchical<Component>

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:

IAuthenticationStrategy}, ISecuritySettings#getAuthenticationStrategy()}, DefaultAuthenticationStrategy}, WebSession#authenticate(String, String)}, Serialized Form

Nested Class Summary

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_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

SignInPanel(java.lang.String id)

SignInPanel(java.lang.String id, boolean includeRememberMe)

Method Summary

protected SignInPanel.SignInForm	getForm()
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.
protected void	onBeforeRender() Called just before a component is rendered.
protected void	onSignInFailed() Called when sign in failed
protected void	onSignInSucceeded() Called when sign in was successful
void	setPassword(java.lang.String password) Set the password
void	setRememberMe(boolean rememberMe)
void	setUsername(java.lang.String username) Set the username

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

newMarkupSourcingStrategy

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

getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, hasAssociatedMarkup, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onMarkupAttached, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, 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, getFeedbackMessage, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, 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, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markRendering, modelChanged, modelChanging, onAfterRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, 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

getForm

protected SignInPanel.SignInForm getForm()

Returns:

signin form

onBeforeRender

protected void onBeforeRender()

Description copied from class: Component

Called just before a component is rendered.

NOTE: If you override this, you *must* call super.onBeforeRender() within your implementation. Because this method is responsible for cascading Component.onBeforeRender() call to its children it is strongly recommended that super call is made at the end of the override.

Overrides:

onBeforeRender in class Component

See Also:

Component.onBeforeRender()

getPassword

public java.lang.String getPassword()

Convenience method to access the password.

Returns:

The password

setPassword

public void setPassword(java.lang.String password)

Set the password

Parameters:

password -

getUsername

public java.lang.String getUsername()

Convenience method to access the username.

Returns:

The user name

setUsername

public void setUsername(java.lang.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