Package com.ibm.websphere.servlet.session

Interface IBMApplicationSession

public interface IBMApplicationSession
The 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 Summary

    Modifier and Type
    Method
    Description
    void
    encodeURI(Object URI)
    Encodes the ID of this IBMApplicationSession into the specified SIP URI.
    String
    encodeURI(String URI)
    Encodes the ID of this IBMApplicationSession into the specified HTTP URI.
    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.
    Iterator
    getAttributeNames()
    Returns an Iterator over the 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 an event occurred on this application session.
    Iterator
    getSessions()
    Returns an Iterator over all "protocol" sessions associated with this application session.
    Iterator
    getSessions(String protocol)
    Returns an Iterator over the "protocol" session objects associated of the specified protocol associated with this application session.
    Collection
    getTimers()
    Returns all active timers associated with this application session.
    void
    invalidate()
    Invalidates this application session.
    void
    removeAttribute(String name)
    Removes the object bound with the specified name from this session.
    void
    setAttribute(String name, Object attribute)
    Binds an object to this session, using the name specified.
    int
    setExpires(int deltaMinutes)
    Sets the time of expiry for this application session.
    void
    sync()
    Forces replication of application session changes

  • Method Details

    • encodeURI

      void encodeURI(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

      String encodeURI(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

      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.
      Parameters:
      name - name of the attribute to retrieve

    • getAttributeNames

      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

      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

      Iterator getSessions()
      Returns an Iterator over all "protocol" sessions associated with this application session.

    • getSessions

      Iterator getSessions(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

      Collection getTimers()
      Returns all active timers associated with this application session.

    • invalidate

      void invalidate()
      Invalidates this application session.

    • removeAttribute

      void removeAttribute(String name)
      Removes the object bound with the specified name from this session.
      Parameters:
      name - name of the attribute to remove

    • setAttribute

      void setAttribute(String name, 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