com.neurosys.login.wicket

Class AbstractLoginForm<T extends BasicSession,U extends User>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.form.Form<T>

org.apache.wicket.markup.html.form.StatelessForm

com.neurosys.login.wicket.AbstractLoginForm<T,U>

Type Parameters:

U - as User

T - as BasicSession

All Implemented Interfaces:

ChangeGenerator<Object>, Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator, org.apache.wicket.IRequestListener, org.apache.wicket.markup.html.form.IFormSubmitListener, org.apache.wicket.markup.html.IHeaderContributor

Direct Known Subclasses:

AbstractUserLoginForm, AdminLoginForm

public abstract class AbstractLoginForm<T extends BasicSession,U extends User>
extends org.apache.wicket.markup.html.form.StatelessForm
implements ChangeGenerator<Object>

A simple Basic Auth type Sign In Form

Since this implements ChangeGenerator; it will also generate Events of Type

• Success Login - AuthenticationToken
• Failed Login - String userId
• Critical Exception - Exception

Author:

Arjun Dhar

See Also:

as Service version of this Form, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.markup.html.form.Form

org.apache.wicket.markup.html.form.Form.ValidationVisitor

Nested classes/interfaces inherited from class org.apache.wicket.Component

org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.IVisitor<T extends org.apache.wicket.Component>, org.apache.wicket.Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.markup.html.form.Form

METHOD_GET, METHOD_POST

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

Fields inherited from interface org.apache.wicket.markup.html.form.IFormSubmitListener

INTERFACE

Constructor Summary

Constructors

Constructor and Description
AbstractLoginForm(String id)

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener changeListener) Allow Notify all ChangeListeners about a change
protected String	getAuthErrorMessage(Exception e)
protected String	getAuthFailMessage()
abstract Class<? extends org.apache.wicket.markup.html.WebPage>	getDefaultLandingPage(U user) If no lading page specified on login, then goto Default.
org.apache.wicket.PageParameters	getDefaultLandingPageParameters() (Optional) @nullable true; if not null then the parameters to supply to the landing page
List	getListeners() Get list directly.
protected abstract CharSequence	getPassword(String normalizedUserId) Get password for user id
protected abstract U	getUserDetailsToLoadInSession(String userId) On successful login, load the User details into the Session
void	notifyAllListeners(Object object) Whenever a node is selected/updated, it also notifies its listeners.
protected void	onComponentTag(org.apache.wicket.markup.ComponentTag tag) Ensure this Form action goes to HTTPS controller only
void	onSubmit()
protected T	processSessionOnLogin(T existingSession) Opportunity to process, override session on login.
void	setListeners(List listeners) Set list directly.
protected T	setSessionFromUserDetails(U user, AuthenticationToken authToken) Chance to replace the Session Object itself
protected U	signIn(Principal inputPrincipal) Sign in the Principal
protected void	userValidation(U user, UpdatableAuthenticationToken authToken) Perform any additional user validation tasks on the loaded User object and also update the UpdatableAuthenticationToken if necessary.

Methods inherited from class org.apache.wicket.markup.html.form.StatelessForm

getStatelessHint, process

Methods inherited from class org.apache.wicket.markup.html.form.Form

add, appendDefaultButtonField, beforeUpdateFormComponentModels, clearInput, delegateSubmit, encodeUrlInHiddenFields, error, findForm, findSubmittingButton, getDefaultButton, getFormValidators, getHiddenFieldId, getInputNamePrefix, getJavascriptId, getJsForInterfaceUrl, getMaxSize, getMethod, getModel, getModelObject, getRootForm, getRootFormRelativeId, getValidatorKeyPrefix, getValuePersister, handleMultiPart, hasError, internalOnModelChanged, isRootForm, isSubmitted, isVersioned, loadPersistentFormComponentValues, markFormComponentsInvalid, markFormComponentsValid, onBeforeRender, onComponentTagBody, onDetach, onError, onFileUploadException, onFormSubmitted, onValidate, process, registerJavascriptNamespaces, remove, removePersistentFormComponentValues, renderHead, renderPlaceholderTag, setDefaultButton, setMaxSize, setModel, setModelObject, setMultiPart, setVersioned, updateFormComponentModels, validate, validateComponents, validateFormValidator, validateFormValidators, visitFormComponents, visitFormComponentsPostOrder, writeParamsAsHiddenFields

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, 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, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeginRequest, onConfigure, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, 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

