org.apache.turbine.services.session
Interface SessionService

All Superinterfaces:

Initable, Service

All Known Implementing Classes:

TurbineSessionService

public interface SessionService

extends Service

The SessionService allows access to the current sessions of the current context. The session objects that are cached by this service are obtained through a listener. The listener must be configured in your web.xml file.

Since:

2.3

Version:

$Id: SessionService.java 534527 2007-05-02 16:10:59Z tv $

Author:

Quinton McCombs

See Also:

SessionListener

Field Summary

static java.lang.String

SERVICE_NAME The key under which this service is stored in TurbineServices.

Method Summary

void	addSession(javax.servlet.http.HttpSession session) Adds a session to the current list.
java.util.Collection	getActiveSessions() Gets all active sessions
java.util.Collection	getActiveUsers() Gets a collection of all user objects representing the users currently logged in.
javax.servlet.http.HttpSession	getSession(java.lang.String sessionId) Gets the HttpSession by the session identifier
java.util.Collection	getSessionsForUser(User user) Get a collection of all session on which the given user is logged in.
User	getUserFromSession(javax.servlet.http.HttpSession session) Gets the User object of the the specified HttpSession.
boolean	isUserLoggedIn(User user) Determines if a given user is currently logged in.
void	removeSession(javax.servlet.http.HttpSession session) Removes a session from the current list.

Methods inherited from interface org.apache.turbine.services.Service

getConfiguration, getName, getProperties, setName, setServiceBroker

Methods inherited from interface org.apache.turbine.services.Initable

getInit, init, init, setInitableBroker, shutdown

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

The key under which this service is stored in TurbineServices.

See Also:

Constant Field Values

Method Detail

getActiveSessions

public java.util.Collection getActiveSessions()

Gets all active sessions

Returns:

Collection of HttpSession objects

addSession

public void addSession(javax.servlet.http.HttpSession session)

Adds a session to the current list. This method should only be called by the listener.

Parameters:

session - Session to add

removeSession

public void removeSession(javax.servlet.http.HttpSession session)

Removes a session from the current list. This method should only be called by the listener.

Parameters:

session - Session to remove

isUserLoggedIn

public boolean isUserLoggedIn(User user)

Determines if a given user is currently logged in. The actual implementation of the User object must implement the equals() method. By default, Torque based objects (liek TurbineUser) have an implementation of equals() that will compare the result of getPrimaryKey().

Parameters:

user - User to check for

Returns:

true if the user is logged in on one of the active sessions.

getActiveUsers

public java.util.Collection getActiveUsers()

Gets a collection of all user objects representing the users currently logged in. This will exclude any instances of anonymous user that Turbine will use before the user actually logs on.

Returns:

collection of org.apache.turbine.om.security.User objects

getUserFromSession

public User getUserFromSession(javax.servlet.http.HttpSession session)

Gets the User object of the the specified HttpSession.

Parameters:

session - The session from which to extract a user.

Returns:

The Turbine User object.

getSession

public javax.servlet.http.HttpSession getSession(java.lang.String sessionId)

Gets the HttpSession by the session identifier

Parameters:

sessionId - The unique session identifier.

Returns:

The session keyed by the specified identifier.

getSessionsForUser

public java.util.Collection getSessionsForUser(User user)

Get a collection of all session on which the given user is logged in.

Parameters:

user - the user

Returns:

Collection of HtttSession objects