com.silverpeas.session
Interface SessionManagement

All Known Implementing Classes:

SessionManager, SessionManagerMock

public interface SessionManagement

It defines the contract the session management implementation in Silverpeas should implement. It should have only one activated implementation in Sivlerpeas and it should be managed by an IoC container under the name 'sessionManager'.

Method Summary

void	closeSession(String sessionKey) Closes the specified user session.
Collection<SessionInfo>	getConnectedUsersList() Gets the session information about all the connected users in the Silverpeas platform, whatever their domain and the applied domain isolation policy.
Collection<SessionInfo>	getDistinctConnectedUsersList(UserDetail user) Gets the session information about all the connected users that are accessible to the specified user.
int	getNbConnectedUsersList(UserDetail user) Gets the count of users that are connected to Silverpeas.
long	getNextSessionTimeOut(String sessionKey) Gets the next timeout of the specified user session.
SessionInfo	getSessionInfo(String sessionKey) Gets information about the specified user session.
boolean	isUserConnected(UserDetail user) Is the specified user currently connected to Silverpeas?
SessionInfo	openAnonymousSession(javax.servlet.http.HttpServletRequest request) Opens a new anonymous session with the specified HTTP request at the origin of the session ask.
SessionInfo	openSession(UserDetail user) Opens a new session for the specified user.
SessionInfo	openSession(UserDetail user, javax.servlet.http.HttpServletRequest request) Opens a new session for the specified user with the specified HTTP request at the origin of the session ask.
SessionInfo	validateSession(SessionValidationContext context) Validates the session identified uniquely by the specified key.
SessionInfo	validateSession(String sessionKey) Calls validateSession(SessionValidationContext) method by specifying to it a context that contains only the specified session key.

Method Detail

getConnectedUsersList

Collection<SessionInfo> getConnectedUsersList()

Gets the session information about all the connected users in the Silverpeas platform, whatever their domain and the applied domain isolation policy.

Returns:

Collection of session information.

getDistinctConnectedUsersList

Collection<SessionInfo> getDistinctConnectedUsersList(UserDetail user)

Gets the session information about all the connected users that are accessible to the specified user. According to the domain level isolation, a user can see either all the others connected users or only thoses in the same domain.

Parameters:

user - a user from whom all the distinct connected users are visible.

Returns:

Collection of session information.

getNbConnectedUsersList

int getNbConnectedUsersList(UserDetail user)

Gets the count of users that are connected to Silverpeas. The domain level isolation applied to the running Silverpeas is taken into account in the computation of the connected user count: either all the connected users are taken into account or only those in the same domain.

Parameters:

user - the user from whom all the users to count are visible.

Returns:

the count of connected users

getSessionInfo

SessionInfo getSessionInfo(String sessionKey)

Gets information about the specified user session.

Parameters:

sessionKey - the key of the user session.

Returns:

the information about the session mapped to the specified key.

isUserConnected

boolean isUserConnected(UserDetail user)

Is the specified user currently connected to Silverpeas?

Parameters:

user - the user for which the connection is checked.

Returns:

true if the user is connected, false otherwise.

getNextSessionTimeOut

long getNextSessionTimeOut(String sessionKey)

Gets the next timeout of the specified user session.

Parameters:

sessionKey - the keu of the user session.

Returns:

the next session timout in milliseconds.

validateSession

SessionInfo validateSession(String sessionKey)

Calls validateSession(SessionValidationContext) method by specifying to it a context that contains only the specified session key.

Parameters:

sessionKey - the key of the user session.

Returns:

the result of validateSession(SessionValidationContext) execution.

validateSession

SessionInfo validateSession(SessionValidationContext context)

Validates the session identified uniquely by the specified key. The validation checks a session exists with the specified identifier and returns information about this session. At each access by the user to Silverpeas, its current session must be validated. The validation updates also useful information about the session like the timestamp of this access so that additional features can be performed (for example, the timeout computation of the session).

Parameters:

context - the context of the validation that contains at least the session key

Returns:

information about the session identified by the specified key or null if no such session exists.

openSession

SessionInfo openSession(UserDetail user)

Opens a new session for the specified user. This method is dedicated to open session off any WEB browsing context with HTTP servlets.

Parameters:

user - the user for which a session with Silverpeas has to be opened.

Returns:

a SessionInfo instance representing the current opened session with information about that session.

openSession

SessionInfo openSession(UserDetail user,
                        javax.servlet.http.HttpServletRequest request)

Opens a new session for the specified user with the specified HTTP request at the origin of the session ask. The opened session is an HTTP one and it is managed directly by the underlying HTTP server/container. This method is for session in which HTTP servlets are used as entry-point in the WEB communication with Silverpeas.

Parameters:

user - the user for which an HTTP session with Silverpeas has to be opened.

request - the HTTP request at the origin of the session opening ask.

Returns:

a SessionInfo instance representing the current opened session with information about that session.

openAnonymousSession

SessionInfo openAnonymousSession(javax.servlet.http.HttpServletRequest request)

Opens a new anonymous session with the specified HTTP request at the origin of the session ask. The opened session is an HTTP one and it is managed directly by the underlying HTTP server/container. This method is for anonymous session in which HTTP servlets are used as entry-point in the WEB communication with Silverpeas.

Parameters:

request - the HTTP request at the origin of the session opening ask.

Returns:

a SessionInfo instance representing the current opened anonymous session with information about that session.

closeSession

void closeSession(String sessionKey)

Closes the specified user session.

Parameters:

sessionKey - the key of the session to close.