| org.sakaiproject.tool.api.ToolSession
| ToolSession | | public interface ToolSession (Code) | |
ToolSession models an end user's Tool placement specific usage session.
author:
University of Michigan, Sakai Software Development Team
version:
$Revision: 7523 $ |
| Method Summary | |
| void | clearAttributes()
Remove and unbind all attributes in the 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. | | 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 tool session, as the number of milliseconds since midnight January 1, 1970 GMT. | | String | getPlacementId()
Returns a string containing the tool placement identifier for this 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 | removeAttribute(String name)
Removes the object bound with the specified name from this session. | | void | setAttribute(String name, Object value)
Binds an object to this session, using the name specified. |
| clearAttributes | | void clearAttributes()(Code) | | Remove and unbind all attributes in the session.
exception:
IllegalStateException - if this method is called on an already invalidated 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 |
| 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 tool 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 |
| getPlacementId | | String getPlacementId()(Code) | | Returns a string containing the tool placement identifier for this session.
a string specifying the tool placement identifier for this session.
exception:
IllegalStateException - if this method is called on an invalidated session |
| 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. |
| 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 |
| 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 |
|
|