de.alpharogroup.wicket.base.application

Class OnlineSessionUsers<USER,ID,SESSION>

java.lang.Object

de.alpharogroup.wicket.base.application.OnlineUsers<USER,ID>

de.alpharogroup.wicket.base.application.OnlineSessionUsers<USER,ID,SESSION>

Type Parameters:

USER - the generic type for the users object.

ID - the generic type for the id the references to the user object.

SESSION - the generic type for the session object.

All Implemented Interfaces:

Serializable

public class OnlineSessionUsers<USER,ID,SESSION>
extends OnlineUsers<USER,ID>

The Class OnlineSessionUsers holds the mapping between the users that are online and can be applied to get the functionality how many users are online. It saves also the session object.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OnlineSessionUsers()

Method Summary

Modifier and Type	Method and Description
ID	addOnline(USER user, ID sessionId, SESSION session) Adds the user online.
SESSION	get(USER user) Gets the session from the given user.
SESSION	getSession(ID sessionId) Gets the session from the given session id.
USER	remove(ID sessionId) Removes the user from the map with the session id.
ID	removeOnline(USER user) Removes the user from the map.
ID	replaceSessionId(USER user, ID oldSessionId, ID newSessionId, SESSION newSession) Replace the given old session id with the new one.

Methods inherited from class de.alpharogroup.wicket.base.application.OnlineUsers

addOnline, getSessionId, getSize, getUser, isOnline, replaceSessionId

Methods inherited from class java.lang.Object

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

Constructor Detail

OnlineSessionUsers

public OnlineSessionUsers()

Method Detail

addOnline

public ID addOnline(USER user,
                    ID sessionId,
                    SESSION session)

Adds the user online.

Parameters:

user - the user

sessionId - the session id

session - the session object

Returns:

the session id

get

public SESSION get(USER user)

Gets the session from the given user.

Parameters:

user - the user

Returns:

the session

getSession

public SESSION getSession(ID sessionId)

Gets the session from the given session id.

Parameters:

sessionId - the session id

Returns:

the session

remove

public USER remove(ID sessionId)

Removes the user from the map with the session id.

Overrides:

remove in class OnlineUsers<USER,ID>

Parameters:

sessionId - the session id

Returns:

the user

removeOnline

public ID removeOnline(USER user)

Removes the user from the map. This method shell be invoked when the session is unbounded from the Application. In wicket is the best way to do that in the WebApplication#sessionUnbound(String).

Overrides:

removeOnline in class OnlineUsers<USER,ID>

Parameters:

user - the user

Returns:

the session id

replaceSessionId

public ID replaceSessionId(USER user,
                           ID oldSessionId,
                           ID newSessionId,
                           SESSION newSession)

Replace the given old session id with the new one.

Parameters:

user - the user

oldSessionId - the old session id

newSessionId - the new session id

newSession - the new session object

Returns:

the new session id that is associated with the given user.