Package org.silverpeas.web.test.stub

Class SessionManagementStub

java.lang.Object

org.silverpeas.web.test.stub.SessionManagementStub

All Implemented Interfaces:

SessionManagement

@Service
@Singleton
@Alternative
public class SessionManagementStub
extends Object
implements SessionManagement

Constructor Summary

Constructors

Constructor	Description
SessionManagementStub()

Method Summary

Modifier and Type	Method	Description
void	closeSession(String sessionId)	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(User user)	Gets the session information about all the connected users that are accessible to the specified user.
int	getNbConnectedUsersList(User user)	Gets the count of users that are connected to Silverpeas.
SessionInfo	getSessionInfo(String sessionId)	Gets information about the specified user session.
boolean	isUserConnected(User userDetail)	Is the specified user currently connected to Silverpeas?
SessionInfo	openAnonymousSession(javax.servlet.http.HttpServletRequest httpServletRequest)	Opens explicitly a new anonymous session.
SessionInfo	openOneShotSession(User 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	openSession(User 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(String sessionKey)	Calls SessionManagement.validateSession(SessionValidationContext) method by specifying to it a context that contains only the specified session key.
SessionInfo	validateSession(SessionValidationContext context)	Validates the session identified uniquely by the specified key.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionManagementStub

public SessionManagementStub()

Method Detail

getConnectedUsersList

public Collection<SessionInfo> getConnectedUsersList()

Description copied from interface: SessionManagement

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

Specified by:

getConnectedUsersList in interface SessionManagement

Returns:

Collection of session information.

getDistinctConnectedUsersList

public Collection<SessionInfo> getDistinctConnectedUsersList(User user)

Description copied from interface: SessionManagement

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 those in the same domain.

Specified by:

getDistinctConnectedUsersList in interface SessionManagement

Parameters:

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

Returns:

Collection of session information.

getNbConnectedUsersList

public int getNbConnectedUsersList(User user)

Description copied from interface: SessionManagement

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.

Specified by:

getNbConnectedUsersList in interface SessionManagement

Parameters:

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

Returns:

the count of connected users

getSessionInfo

@Nonnull
public SessionInfo getSessionInfo(String sessionId)

Description copied from interface: SessionManagement

Gets information about the specified user session.

Specified by:

getSessionInfo in interface SessionManagement

Parameters:

sessionId - the key of the user session.

Returns:

the information about the session mapped to the specified key.

isUserConnected

public boolean isUserConnected(User userDetail)

Description copied from interface: SessionManagement

Is the specified user currently connected to Silverpeas?

Specified by:

isUserConnected in interface SessionManagement

Parameters:

userDetail - the user for which the connection is checked.

Returns:

true if the user is connected, false otherwise.

validateSession

public SessionInfo validateSession(String sessionKey)

Description copied from interface: SessionManagement

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

Specified by:

validateSession in interface SessionManagement

Parameters:

sessionKey - the key of the user session.

Returns:

the result of SessionManagement.validateSession(SessionValidationContext) execution.

validateSession

public SessionInfo validateSession(SessionValidationContext context)

Description copied from interface: SessionManagement

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).

Specified by:

validateSession in interface SessionManagement

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

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

Description copied from interface: SessionManagement

Opens a new session for the specified user with the specified HTTP request at the origin of the session ask. The opened session is built upon an HTTP one, and it is managed directly by the underlying HTTP server/container. If the specified user is anonymous, then an IllegalArgumentException is thrown.

Specified by:

openSession in interface SessionManagement

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.

openOneShotSession

public SessionInfo openOneShotSession(User user,
                                      javax.servlet.http.HttpServletRequest request)

Description copied from interface: SessionManagement

Opens a new session for the specified user with the specified HTTP request at the origin of the session ask. The opened session is only for the given HTTP request and it will be closed once the request processing is done.

Specified by:

openOneShotSession in interface SessionManagement

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

public SessionInfo openAnonymousSession(javax.servlet.http.HttpServletRequest httpServletRequest)

Description copied from interface: SessionManagement

Opens explicitly a new anonymous session. The opened session is built upon an HTTP one managed directly by the underlying HTTP server/container. In Silverpeas, any anonymous access to it is done under the cover of a peculiar and specific user account, the anonymous user account. This requires the anonymous access to be enabled for Silverpeas and this is done by creating a specific account for the anonymous user (see the property anonymousId in the properties file org/silverpeas/lookAndFeel/generalLook.properties). So, any anonymous user are referred by a unique and same user account but have each of them a different and separate user session.

Specified by:

openAnonymousSession in interface SessionManagement

Returns:

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

closeSession

public void closeSession(String sessionId)

Description copied from interface: SessionManagement

Closes the specified user session.

Specified by:

closeSession in interface SessionManagement

Parameters:

sessionId - the key of the session to close.