|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SipFilter
A SIP filter is an object that performs filtering tasks on the SIP request and provides a response either through the SIP response or via a SIP Notify back to the client. Examples that have been identified for this design are
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
Method Summary | |
---|---|
void |
destroy()
Called to indicate to a filter that it is being taken out of service. |
void |
doErrorResponse(javax.servlet.sip.SipServletResponse response,
SipFilterChain chain)
This method is invoked if an error response is returned from a SIP NOTIFY request. |
void |
doSubscribe(javax.servlet.sip.SipServletRequest request,
javax.servlet.sip.SipServletResponse response,
SipFilterChain chain)
The doSubscribe method of the SipFilter is called each time a SIP Subscribe request is passed through the chain due to a client request. |
void |
doSuccessResponse(javax.servlet.sip.SipServletResponse response,
SipFilterChain chain)
This method is invoked if a successful response is returned from a SIP NOTIFY request. |
void |
init(XcapCaps xcapCaps,
ApplicationUsage appUsage,
AuidConfig auidConfig)
Called to indicate to a filter that it is being placed into service. |
Field Detail |
---|
static final java.lang.String COPYRIGHT
Method Detail |
---|
void init(XcapCaps xcapCaps, ApplicationUsage appUsage, AuidConfig auidConfig) throws XdmsException
xcapCaps
- The entire xcap capabilities object for the XDMS.appUsage
- The application usage for this filter.auidConfig
- The AUID configuration for this filter.
XdmsException
- Thrown if the filter should not be usedvoid destroy()
void doSubscribe(javax.servlet.sip.SipServletRequest request, javax.servlet.sip.SipServletResponse response, SipFilterChain chain) throws java.io.IOException, XdmsException
request
- The SIP SUBSCRIBE requestresponse
- The SIP SUBSCRIBE response to the SIP Subscribe requestchain
- SIP Filter Chain
IOException
XdmsException
void doSuccessResponse(javax.servlet.sip.SipServletResponse response, SipFilterChain chain) throws java.io.IOException, XdmsException
response
- The SipServletResponsechain
- SIP Filter Chain
IOException
XdmsException
void doErrorResponse(javax.servlet.sip.SipServletResponse response, SipFilterChain chain) throws java.io.IOException, XdmsException
response
- The SipServletResponsechain
- SIP Filter Chain
IOException
XdmsException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |