The following section describes configuration and maintenance attributes and operations for the communication services that expose Parlay X 2.1 Presence Web Services interfaces:
This section contains a description of the configuration attributes and operations available for the Parlay X 2.1 Presence/SIP network protocol plug-in instance.
Parlay X 2.1 Presence/SIP uses two parts for SIP connectivity, a part that executes as a network protocol plug-in instance in Oracle Communications Services Gatekeeper container, and a part that executes as a SIP application in the SIP Server container.
The plug-in instance uses a set of caches:
In Parlay X 2.1 Presence, the SIP URI of the user (the presentity in PresenceSupplier cases, the watcher in PresenceConsumer cases) is not passed as an argument. Instead Oracle Communications Services Gatekeeper maps the user URI to the application instance ID of the user application, The URI mapping is configured as a part of the service provider and application provisioning workflow and is then stored in the URI cache. For requests that originate from an application, the URI is fetched from this cache before being put into the from
header in the SIP requests. For application terminating requests, the to
header URI passed in the SIP NOTIFY requests is used to look up the account username/application instance ID.
Note: | In the case of the PresenceSupplier interface, the application can override the default mapping by including a tunneled parameter in the header of its request. |
Every subscription, pending or not, is stored in this cache during the subscription’s lifetime. It is added when an application invokes the subscribePresence
method on the application-facing interface, and removed when the subscription is terminated.
All registered notifications are cached. The entries are created when an application invokes startPresenceNotification
on the application-facing interface and are removed when endPresenceNotification
is invoked, the end criteria are reached, or the subscription is ended.
This plug-in service does not support multiple instantiation using the Plug-in Manager. There is a one to one mapping between plug-in service and plug-in instance. The plug-in instance is created when the plug-in service is started.
Move on to the provisioning of service provider accounts and application accounts.
For every application a mapping between a SIP URI and application instance ID needs to be defined using Operation: setApplicationInstanceSIPURI.
To display the mapping, use Operation: getApplicationInstanceSIPURI.
If an application is deleted, the data for the application needs to be removed using Operation: removeApplicationInstanceFromCache.
Managed object: Communication Services->Plugin_presence_sip
MBean: com.bea.wlcp.wlng.plugin.presence.sip.impl.PresenceMBean
Below is a list of attributes and operations for configuration and maintenance:
Specifies the default notification count value. This value is used if none is provided in the startNotification
requests from the application.
Specifies the value of the default notification duration. This value is used if none is provided in the startNotification
request form the application.
Specifies the value of the timer used for checking on and cleaning up old notifications.
Each time the timer expires, it initiates a check for old notifications. If an old notification is found during the check it will be removed internally and a statusEnd
callback is made to the application.
Format: String formatted as a SIP URI
Specifies the address to which the subscribe messages are sent. It can be the IP address of the presence server or another IMS node that proxies the request.
Format: String formatted as a SIP URI
Specifies the XCAP root URI of the XDM server.
Format: String formatted as a partial path.
Specifies the last-part of the XCAP Document selector for presence rules. This part is after the XCAP User Identifier(XUI). Generally the selector URI should be the string of the following type: [XCAP_ROOT]/[AUID]/users/[XUI]/[document_name]
/presrules
Format: String formatted as a path
The pre-part of the XCAP Document selector for presence rules. This part is before the XCAP User Identifier(XUI). Generally the selector URI should be the string of the following type: [XCAP_ROOT]/[AUID]/users/[XUI]/[document_name]
/services/pres-rules/users/
The class name of XDM Server provider. This is a pluggable function to allow third party vendors of XDMS to customize their own XCAP client. This class must implement the "com.bea.wlcp.wlng.plugin.presence.sip.south.xcap.XCAPClient" interface.
Specifies the value of the timer used for checking on and cleaning up old subscription.
Each time the timer expires, it initiates a check for old subscriptions. If an old subscription is found during the check it will be removed a callback is made to the application.
Specifies the maximum lifetime of a subscription.
This value might not be accepted by the Presence Server. The Presence Server may override this expiry value, and give the suggested value to be used in the first NOTIFY sent to the plug-in instance. In that case, the lifetime for the presence subscription will be according to the value received from the Presence Server.
Clears one or all caches used by this plug-in instance.
Note: | Use this method with care. |
clearCache(cacheToClear: String)
Displays the application instance ID associated with a SIP URI. The application instance is identifies an application.
getApplicationInstance(Uri: String)
Displays the SIP URI associated with an application instance. The application instance is used by an application.
getApplicationInstanceSIPURI(ApplicationInstanceID: String)
Displays the cache where notification information is stored. Used for troubleshooting.
Note: | Use with caution; lists data from all entries in the notification cache. |
listNotificationsCache()
Displays the cache where subscription information is stored. Used for troubleshooting.
Note: | Use with caution; lists data from all entries in the subscriptions cache. |
listSubscriptionsCache()
Displays the cache where URI mappings information is stored. Used for troubleshooting.
Note: | Use with caution; lists data from all entries in the URI mappings cache. |
listURImappingCache()
Removes entries that are associated with an application instance from the URI mappings cache. If an application instance has been removed, the associated entries in the cache must be removed, too.
removeApplicationInstanceFromCache(ApplicationInstance: String)
Removes a notification. The application will not be notified that the notification has been removed.
removeNotification(ApplicationInstanceID: String, Presentity: String)
Removes a subscription and notifications. The application will not be notified that the subscription has been removed.
removeSubscription(ApplicationInstanceID: String, Presentity: String)
Associates a SIP URI with an application instance. See URI Cache.
setApplicationInstanceSIPURI(appInstGrpId: String, URI: String)
Updates the xml rule in XDMS to status: confirm.
Forces a blocked subscription to be pending/confirmed.
updateSubscriptionToBeconfirmed(presentity: String, watcher: String)