de.alpharogroup.wicket.base.application

Class OnlineUsers<USER,ID>

java.lang.Object

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

Type Parameters:

USER - the generic type for the users object.

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

OnlineSessionUsers

public class OnlineUsers<USER,ID>
extends Object
implements Serializable

The Class OnlineUsers holds the mapping between the users that are online and can be applied to get the functionality how many users are online.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OnlineUsers()

Method Summary

Modifier and Type	Method and Description
ID	addOnline(USER user, ID sessionId) Adds the user online.
ID	getSessionId(USER user) Gets the session id.
int	getSize() Gets the size of the online users.
USER	getUser(ID sessionId) Gets the user over the sessionId.
boolean	isOnline(USER user) Checks if the given user is online.
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) Replace the given old session id with the new one.

Methods inherited from class java.lang.Object

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

Constructor Detail

OnlineUsers

public OnlineUsers()

Method Detail

addOnline

public ID addOnline(USER user,
                    ID sessionId)

Adds the user online.

Parameters:

user - the user

sessionId - the session id

Returns:

the string

getSessionId

public ID getSessionId(USER user)

Gets the session id.

Parameters:

user - the user

Returns:

the session id

getSize

public int getSize()

Gets the size of the online users.

Returns:

how many users are at this moment online.

getUser

public USER getUser(ID sessionId)

Gets the user over the sessionId.

Parameters:

sessionId - the session id

Returns:

the user

isOnline

public boolean isOnline(USER user)

Checks if the given user is online.

Parameters:

user - the user

Returns:

true, if the user is online

remove

public USER remove(ID sessionId)

Removes the user from the map with the session 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).

Parameters:

user - the user

Returns:

the session id

replaceSessionId

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

Replace the given old session id with the new one.

Parameters:

user - the user

oldSessionId - the old session id

newSessionId - the new session id

Returns:

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