Interface IBMApplicationSession
- 
 public interface IBMApplicationSessionThe IBMApplicationSession interface is used for SIP/HTTP Converged Applications as well as for sharing session data in http applications. HTTP Servlets can call session.getIBMApplicationSession, whereas SIP Servlets call session.getApplicationSession. In a converged application, both of these calls will return the same SipApplicationSession object.
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description voidencodeURI(java.lang.Object URI)Encodes the ID of this IBMApplicationSession into the specified SIP URI.java.lang.StringencodeURI(java.lang.String URI)Encodes the ID of this IBMApplicationSession into the specified HTTP URI.java.lang.ObjectgetAttribute(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.java.util.IteratorgetAttributeNames()Returns an Iterator over the String objects containing the names of all the objects bound to this session.longgetCreationTime()Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.java.lang.StringgetId()Returns a string containing the unique identifier assigned to this session.longgetLastAccessedTime()Returns the last time an event occurred on this application session.java.util.IteratorgetSessions()Returns an Iterator over all "protocol" sessions associated with this application session.java.util.IteratorgetSessions(java.lang.String protocol)Returns an Iterator over the "protocol" session objects associated of the specified protocol associated with this application session.java.util.CollectiongetTimers()Returns all active timers associated with this application session.voidinvalidate()Invalidates this application session.voidremoveAttribute(java.lang.String name)Removes the object bound with the specified name from this session.voidsetAttribute(java.lang.String name, java.lang.Object attribute)Binds an object to this session, using the name specified.intsetExpires(int deltaMinutes)Sets the time of expiry for this application session.voidsync()Forces replication of application session changes
 
- 
- 
- 
Method Detail- 
encodeURIvoid 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
 
 - 
encodeURIjava.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
 
 - 
getAttributejava.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
 
 - 
getAttributeNamesjava.util.Iterator getAttributeNames() Returns an Iterator over the String objects containing the names of all the objects bound to this session.
 - 
getCreationTimelong getCreationTime() Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
 - 
getIdjava.lang.String getId() Returns a string containing the unique identifier assigned to this session.
 - 
getLastAccessedTimelong getLastAccessedTime() Returns the last time an event occurred on this application session.
 - 
getSessionsjava.util.Iterator getSessions() Returns an Iterator over all "protocol" sessions associated with this application session.
 - 
getSessionsjava.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"
 
 - 
getTimersjava.util.Collection getTimers() Returns all active timers associated with this application session.
 - 
invalidatevoid invalidate() Invalidates this application session.
 - 
removeAttributevoid removeAttribute(java.lang.String name) Removes the object bound with the specified name from this session.- Parameters:
- name- name of the attribute to remove
 
 - 
setAttributevoid 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
 
 - 
setExpiresint 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
 
 - 
syncvoid sync() Forces replication of application session changes
 
- 
 
-