| org.sakaiproject.tool.api.Session
| Session | | public interface Session (Code) | |
Session models an end user's Sakai-wide usage session, modeled on the HttpSession of the Servlet API.
|
| Method Summary | |
| void | clear()
Clear this session's attributes, unbinding any objects bound, but do NOT fully invalidate - it remains the current session. | | void | clearExcept(Collection names)
Clear this session's attributes, except for those named, unbinding any objects bound, but do NOT fully invalidate - it remains the current session. | | Object | getAttribute(String name)
Returns the object bound with the specified name in this session, or null if no object is bound under the name. | | Enumeration | getAttributeNames()
Returns an Enumeration of String objects containing the names of all the objects bound to this session. | | ContextSession | getContextSession(String contextId)
Find or create a context session for this context id
Parameters:
contextId - The id used to identify the session. | | long | getCreationTime()
Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT. | | String | getId()
Returns a string containing the unique identifier assigned to this session. | | long | getLastAccessedTime()
Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT. | | int | getMaxInactiveInterval()
Returns the maximum time interval, in seconds, that Sakai will keep this session open between client accesses. | | ToolSession | getToolSession(String placementId)
Find or create a tool session for this tool placement id
Parameters:
placementId - The id used to identify the session. | | String | getUserEid()
Return the enterprise id of the user associated with this session. | | String | getUserId()
Return the authenticated user id associated with this session. | | void | invalidate()
Invalidates this session then unbinds any objects bound to it. | | void | removeAttribute(String name)
Removes the object bound with the specified name from this session. | | void | setActive()
Mark the session as still active, delaying timeout by another period. | | void | setAttribute(String name, Object value)
Binds an object to this session, using the name specified. | | void | setMaxInactiveInterval(int interval)
Specifies the time, in seconds, between client requests before the Sakai will invalidate this session. | | void | setUserEid(String eid)
Set the enterprise id of the user associated with this session. | | void | setUserId(String uid)
Set the user id associated with this session. |
| clear | | void clear()(Code) | | Clear this session's attributes, unbinding any objects bound, but do NOT fully invalidate - it remains the current session.
|
| clearExcept | | void clearExcept(Collection names)(Code) | | Clear this session's attributes, except for those named, unbinding any objects bound, but do NOT fully invalidate - it remains the current session.
|
| getAttribute | | Object getAttribute(String name)(Code) | | Returns the object bound with the specified name in this session, or null if no object is bound under the name.
Parameters:
name - a string specifying the name of the object the object with the specified name
exception:
IllegalStateException - if this method is called on an invalidated session |
| getAttributeNames | | Enumeration getAttributeNames()(Code) | | Returns an Enumeration of String objects containing the names of all the objects bound to this session.
an Enumeration of String objects specifying the names of all the objects bound to this session
exception:
IllegalStateException - if this method is called on an invalidated session |
| getContextSession | | ContextSession getContextSession(String contextId)(Code) | | Find or create a context session for this context id
Parameters:
contextId - The id used to identify the session. The ContextSession to use for this context id. |
| getCreationTime | | long getCreationTime()(Code) | | Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
a long specifying when this session was created, expressed in milliseconds since 1/1/1970 GMT
exception:
IllegalStateException - if this method is called on an invalidated session |
| getId | | String getId()(Code) | | Returns a string containing the unique identifier assigned to this session.
a string specifying the identifier assigned to this session
exception:
IllegalStateException - if this method is called on an invalidated session |
| getLastAccessedTime | | long getLastAccessedTime()(Code) | | Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT.
Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.
a long representing the last time the client sent a request associated with this session, expressed in milliseconds since 1/1/1970 GMT
exception:
IllegalStateException - if this method is called on an invalidated session |
| getMaxInactiveInterval | | int getMaxInactiveInterval()(Code) | | Returns the maximum time interval, in seconds, that Sakai will keep this session open between client accesses. After this interval, Sakai will invalidate the session. The maximum time interval can be set with the setMaxInactiveInterval
method. A negative time indicates the session should never timeout.
an integer specifying the number of seconds this session remains open between client requests
See Also: Session.setMaxInactiveInterval |
| getToolSession | | ToolSession getToolSession(String placementId)(Code) | | Find or create a tool session for this tool placement id
Parameters:
placementId - The id used to identify the session. The ToolSession to use for this tool placement id. |
| getUserEid | | String getUserEid()(Code) | | Return the enterprise id of the user associated with this session.
The enterprise id of the user associated with this session. |
| getUserId | | String getUserId()(Code) | | Return the authenticated user id associated with this session.
The authenticated user id associated with this session. |
| invalidate | | void invalidate()(Code) | | Invalidates this session then unbinds any objects bound to it.
|
| removeAttribute | | void removeAttribute(String name)(Code) | | Removes the object bound with the specified name from this session. If the session does not have an object bound with the specified name, this method does nothing.
After this method executes, and if the object implements SessionBindingListener, Sakai calls SessionBindingListener.valueUnbound.
Parameters:
name - the name of the object to remove from this session
exception:
IllegalStateException - if this method is called on an invalidated session |
| setActive | | void setActive()(Code) | | Mark the session as still active, delaying timeout by another period.
|
| setAttribute | | void setAttribute(String name, Object value)(Code) | | Binds an object to this session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.
After this method executes, and if the new object implements SessionBindingListener, Sakai calls SessionBindingListener.valueBound.
If an object was already bound to this session of this name that implements SessionBindingListener, its SessionBindingListener.valueUnbound method is called.
If the value passed in is null, this has the same effect as calling removeAttribute().
Parameters:
name - the name to which the object is bound;cannot be null
Parameters:
value - the object to be bound
exception:
IllegalStateException - if this method is called on aninvalidated session |
| setMaxInactiveInterval | | void setMaxInactiveInterval(int interval)(Code) | | Specifies the time, in seconds, between client requests before the Sakai will invalidate this session. A negative time indicates the session should never timeout.
Parameters:
interval - An integer specifying the number of seconds |
| setUserEid | | void setUserEid(String eid)(Code) | | Set the enterprise id of the user associated with this session.
The enterprise id of the user associated with this session. |
| setUserId | | void setUserId(String uid)(Code) | | Set the user id associated with this session.
Parameters:
uid - The user id associated with this session. |
|
|