AbstractLoginForm

public AbstractLoginForm(String id)

Method Detail

getPassword

protected abstract CharSequence getPassword(String normalizedUserId)
                                     throws Exception

Get password for user id

Parameters:

normalizedUserId - - Case Insensitive (expected lowercase but not guaranteed). Search should be case insensitive for higher usability.

Returns:

Throws:

Exception

onComponentTag

protected void onComponentTag(org.apache.wicket.markup.ComponentTag tag)

Ensure this Form action goes to HTTPS controller only

Overrides:

onComponentTag in class org.apache.wicket.markup.html.form.Form

getDefaultLandingPage

public abstract Class<? extends org.apache.wicket.markup.html.WebPage> getDefaultLandingPage(U user)

If no lading page specified on login, then goto Default.
See adminConfiguration.getProperty("site.admin.default.page") config; can use the config directly or hard code depending on app.

For more custom strategies on what to load on login, one can use BasicSession.getShell() Shell.getEnvironment() to derive final Page.

Returns:

WebPage

getDefaultLandingPageParameters

public org.apache.wicket.PageParameters getDefaultLandingPageParameters()

(Optional) @nullable true; if not null then the parameters to supply to the landing page

onSubmit

public final void onSubmit()

Overrides:

onSubmit in class org.apache.wicket.markup.html.form.Form

getAuthFailMessage

protected String getAuthFailMessage()

getUserDetailsToLoadInSession

protected abstract U getUserDetailsToLoadInSession(String userId)

On successful login, load the User details into the Session

Parameters:

userId -

Returns:

processSessionOnLogin

protected T processSessionOnLogin(T existingSession)

Opportunity to process, override session on login. A session may already exist.

Parameters:

existingSession - as T BasicSession

Default value:

Do Nothing, pass back input

setSessionFromUserDetails

protected T setSessionFromUserDetails(U user,
                                      AuthenticationToken authToken)

Chance to replace the Session Object itself

Parameters:

User - as Filled user Object from IDM System (DB,LDAP etc), returned from {getUserDetailsToLoadInSession(String) after successful authentication

authToken - as AuthenticationToken, indicating there was successful Authentication with any Auth related details in it.

Returns:

updatd session as type T

userValidation

protected void userValidation(U user,
                              UpdatableAuthenticationToken authToken)

Perform any additional user validation tasks on the loaded User object and also update the UpdatableAuthenticationToken if necessary.

Parameters:

user - as U

authToken - as type

signIn

protected U signIn(Principal inputPrincipal)

Sign in the Principal

Parameters:

inputPrincipal - as Principal

Returns:

User type , if not logged in then return null.

getAuthErrorMessage

protected String getAuthErrorMessage(Exception e)

addChangeListener

public void addChangeListener(ChangeListener changeListener)

Description copied from interface: ChangeGenerator

Allow Notify all ChangeListeners about a change

Specified by:

addChangeListener in interface ChangeGenerator<Object>

notifyAllListeners

public void notifyAllListeners(Object object)

Description copied from interface: ChangeGenerator

Whenever a node is selected/updated, it also notifies its listeners.

Specified by:

notifyAllListeners in interface ChangeGenerator<Object>

getListeners

public List getListeners()

Description copied from interface: ChangeGenerator

Get list directly. Support DI; like Spring IOC

Specified by:

getListeners in interface ChangeGenerator<Object>

setListeners

public void setListeners(List listeners)

Description copied from interface: ChangeGenerator

Set list directly. Support DI; like Spring IOC

Specified by:

setListeners in interface ChangeGenerator<Object>