de.alpharogroup.wicket.application

Class AbstractWicketSession<USERID>

java.lang.Object

org.apache.wicket.Session

org.apache.wicket.protocol.http.WebSession

de.alpharogroup.wicket.application.AbstractWicketSession<USERID>

Type Parameters:

USERID - the generic type for the user id.

All Implemented Interfaces:

Serializable, org.apache.wicket.event.IEventSink, org.apache.wicket.util.io.IClusterable

public abstract class AbstractWicketSession<USERID>
extends org.apache.wicket.protocol.http.WebSession

The Class WicketSession is the session object for this application.

Author:

Asterios Raptis

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected USERID	userId The user id.

Fields inherited from class org.apache.wicket.Session

clientInfo, SESSION_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractWicketSession(org.apache.wicket.request.Request request) Instantiates a new WicketSession.

Method Summary

Modifier and Type	Method and Description
static AbstractWicketSession	get() Gets the WicketSession for this application.
List<de.alpharogroup.user.entities.Roles>	getRoles() Gets the roles.
abstract de.alpharogroup.user.entities.Users	getUser() Gets the user.
Serializable	getUserAttribute(String key) Gets the user attribute.
USERID	getUserId() Gets the user id.
void	invalidate()
void	invalidateNow()
boolean	isGuest() Checks if the user is a guest.
boolean	isInRole(de.alpharogroup.user.entities.Roles role) Checks if the user is in the given Roles object.
boolean	isInRole(String rolename) Checks if the user is in the role lookup is made over the role name.
boolean	isSignedIn() Checks if is user signed in.
void	onSignOut() Hook method that can be used when a user signs out from the application.
Serializable	removeUserAttribute(String key) Removes the user attribute.
void	setRoles(List<de.alpharogroup.user.entities.Roles> roles) Sets the roles.
abstract void	setUser(de.alpharogroup.user.entities.Users user) Sets the user.
void	setUserAttribute(String key, Serializable value) Sets the user attribute.
void	setUserId(USERID userId) Sets the user id.

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

getClientInfo, newBrowserInfoPage

Methods inherited from class org.apache.wicket.Session

bind, clear, debug, detach, dirty, dirty, error, exists, fatal, getApplication, getAttribute, getAttributeNames, getAuthorizationStrategy, getClassResolver, getFeedbackMessages, getId, getLocale, getMetaData, getPageFactory, getPageManager, getSessionStore, getSizeInBytes, getStyle, info, internalDetach, isSessionInvalidated, isTemporary, newPageAccessSynchronizer, nextPageId, nextSequenceValue, onEvent, onInvalidate, removeAttribute, replaceSession, setAttribute, setClientInfo, setLocale, setMetaData, setStyle, success, warn

Methods inherited from class java.lang.Object

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

Field Detail

userId

protected USERID userId

The user id.

Constructor Detail

AbstractWicketSession

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

Instantiates a new WicketSession.

Parameters:

request - The current request

Method Detail

get

public static AbstractWicketSession get()

Gets the WicketSession for this application.

Returns:

the current WicketSession object.

getRoles

public List<de.alpharogroup.user.entities.Roles> getRoles()

Gets the roles.

Returns:

the roles

getUser

public abstract de.alpharogroup.user.entities.Users getUser()

Gets the user.

Returns:

the user

getUserAttribute

public Serializable getUserAttribute(String key)

Gets the user attribute.

Parameters:

key - the key

Returns:

the user attribute

getUserId

public USERID getUserId()

Gets the user id.

Returns:

the user id

invalidate

public void invalidate()

Overrides:

invalidate in class org.apache.wicket.protocol.http.WebSession

invalidateNow

public void invalidateNow()

Overrides:

invalidateNow in class org.apache.wicket.Session

isGuest

public boolean isGuest()

Checks if the user is a guest.

Returns:

true, the user is a guest.

isInRole

public boolean isInRole(de.alpharogroup.user.entities.Roles role)

Checks if the user is in the given Roles object.

Parameters:

role - the role

Returns:

true, if successful

isInRole

public boolean isInRole(String rolename)

Checks if the user is in the role lookup is made over the role name.

Parameters:

rolename - the role name

Returns:

true, if successful

isSignedIn

public boolean isSignedIn()

Checks if is user signed in.

Returns:

true, if is user signed in

onSignOut

public void onSignOut()

Hook method that can be used when a user signs out from the application.

removeUserAttribute

public Serializable removeUserAttribute(String key)

Removes the user attribute.

Parameters:

key - the key

Returns:

the user attribute

setRoles

public void setRoles(List<de.alpharogroup.user.entities.Roles> roles)

Sets the roles.

Parameters:

roles - the new roles

setUser

public abstract void setUser(de.alpharogroup.user.entities.Users user)

Sets the user.

Parameters:

user - the user

setUserAttribute

public void setUserAttribute(String key,
                             Serializable value)

Sets the user attribute.

Parameters:

key - the key

value - the value

setUserId

public void setUserId(USERID userId)

Sets the user id.

Parameters:

userId - the new user id