com.ibm.xdms.function
Interface SipXcapDiffSubscriptions

All Superinterfaces:
Function

public interface SipXcapDiffSubscriptions
extends Function

SipXcapDiffSubscriptions is a helper function that stores the state of subscriptions for subscribers interested in being notified of document change (XCAP-DIFF). events.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 void addSubscription(javax.servlet.sip.SipSession subscriberSession)
          Adds the SipSession to the list of subscriptions to the document URI.
 java.util.Set<javax.servlet.sip.SipSession> getSubscriptions(java.lang.String documentUri)
          This method return a set of the subscription SipSessions that are subscribed to a specific document URI.
 void notifyAllSubscribers(XcapDiffInfo xcapDiffInfo)
          Notify all subscribers whenever a document changes.
 void removeAllSubscriptions(java.lang.String documentUri)
          Remove all subscriptions from the specified document.
 boolean removeExpiredSubscription(javax.servlet.sip.SipSession subscriberSession, boolean doNotify)
          This method removes the expired subscriber session.
 
Methods inherited from interface com.ibm.xdms.function.Function
getApplicationUsage, init
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
Method Detail

getSubscriptions

java.util.Set<javax.servlet.sip.SipSession> getSubscriptions(java.lang.String documentUri)
                                                             throws XdmsException
This method return a set of the subscription SipSessions that are subscribed to a specific document URI.

Parameters:
documentUri - The document URI to subscribe to
Throws:
XdmsException

addSubscription

void addSubscription(javax.servlet.sip.SipSession subscriberSession)
                     throws XdmsException
Adds the SipSession to the list of subscriptions to the document URI.

Parameters:
subscriberSession - The subscriber SipSession to add
Throws:
XdmsException

removeAllSubscriptions

void removeAllSubscriptions(java.lang.String documentUri)
                            throws XdmsException
Remove all subscriptions from the specified document. This is done when the document is deleted.

Parameters:
documentUri - The document URI to subscribe to
Throws:
XdmsException

removeExpiredSubscription

boolean removeExpiredSubscription(javax.servlet.sip.SipSession subscriberSession,
                                  boolean doNotify)
                                  throws XdmsException
This method removes the expired subscriber session.

Parameters:
subscriberSession - The SipSession of the subscription.
doNotify - Send notify to subscriber if session expired.
Throws:
XdmsException

notifyAllSubscribers

void notifyAllSubscribers(XcapDiffInfo xcapDiffInfo)
                          throws XdmsException
Notify all subscribers whenever a document changes.

Parameters:
xcapDiffInfo - The XcapDiff information for change notification
Throws:
XdmsException