|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SipXcapDiffSubscriptions
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 |
---|
static final java.lang.String COPYRIGHT
Method Detail |
---|
java.util.Set<javax.servlet.sip.SipSession> getSubscriptions(java.lang.String documentUri) throws XdmsException
documentUri
- The document URI to subscribe to
XdmsException
void addSubscription(javax.servlet.sip.SipSession subscriberSession) throws XdmsException
subscriberSession
- The subscriber SipSession to add
XdmsException
void removeAllSubscriptions(java.lang.String documentUri) throws XdmsException
documentUri
- The document URI to subscribe to
XdmsException
boolean removeExpiredSubscription(javax.servlet.sip.SipSession subscriberSession, boolean doNotify) throws XdmsException
subscriberSession
- The SipSession of the subscription.doNotify
- Send notify to subscriber if session expired.
XdmsException
void notifyAllSubscribers(XcapDiffInfo xcapDiffInfo) throws XdmsException
xcapDiffInfo
- The XcapDiff information for change notification
XdmsException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |