com.ibm.xdms.sip.filter
Class BaseSipFilter

java.lang.Object
  extended by com.ibm.xdms.sip.filter.BaseSipFilter
All Implemented Interfaces:
SipFilter

public abstract class BaseSipFilter
extends java.lang.Object
implements SipFilter

Abstract class that implements the init method to store the member variables.


Field Summary
protected  ApplicationUsage appUsage
          The application usage for this filter *
protected  AuidConfig auidConfig
          The AUID configuration for this filter *
static java.lang.String COPYRIGHT
           
protected  XcapCaps xcapCaps
          The entire xcap capabilities object for the XDMS *
 
Constructor Summary
BaseSipFilter()
           
 
Method Summary
 void init(XcapCaps xcapCaps, ApplicationUsage appUsage, AuidConfig auidConfig)
          Called to indicate to a filter that it is being placed into service.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.xdms.sip.filter.SipFilter
destroy, doErrorResponse, doSubscribe, doSuccessResponse
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

xcapCaps

protected XcapCaps xcapCaps
The entire xcap capabilities object for the XDMS *


appUsage

protected ApplicationUsage appUsage
The application usage for this filter *


auidConfig

protected AuidConfig auidConfig
The AUID configuration for this filter *

Constructor Detail

BaseSipFilter

public BaseSipFilter()
Method Detail

init

public void init(XcapCaps xcapCaps,
                 ApplicationUsage appUsage,
                 AuidConfig auidConfig)
          throws XdmsException
Called to indicate to a filter that it is being placed into service. The init method is called exactly once after instantiating the filter. The init method must complete successfully before the filter is asked to do any filtering work.

Specified by:
init in interface SipFilter
Parameters:
xcapCaps - The entire xcap capabilities object for the XDMS.
appUsage - The application usage for this filter.
auidConfig - The AUID configuration for this filter.
Throws:
XdmsException - Thrown if the filter should not be used