com.ibm.xdms.common
Interface ApplicationUsage


public interface ApplicationUsage

This interface describes a class that will provide configuration information for a specific AUID usage.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 AlarmAndFaultLogger getAlarmAndFaultLogger()
          Returns the AlarmAndFaultLogger function for this AUID
 java.lang.String getAuid()
          Returns the AUID for this configuration.
 AuidConfig getAuidConfig()
          Returns the AUID configuration parameters.
 java.lang.String getAuidGlobalPath()
          Returns the global path for this AUID <auid>/global/
 Authorization getAuthorization()
          Returns the Authorization function for this AUID.
 Datastore getDatastore()
          Returns the Datastore function for this AUID.
 java.lang.String getDefaultNamespace()
          Returns the default namespace for the application usage
 DomXmlProcessor getDomXmlProcessor()
          Returns the DomXmlProcessor function for this AUID.
 java.lang.Object getFunction(java.lang.Class interfaceName)
          Returns the function object implementing a certain interface for this AUID.
 java.util.Set<java.lang.Class> getFunctionIterfaces()
          Returns the interface Class objects for this AUID.
 com.ibm.xcap.NodeSelector getGlobalIndexNodeSelector(java.lang.String uniqueId)
          If the global index nodeselector is defined for the application usage, this method will retrieve it and substitute the $1 replacement variable with the uniqueId parameter.
 java.lang.String getMimeType()
          Returns the mime-type of the documents associated with the AUID.
 java.util.List<java.lang.String> getSipFilters()
           
 SipSubscribeHelper getSipSubscribeHelper()
          Returns the SipSubscribeHelper function for this AUID
 SipXcapDiffSubscriptions getSipXcapDiffSubscriptions()
          Returns the SipXcapDiffSubscriptions function for this AUID
 UriHelper getUriHelper()
          Returns the UriHelper function for this AUID
 UsageRecordLogger getUsageRecordLogger()
          Returns the UsageRecordLogger function for this AUID
 XcapCaps getXcapCaps()
          Returns the root XcapCaps object to access other ApplicationUsages
 java.util.List<java.lang.String> getXcapFilters()
           
 java.util.List<XqueryTemplate> getXqueryTemplates()
          Returns the XqueryTemplates for this AUID
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
Method Detail

getAuid

java.lang.String getAuid()
Returns the AUID for this configuration.

Returns:
Returns the AUID for this configuration

getAuidGlobalPath

java.lang.String getAuidGlobalPath()
Returns the global path for this AUID <auid>/global/

Returns:
Returns the global path for this AUID

getMimeType

java.lang.String getMimeType()
Returns the mime-type of the documents associated with the AUID.

Returns:
Returns the mime-type of the documents associated with the AUID.

getDefaultNamespace

java.lang.String getDefaultNamespace()
Returns the default namespace for the application usage

Returns:
Returns the default namespace for the application usage

getXcapFilters

java.util.List<java.lang.String> getXcapFilters()

getSipFilters

java.util.List<java.lang.String> getSipFilters()

getXcapCaps

XcapCaps getXcapCaps()
Returns the root XcapCaps object to access other ApplicationUsages

Returns:
Returns the root XcapCaps object to access other ApplicationUsages

getAuidConfig

AuidConfig getAuidConfig()
Returns the AUID configuration parameters.

Returns:
Returns the AUID configuration parameters.

getGlobalIndexNodeSelector

com.ibm.xcap.NodeSelector getGlobalIndexNodeSelector(java.lang.String uniqueId)
                                                     throws java.net.MalformedURLException
If the global index nodeselector is defined for the application usage, this method will retrieve it and substitute the $1 replacement variable with the uniqueId parameter. If the global index nodeselector is not defined, then null is returned.

Parameters:
uniqueId - The unique ID used to uniquely identify an element within the global index.
Returns:
Returns the NodeSelector that can be used to fetch a unique element within the global index.
Throws:
java.net.MalformedURLException

getFunctionIterfaces

java.util.Set<java.lang.Class> getFunctionIterfaces()
Returns the interface Class objects for this AUID.

Returns:
Returns the interface Class objects.

getFunction

java.lang.Object getFunction(java.lang.Class interfaceName)
Returns the function object implementing a certain interface for this AUID.

Parameters:
interfaceName - The Class object of the interface implemented by the helper function.
Returns:
Returns the function object implementing a certain interface for this AUID.

getAuthorization

Authorization getAuthorization()
Returns the Authorization function for this AUID.

Returns:
Returns the Authorization function for this AUID.

getDatastore

Datastore getDatastore()
Returns the Datastore function for this AUID.

Returns:
Returns the Datastore function for this AUID.

getDomXmlProcessor

DomXmlProcessor getDomXmlProcessor()
Returns the DomXmlProcessor function for this AUID.

Returns:
Returns the DomXmlProcessor function for this AUID.

getSipSubscribeHelper

SipSubscribeHelper getSipSubscribeHelper()
Returns the SipSubscribeHelper function for this AUID

Returns:
Returns the SipSubscribeHelper function for this AUID

getSipXcapDiffSubscriptions

SipXcapDiffSubscriptions getSipXcapDiffSubscriptions()
Returns the SipXcapDiffSubscriptions function for this AUID

Returns:
Returns the SipXcapDiffSubscriptions function for this AUID

getUsageRecordLogger

UsageRecordLogger getUsageRecordLogger()
Returns the UsageRecordLogger function for this AUID

Returns:
Returns the UsageRecordLogger function for this AUID

getAlarmAndFaultLogger

AlarmAndFaultLogger getAlarmAndFaultLogger()
Returns the AlarmAndFaultLogger function for this AUID

Returns:
Returns the AlarmAndFaultLogger function for this AUID

getUriHelper

UriHelper getUriHelper()
Returns the UriHelper function for this AUID

Returns:
Returns the UriHelper function for this AUID

getXqueryTemplates

java.util.List<XqueryTemplate> getXqueryTemplates()
Returns the XqueryTemplates for this AUID

Returns:
Returns a list of XqueryTemplates for this AUID