com.ibm.xdms.function
Interface SipSubscribeHelper

All Superinterfaces:
Function

public interface SipSubscribeHelper
extends Function

The SipSubscribeHelper provides methods to support processing a SIP SUBSCRIBE request


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 javax.servlet.sip.SipServletRequest createNotifyRequest(javax.servlet.sip.SipServletRequest req, javax.servlet.sip.SipServletResponse resp)
          Creates a Notify Request to the client.
 long getDocumentETag(javax.servlet.sip.SipServletRequest req, javax.servlet.sip.SipServletResponse resp, com.ibm.xcap.DocumentSelector docSelector)
          Retrieves the eTag for a document
 java.util.ArrayList<java.lang.String> getDocumentList(java.util.ArrayList<java.lang.String> docList, java.lang.String content, boolean validationRequired)
          Adds the entries in teh content to the docList
 EventHeader getEventHeader(javax.servlet.sip.SipServletRequest req, javax.servlet.sip.SipServletResponse resp)
          Retrieves the EventHeader object from the request.
 int getExpiresHeader(javax.servlet.sip.SipServletRequest req, javax.servlet.sip.SipServletResponse resp)
          Returns the expiration of the subscription in seconds
 java.net.URI getToURIHeader(javax.servlet.sip.SipServletRequest req, javax.servlet.sip.SipServletResponse resp)
          Retrieves the To header URI from the request.
 void notifyWait(javax.servlet.sip.SipServletRequest request, int waitTime)
          Waits for the remaining time from the response send to the waitTime
 void setResponseSendTimestamp(javax.servlet.sip.SipServletRequest request)
          Sets the Response Send time
 
Methods inherited from interface com.ibm.xdms.function.Function
getApplicationUsage, init
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
Method Detail

getEventHeader

EventHeader getEventHeader(javax.servlet.sip.SipServletRequest req,
                           javax.servlet.sip.SipServletResponse resp)
                           throws XdmsException
Retrieves the EventHeader object from the request.

Parameters:
req - The SipServletRequest
resp - The SipServletResponse
Returns:
Returns the EventHeader object from the request.
Throws:
XdmsException

getExpiresHeader

int getExpiresHeader(javax.servlet.sip.SipServletRequest req,
                     javax.servlet.sip.SipServletResponse resp)
                     throws XdmsException
Returns the expiration of the subscription in seconds

Parameters:
req - The SipServletRequest
resp - The SipServletResponse
Returns:
Returns the expiration of the subscription in seconds
Throws:
XdmsException

getDocumentETag

long getDocumentETag(javax.servlet.sip.SipServletRequest req,
                     javax.servlet.sip.SipServletResponse resp,
                     com.ibm.xcap.DocumentSelector docSelector)
                     throws XdmsException
Retrieves the eTag for a document

Parameters:
req - The SipServletRequest
resp - The SipServletResponse
docSelector - The document selector
Returns:
Returns the eTag for a document
Throws:
XdmsException

createNotifyRequest

javax.servlet.sip.SipServletRequest createNotifyRequest(javax.servlet.sip.SipServletRequest req,
                                                        javax.servlet.sip.SipServletResponse resp)
                                                        throws XdmsException
Creates a Notify Request to the client. The

Parameters:
req - The SipServletRequest
resp - The SipServletResponse
Returns:
Returns a new SipServletRequest which represents a SIP NOTIFY back to the client.
Throws:
XdmsException

getToURIHeader

java.net.URI getToURIHeader(javax.servlet.sip.SipServletRequest req,
                            javax.servlet.sip.SipServletResponse resp)
                            throws XdmsException
Retrieves the To header URI from the request.

Parameters:
req - The SipServletRequest
resp - The SipServletResponse
Returns:
Returns the To header URI from the request.
Throws:
XdmsException

getDocumentList

java.util.ArrayList<java.lang.String> getDocumentList(java.util.ArrayList<java.lang.String> docList,
                                                      java.lang.String content,
                                                      boolean validationRequired)
Adds the entries in teh content to the docList

Parameters:
docList -
content -
Returns:

setResponseSendTimestamp

void setResponseSendTimestamp(javax.servlet.sip.SipServletRequest request)
Sets the Response Send time

Parameters:
request -

notifyWait

void notifyWait(javax.servlet.sip.SipServletRequest request,
                int waitTime)
Waits for the remaining time from the response send to the waitTime

Parameters:
request -
waitTime -