com.neurosys.site.wicket.components.session

Class BasicSession<U extends User,S extends WebUserShell<U,org.apache.wicket.protocol.http.WebSession>>

java.lang.Object

org.apache.wicket.Session

org.apache.wicket.protocol.http.WebSession

com.neurosys.site.wicket.components.session.BasicSession<U,S>

All Implemented Interfaces:

IBasicSession<U,S>, Serializable, org.apache.wicket.IClusterable

Direct Known Subclasses:

AdminSession, ContextualSession

public class BasicSession<U extends User,S extends WebUserShell<U,org.apache.wicket.protocol.http.WebSession>>
extends org.apache.wicket.protocol.http.WebSession
implements IBasicSession<U,S>

Represents a session object

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

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

org.apache.wicket.Session.IPageMapVisitor, org.apache.wicket.Session.PageMapAccessMetaData

Field Summary

Fields

Modifier and Type	Field and Description
protected S	shell

Fields inherited from class org.apache.wicket.Session

PAGEMAP_ACCESS_MDK, SESSION_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor and Description
BasicSession(org.apache.wicket.Request request)

Method Summary

Modifier and Type	Method and Description
protected String	deriveUserId() Override to derive custom User field for id.
void	extendShell(BasicSession environment) Extend the current Shell, with a new child shell.
static BasicSession	get() Use Java 5 covariance
AuthenticationToken	getAuthToken()
S	getShell() Some sessions may want to discourage access to the shell itself As a best practice avoid working with the shell directly, and create methods that internally call the shell from your session.
U	getUser()
String	getUserId() Get the userId for the Session.
void	setAuthToken(AuthenticationToken authToken)
void	setUser(U user)

Methods inherited from class org.apache.wicket.protocol.http.WebSession

cleanupComponentFeedbackMessages, cleanupFeedbackMessages, isCurrentRequestValid

Methods inherited from class org.apache.wicket.Session

attach, bind, clear, createAutoPageMap, createAutoPageMapName, currentCreateAutoPageMapCounter, detach, dirty, error, exists, findOrCreate, findOrCreate, getApplication, getAttribute, getAttributeNames, getAuthorizationStrategy, getAutoPageMapNamePrefix, getAutoPageMapNameSuffix, getClassResolver, getClientInfo, getDefaultPageMap, getFeedbackMessages, getId, getLocale, getMetaData, getPage, getPage, getPageFactory, getPageMaps, getSessionStore, getSizeInBytes, getStyle, incrementCreateAutoPageMapCounter, info, invalidate, invalidateNow, isSessionInvalidated, isTemporary, newPageMap, nextPageId, nextSequenceValue, pageMapForName, removeAttribute, removePageMap, replaceSession, set, setApplication, setAttribute, setClientInfo, setLocale, setMetaData, setStyle, touch, unset, untouch, update, visitPageMaps, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

shell

protected S extends WebUserShell<U,org.apache.wicket.protocol.http.WebSession> shell

Constructor Detail

BasicSession

public BasicSession(org.apache.wicket.Request request)

Method Detail

get

public static BasicSession get()

Use Java 5 covariance

Returns:

getAuthToken

public AuthenticationToken getAuthToken()

Specified by:

getAuthToken in interface IBasicSession<U extends User,S extends WebUserShell<U,org.apache.wicket.protocol.http.WebSession>>

setAuthToken

public void setAuthToken(AuthenticationToken authToken)

Specified by:

setAuthToken in interface IBasicSession<U extends User,S extends WebUserShell<U,org.apache.wicket.protocol.http.WebSession>>

getUser

public U getUser()

Specified by:

getUser in interface IBasicSession<U extends User,S extends WebUserShell<U,org.apache.wicket.protocol.http.WebSession>>

setUser

public void setUser(U user)

Specified by:

setUser in interface IBasicSession<U extends User,S extends WebUserShell<U,org.apache.wicket.protocol.http.WebSession>>

deriveUserId

protected String deriveUserId()

Override to derive custom User field for id. The user object is guaranteed to be not null by getUserId()

Returns:

String as id

getUserId

public String getUserId()

Get the userId for the Session. A BasicSession type can use any user object or attribute to represent that as the id for the session. This could be the same as HttpSession.getId() or something custom like email, name etc.

Even though getUser() exists and this maybe derived from it, getUser() does not guarantee any convention on which attribute identifies the id we want for a session.

Specified by:

getUserId in interface IBasicSession<U extends User,S extends WebUserShell<U,org.apache.wicket.protocol.http.WebSession>>

Returns:

String identifying the user of the session

See Also:

deriveUserId()

Default value:

By default it returns #getUser()#getId() and if not user defined then gets the sessionId TODO: Add unit test case for user null, user not null but id null etc.

extendShell

public void extendShell(BasicSession environment)

Extend the current Shell, with a new child shell.

Parameters:

environment - @nullable true; if null will assume current BasicSession

getShell

public S getShell()
           throws AuthorizationException

Some sessions may want to discourage access to the shell itself
As a best practice avoid working with the shell directly, and create methods that internally call the shell from your session. (Composition)

Specified by:

getShell in interface IBasicSession<U extends User,S extends WebUserShell<U,org.apache.wicket.protocol.http.WebSession>>

Returns:

Throws:

AuthorizationException