com.ibm.xdms.sip
Interface SipFilterChain


public interface SipFilterChain

A SipFilterChain is an object gives a view into the invocation chain of a filtered request for a resource. SipFilters use the SipFilterChain to invoke the next filter in the chain, or if the calling filter is the last filter in the chain, to invoke the resource at the end of the chain.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 void doErrorResponse(javax.servlet.sip.SipServletResponse response, SipFilterChain chain)
          Causes the next filter in the chain to be invoked on an error response to a SIP NOTIFY request, or if the calling filter is the last filter in the chain, the last filter is invoked and processing is returned back through the filter chain.
 void doSubscribe(javax.servlet.sip.SipServletRequest request, javax.servlet.sip.SipServletResponse response, SipFilterChain chain)
          Causes the next filter in the chain to be invoked on a SIP SUBSCRIBE request, or if the calling filter is the last filter in the chain, the last filter is invoked and processing is returned back through the filter chain.
 void doSuccessResponse(javax.servlet.sip.SipServletResponse response, SipFilterChain chain)
          Causes the next filter in the chain to be invoked on a successful response to a SIP NOTIFY request, or if the calling filter is the last filter in the chain, the last filter is invoked and processing is returned back through the filter chain.
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
Method Detail

doSubscribe

void doSubscribe(javax.servlet.sip.SipServletRequest request,
                 javax.servlet.sip.SipServletResponse response,
                 SipFilterChain chain)
                 throws java.io.IOException,
                        XdmsException
Causes the next filter in the chain to be invoked on a SIP SUBSCRIBE request, or if the calling filter is the last filter in the chain, the last filter is invoked and processing is returned back through the filter chain.

Parameters:
request - The SIP SUBSCRIBE request to pass along the chain
response - The SIP SUBSCRIBE response to pass along the chain
chain - The SipFilterChain
Throws:
IOException
XdmsException

doSuccessResponse

void doSuccessResponse(javax.servlet.sip.SipServletResponse response,
                       SipFilterChain chain)
                       throws java.io.IOException,
                              XdmsException
Causes the next filter in the chain to be invoked on a successful response to a SIP NOTIFY request, or if the calling filter is the last filter in the chain, the last filter is invoked and processing is returned back through the filter chain.

Parameters:
response - The SipServletResponse
chain - The SipFilterChain
Throws:
IOException
XdmsException

doErrorResponse

void doErrorResponse(javax.servlet.sip.SipServletResponse response,
                     SipFilterChain chain)
                     throws java.io.IOException,
                            XdmsException
Causes the next filter in the chain to be invoked on an error response to a SIP NOTIFY request, or if the calling filter is the last filter in the chain, the last filter is invoked and processing is returned back through the filter chain.

Parameters:
response - The SipServletResponse
chain - The SipFilterChain
Throws:
IOException
XdmsException