com.ibm.websphere.servlet.session
Interface IBMApplicationSession
- public interface IBMApplicationSession
Method Summary
Modifier and Type | Method and Description |
---|---|
|
encodeURI(java.lang.Object URI)
Encodes the ID of this IBMApplicationSession into the specified SIP URI.
|
|
encodeURI(java.lang.String URI)
Encodes the ID of this IBMApplicationSession into the specified HTTP URI.
|
|
getAttribute(java.lang.String name)
Returns the object bound with the specified name in this session, or null if no object is bound under the name.
|
|
getAttributeNames()
Returns an Iterator over the String objects containing the names of all the objects bound to this session.
|
|
getCreationTime()
Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
|
|
getId()
Returns a string containing the unique identifier assigned to this session.
|
|
getLastAccessedTime()
Returns the last time an event occurred on this application session.
|
|
getSessions()
Returns an Iterator over all "protocol" sessions associated with this application session.
|
|
getSessions(java.lang.String protocol)
Returns an Iterator over the "protocol" session objects associated of the specified protocol
associated with this application session.
|
|
getTimers()
Returns all active timers associated with this application session.
|
|
invalidate()
Invalidates this application session.
|
|
removeAttribute(java.lang.String name)
Removes the object bound with the specified name from this session.
|
|
setAttribute(java.lang.String name,java.lang.Object attribute)
Binds an object to this session, using the name specified.
|
|
setExpires(int deltaMinutes)
Sets the time of expiry for this application session.
|
|
sync()
Forces replication of application session changes
|
Method Detail
encodeURI
- void encodeURI(java.lang.Object URI)
Encodes the ID of this IBMApplicationSession into the specified SIP URI.
Parameters:
URI
- object expected to be an instance of javax.servlet.sip.URI encodeURI
- java.lang.String encodeURI(java.lang.String URI)
Encodes the ID of this IBMApplicationSession into the specified HTTP URI.
Parameters:
URI
- string representation of the http uri Returns:
string with encoded application session id added
getAttribute
- java.lang.Object getAttribute(java.lang.String name)
Returns the object bound with the specified name in this session, or null if no object is bound under the name.
Parameters:
name
- name of the attribute to retrieve getAttributeNames
- java.util.Iterator getAttributeNames( )
Returns an Iterator over the String objects containing the names of all the objects bound to this session.
getCreationTime
- long getCreationTime()
Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
getId
- java.lang.String getId()
Returns a string containing the unique identifier assigned to this session.
getLastAccessedTime
- long getLastAccessedTime()
Returns the last time an event occurred on this application session.
getSessions
- java.util.Iterator getSessions( )
Returns an Iterator over all "protocol" sessions associated with this application session.
getSessions
- java.util.Iterator getSessions( java.lang.String protocol)
Returns an Iterator over the "protocol" session objects associated of the specified protocol
associated with this application session.
Parameters:
protocol
- string representation of protocol, either "SIP" or "HTTP" getTimers
- java.util.Collection getTimers( )
Returns all active timers associated with this application session.
invalidate
- void invalidate()
Invalidates this application session.
removeAttribute
- void removeAttribute(java.lang.String name)
Removes the object bound with the specified name from this session.
Parameters:
name
- name of the attribute to remove setAttribute
- void setAttribute(java.lang.String name,
- java.lang.Object attribute)
Binds an object to this session, using the name specified.
Parameters:
name
- name of the attribute to set attribute
- value of the attribute to set setExpires
- int setExpires(int deltaMinutes)
Sets the time of expiry for this application session.
Parameters:
deltaMinutes
- the number of minutes that the lifetime of this IBMApplicationSession is extended Returns:
actual number of minutes the lifetime of this session is extended, or 0 if it wasn't extended
sync
- void sync()
Forces replication of application session changes