| org.sakaiproject.tool.api.SessionManager
All known Subclasses: org.sakaiproject.tool.impl.SessionComponent,
| SessionManager | | public interface SessionManager (Code) | |
SessionManager keeps track of Sakai-wide and Tool placement specific user sessions, modeled on the HttpSession of the Servlet API.
|
| Field Summary | |
| final static String | CURRENT_INVALID_SESSION
Key in the ThreadLocalManager for the case where a session requested was invalid, and we started a new one. |
| CURRENT_INVALID_SESSION | | final static String CURRENT_INVALID_SESSION(Code) | | Key in the ThreadLocalManager for the case where a session requested was invalid, and we started a new one.
|
| getActiveUserCount | | int getActiveUserCount(int secs)(Code) | | Count the number of users with sessions recently active (within the given number of seconds)
Parameters:
secs - Elapsed time within which sessions have been active |
| getCurrentSession | | Session getCurrentSession()(Code) | | Access the session associated with the current request or processing thread.
The session associatd with the current request or processing thread. |
| getCurrentSessionUserId | | String getCurrentSessionUserId()(Code) | | Access the current session's user id, or return null if there is no current session.
The current session's user id, or null if there is no current session or it has no user id. |
| getCurrentToolSession | | ToolSession getCurrentToolSession()(Code) | | Access the tool session associated with the current request or processing thread.
The tool session associatd with the current request or processing thread. |
| getSession | | Session getSession(String sessionId)(Code) | | Access the known session with this id.
The Session object that has this id, or null if the id is not known. |
| setCurrentSession | | void setCurrentSession(Session s)(Code) | | Set this session as the current one for this request processing or thread.
Parameters:
s - The session to set as the current session. |
| setCurrentToolSession | | void setCurrentToolSession(ToolSession s)(Code) | | Set this session as the current tool session for this request processing or thread.
Parameters:
s - The session to set as the current tool session. |
| startSession | | Session startSession()(Code) | | Start a new session.
The new UsageSession. |
| startSession | | Session startSession(String id)(Code) | | Start a new session, using this session id.
Parameters:
id - The session Id to use. The new UsageSession. |
|
|