Skip navigation links

com.bea.wlcp.wlng.plugin.presence.sip.management
Interface PresenceMBean

public interface PresenceMBean

Runtime MBean to configure the Presence plugin.

Field Summary

static int	defaultNotificationCount The default notification count value.
static int	defaultNotificationDuration The value (in seconds) of the default notification duration.
static int	notificationCleanupTimerValue The value (in seconds) of the timer used for checking and cleanup of old notifications.
static String	presenceServerAddress Presence Server address (or other node where subscribe requests should be sent).
static String	presenceXDMSAddress XCAP root URI of the XDM Server (for example, http://127.0.0.1:8080/services)
static String	presenceXDMSPassword The password for HTTP Authentication of XDMS.
static String	presenceXDMSPresrulesPostfix The last-part of the XCAP Document selector for presence rules (for example, /presrules).
static String	presenceXDMSPresrulesPrefix The pre-part of the XCAP Document selector for presence rules (for example, /pres-rules/users/).
static String	presenceXDMSProviderClassName The class name of XDM Server provider.
static String	presenceXDMSUsername The username for HTTP Authentication of XDMS.
static int	subscribeExpiryValue The value (in seconds) of the suggested subscription lifetime (default 300).
static int	subscriptionCleanupTimerValue The value (in seconds) of the timer used for checking and cleanup of old subscriptions.

Method Summary

void	clearCache(String cacheToClear) Important: Use with care.
String	getApplicationInstance(String uri) Gets the application instance ID associated to the supplied URI.
String	getApplicationInstanceSIPURI(String applicationInstanceID) Gets the URI associated to the supplied application instance ID.
int	getDefaultNotificationCount() Returns the default notification count value.
int	getDefaultNotificationDuration() Returns the value (in seconds) of the default notification duration.
int	getNotificationCleanupTimerValue() Gets the value of the timer used for checking and cleanup of old notifications.
String	getPresenceServerAddress() Returns the presence server address (or other node where subscribe requests should be sent).
String	getPresenceXDMSAddress() Returns the XCAP root URI of the XDM Server (for example, http://127.0.0.1:8080/services)
String	getPresenceXDMSPassword() Returns the password for HTTP Authentication of XDMS.
String	getPresenceXDMSPresrulesPostfix() Returns the last-part of the XCAP Document selector for Presence rules.
String	getPresenceXDMSPresrulesPrefix() Returns the pre-part of the XCAP Document selector for presence rules.
String	getPresenceXDMSProviderClassName() Returns the class name of XDM Server provider.
String	getPresenceXDMSUsername() Returns the username for HTTP Authentication of XDMS.
int	getSubscribeExpiryValue() Returns the value (in seconds) of the suggested subscription lifetime (default 300).
int	getSubscriptionCleanupTimerValue() Gets the value of the timer used for checking and cleanup of old subscriptions.
String[]	listNotificationsCache() Debug operation left for troubleshooting.
String[]	listSubscriptionsCache() Debug operation left for troubleshooting.
String[]	listURIMappingCache() Debug operation left for troubleshooting.
void	removeApplicationInstanceFromCache(String applicationInstanceID) Removes entries that are associated to the supplied application instance ID.
void	removeNotification(String appInstGrpId, String presentity) Removes a notification.
void	removeSubscription(String appInstGrpId, String presentity) Removes a subscription and notification if there is one.
void	setApplicationInstanceSIPURI(String applicationInstanceID, String URI) Associate a SIP URI with an application instance.
void	setDefaultNotificationCount(int count) Sets the default notification count value.
void	setDefaultNotificationDuration(int seconds) Sets the value (in seconds) of the default notification duration.
void	setNotificationCleanupTimerValue(int seconds) Sets the value (in seconds) of the timer used for checking and cleanup of old notifications.
void	setPresenceServerAddress(String s) Sets the presence server address (or other node where subscribe requests should be sent).
void	setPresenceXDMSAddress(String address) Sets the XCAP root URI of the XDM Server (for example, http://127.0.0.1:8080/services)
void	setPresenceXDMSPassword(String password) Sets the password for HTTP Authentication of XDMS.
void	setPresenceXDMSPresrulesPostfix(String postfix) Sets the last-part of the XCAP Document selector for Presence rules.
void	setPresenceXDMSPresrulesPrefix(String prefix) Sets the pre-part of the XCAP Document selector for presence rules.
void	setPresenceXDMSProviderClassName(String className) Sets the class name of the XDM Server provider.
void	setPresenceXDMSUsername(String username) Sets the username for HTTP Authentication of XDMS.
void	setSubscribeExpiryValue(int seconds) Sets the value (in seconds) of the suggested subscription lifetime (default 300).
void	setSubscriptionCleanupTimerValue(int seconds) Sets the value (in seconds) of the timer used for checking and cleanup of old subscriptions.
void	updateSubscriptionToBeConfirmed(String presentity, String watcher) Debug operation left for testing.

Field Detail

defaultNotificationCount

public static final int defaultNotificationCount

The default notification count value. This value is used if none is provided in startNotification. Format: int [>1]. Default Value: 50.

See Also:

Constant Field Values

defaultNotificationDuration

public static final int defaultNotificationDuration

The value (in seconds) of the default notification duration. This value is used if none is provided in startNotification. Example values: 86400s = 1 day, 604800s = 1 week Format: int [>10]. Default Value: 604800s = 1 week.

Scope: Cluster

See Also:

Constant Field Values

notificationCleanupTimerValue

public static final int notificationCleanupTimerValue

The value (in seconds) of the timer used for checking and cleanup of old notifications. Each time the timer expires, it will initiate a check for old notifications. If an old notification is found during the check it will be removed internally and a statusEnd-callback will be made to the application. Format: int [>10].

Scope: Cluster

See Also:

Constant Field Values

presenceServerAddress

public static final String presenceServerAddress

Presence Server address (or other node where subscribe requests should be sent). It can be the IP address of the Presence server or another IMS node that proxies the request.

Scope: Cluster

See Also:

Constant Field Values

presenceXDMSAddress

public static final String presenceXDMSAddress

XCAP root URI of the XDM Server (for example, http://127.0.0.1:8080/services)

Scope: Cluster

See Also:

Constant Field Values

presenceXDMSPassword

public static final String presenceXDMSPassword

The password for HTTP Authentication of XDMS.

Scope: Cluster

See Also:

Constant Field Values

presenceXDMSPresrulesPostfix

public static final String presenceXDMSPresrulesPostfix

The last-part of the XCAP Document selector for presence rules (for example, /presrules). This part is after XCAP User Identifier(XUI).

Scope: Cluster

See Also:

Constant Field Values

presenceXDMSPresrulesPrefix

public static final String presenceXDMSPresrulesPrefix

The pre-part of the XCAP Document selector for presence rules (for example, /pres-rules/users/). This part is before XCAP User Identifier(XUI).

Scope: Cluster

See Also:

Constant Field Values

presenceXDMSProviderClassName

public static final String presenceXDMSProviderClassName

The class name of XDM Server provider. Here we provided a pluggable function to permit the third party vendors of XDMS to customize their own XCAP client. This class should implement the "com.bea.wlcp.wlng.plugin.presence.sip.south.xcap.XCAPClient" interface. The system has provided a class named "com.bea.wlcp.wlng.plugin.presence.sip.south.xcap.IETFXCAPClient" which is compatible with IETF spec.

Scope: Cluster

See Also:

Constant Field Values

presenceXDMSUsername

public static final String presenceXDMSUsername

The username for HTTP Authentication of XDMS.

Scope: Cluster

See Also:

Constant Field Values

subscribeExpiryValue

public static final int subscribeExpiryValue

The value (in seconds) of the suggested subscription lifetime (default 300). 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. Format: int.

Scope: Cluster

See Also:

Constant Field Values

subscriptionCleanupTimerValue

public static final int subscriptionCleanupTimerValue

The value (in seconds) of the timer used for checking and cleanup of old subscriptions. Each time the timer expires, it will initiate a check for old subscriptions. If an old subscription is found during the check it will be removed internally and callback(s) will be made to the client. Format: int [>10].

Scope: Cluster

See Also:

Constant Field Values

Method Detail

clearCache

public void clearCache(String cacheToClear)
                throws ManagementException

Important: Use with care.

Scope: Cluster

Parameters:

cacheToClear - is the cache to clear. Valid options are {NOTIFICATIONS,SUBSCRIPTIONS,URIMAPPINGS,ALL}. For example, invoking this method with ALL will clear all caches.

Throws:

ManagementException.

ManagementException

getApplicationInstance

public String getApplicationInstance(String uri)
                              throws StorageException

Gets the application instance ID associated to the supplied URI.

Scope: Cluster

Parameters:

uri - the sip uri.

Throws:

StorageException - if the underlying storage facility fails.

getApplicationInstanceSIPURI

public String getApplicationInstanceSIPURI(String applicationInstanceID)
                                    throws StorageException

Gets the URI associated to the supplied application instance ID.

Scope: Cluster

Parameters:

applicationInstanceID - The application instance ID.

Throws:

StorageException - if the underlying storage facility fails.

getDefaultNotificationCount

public int getDefaultNotificationCount()
                                throws ManagementException

Returns the default notification count value. Default Value: 50.

Scope: Cluster

Returns:

the default notification count value

Throws:

ManagementException

getDefaultNotificationDuration

public int getDefaultNotificationDuration()
                                   throws ManagementException

Returns the value (in seconds) of the default notification duration. This value is used if none is provided in startNotification. Example values: 86400s = 1 day, 604800s = 1 week

Scope: Cluster

Returns:

value (in seconds) of the default notification duration

Throws:

ManagementException

getNotificationCleanupTimerValue

public int getNotificationCleanupTimerValue()

Gets the value of the timer used for checking and cleanup of old notifications.

Returns:

The value of the timer used for checking and cleanup of old notifications.

Scope: Cluster

getPresenceServerAddress

public String getPresenceServerAddress()
                                throws ManagementException

Returns the presence server address (or other node where subscribe requests should be sent).

Scope: Cluster

Returns:

presence server address

Throws:

ManagementException

getPresenceXDMSAddress

public String getPresenceXDMSAddress()
                              throws ManagementException

Returns the XCAP root URI of the XDM Server (for example, http://127.0.0.1:8080/services)

Scope: Cluster

Returns:

the XCAP root URI of the XDM Server

Throws:

ManagementException

getPresenceXDMSPassword

public String getPresenceXDMSPassword()
                               throws ManagementException

Returns the password for HTTP Authentication of XDMS.

Scope: Cluster

Returns:

HTTP authentication password

Throws:

ManagementException

getPresenceXDMSPresrulesPostfix

public String getPresenceXDMSPresrulesPostfix()
                                       throws ManagementException

Returns the last-part of the XCAP Document selector for Presence rules. Example: /presrules

Scope: Cluster

Returns:

the last-part of the XCAP Document selector for Presence rules

Throws:

ManagementException

getPresenceXDMSPresrulesPrefix

public String getPresenceXDMSPresrulesPrefix()
                                      throws ManagementException

Returns the pre-part of the XCAP Document selector for presence rules. This part is before the XCAP User Identifier(XUI). Example: /services/pres-rules/users/

Scope: Cluster

Returns:

the pre-part of the XCAP Document selector for presence rules

Throws:

ManagementException

getPresenceXDMSProviderClassName

public String getPresenceXDMSProviderClassName()
                                        throws ManagementException

Returns the class name of XDM Server provider.

Scope: Cluster

Returns:

class name of XDM Server provider

Throws:

ManagementException

getPresenceXDMSUsername

public String getPresenceXDMSUsername()
                               throws ManagementException

Returns the username for HTTP Authentication of XDMS.

Scope: Cluster

Returns:

HTTP authentication username

Throws:

ManagementException

getSubscribeExpiryValue

public int getSubscribeExpiryValue()
                            throws ManagementException

Returns the value (in seconds) of the suggested subscription lifetime (default 300). Format: int.

Scope: Cluster

Returns:

value (in seconds) of the suggested subscription lifetime

Throws:

ManagementException

getSubscriptionCleanupTimerValue

public int getSubscriptionCleanupTimerValue()

Gets the value of the timer used for checking and cleanup of old subscriptions.

Scope: Cluster

Returns:

The value of the timer used for checking and cleanup of old subscriptions.

listNotificationsCache

public String[] listNotificationsCache()
                                throws ManagementException

Debug operation left for troubleshooting. Note: Use with causion. This will list data from all entries in the Notification cache! The data is returned in a String array.

Scope: Cluster

Throws:

ManagementException - if lookup failed.

listSubscriptionsCache

public String[] listSubscriptionsCache()
                                throws ManagementException

Debug operation left for troubleshooting. Note: Use with causion. This will list data from all entries in the Subscription cache! The data is returned in a String array, and the returned data contains URI, appinstgrpid and pending flag. For example, uri: uri: sip:460001@bea.com appinstgrp: app_inst_1a pending: false.

Scope: Cluster

Throws:

ManagementException - if lookup failed.

listURIMappingCache

public String[] listURIMappingCache()
                             throws ManagementException

Debug operation left for troubleshooting. Note: Use with causion. This will list data from all entries in the URI mappings cache! The data is returned in a String array, and the returned data contains URI and appinstgrpid. For example, uri: sip:app_inst_1a@bea.com appinstgrp: app_inst_1a.

Scope: Cluster

Throws:

ManagementException - if lookup failed.

removeApplicationInstanceFromCache

public void removeApplicationInstanceFromCache(String applicationInstanceID)
                                        throws ManagementException

Removes entries that are associated to the supplied application instance ID. Use this method to remove any cache information of an application instance that has been deleted.

Scope: Cluster

Parameters:

applicationInstanceID - The application instance ID.

Throws:

ManagementException.

ManagementException

removeNotification

public void removeNotification(String appInstGrpId,
                               String presentity)
                        throws ManagementException

Removes a notification. Note that no callback will be made to the application when using this method.

Scope: Cluster

Parameters:

appInstGrpId - The userid that identifies this subscription.

presentity - Presentity.

Throws:

ManagementException - if operation is not successful.

removeSubscription

public void removeSubscription(String appInstGrpId,
                               String presentity)
                        throws ManagementException

Removes a subscription and notification if there is one. Note that no callback will be made to the application when using this method.

Scope: Cluster

Parameters:

appInstGrpId - The userid that identifies this subscription.

presentity - Presentity.

Throws:

ManagementException - if operation is not successful.

setApplicationInstanceSIPURI

public void setApplicationInstanceSIPURI(String applicationInstanceID,
                                         String URI)
                                  throws StorageException,
                                         URISyntaxException

Associate a SIP URI with an application instance.

Scope: Cluster

Parameters:

applicationInstanceID - the application instance ID

URI - The SIP URI.

Throws:

URISyntaxException.

StorageException - if the SIP URI is already associated with another application instance or if the underlying storage facility fails.

URISyntaxException

setDefaultNotificationCount

public void setDefaultNotificationCount(int count)
                                 throws ManagementException

Sets the default notification count value. This value is used if none is provided in startNotification. Format: int [>1]. Default Value: 50.

Scope: Cluster

Parameters:

count - default notification count value

Throws:

ManagementException

setDefaultNotificationDuration

public void setDefaultNotificationDuration(int seconds)
                                    throws ManagementException

Sets the value (in seconds) of the default notification duration. This value is used if none is provided in startNotification. Example values: 86400s = 1 day, 604800s = 1 week Format: int [>10]. Default Value: 604800s = 1 week.

Scope: Cluster

Parameters:

seconds - value (in seconds) of the default notification duration

Throws:

ManagementException

setNotificationCleanupTimerValue

public void setNotificationCleanupTimerValue(int seconds)
                                      throws ManagementException

Sets the value (in seconds) of the timer used for checking and cleanup of old notifications.

Scope: Cluster

Throws:

ManagementException

setPresenceServerAddress

public void setPresenceServerAddress(String s)
                              throws ManagementException

Sets the presence server address (or other node where subscribe requests should be sent). It can be the IP address of the Presence server or another IMS node that proxies the request.

Scope: Cluster

Parameters:

s - presence server address

Throws:

ManagementException

setPresenceXDMSAddress

public void setPresenceXDMSAddress(String address)
                            throws ManagementException

Sets the XCAP root URI of the XDM Server (for example, http://127.0.0.1:8080/services)

Scope: Cluster

Parameters:

address - XCAP root URI of the XDM Server

Throws:

ManagementException

setPresenceXDMSPassword

public void setPresenceXDMSPassword(String password)
                             throws ManagementException

Sets the password for HTTP Authentication of XDMS.

Scope: Cluster

Parameters:

password - HTTP authentication password

Throws:

ManagementException

setPresenceXDMSPresrulesPostfix

public void setPresenceXDMSPresrulesPostfix(String postfix)
                                     throws ManagementException

Sets 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] Example: /presrules

Scope: Cluster

Parameters:

postfix - last-part of the XCAP Document selector for Presence rules

Throws:

ManagementException

setPresenceXDMSPresrulesPrefix

public void setPresenceXDMSPresrulesPrefix(String prefix)
                                    throws ManagementException

Sets 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] Example: /services/pres-rules/users/

Scope: Cluster

Parameters:

prefix - pre-part of the XCAP Document selector for presence rules

Throws:

ManagementException

setPresenceXDMSProviderClassName

public void setPresenceXDMSProviderClassName(String className)
                                      throws ManagementException

Sets the class name of the XDM Server provider. This is a pluggable function to permit the third party vendors of XDMS to customize their own XCAP client. This class should implement the "com.bea.wlcp.wlng.plugin.presence.sip.south.xcap.XCAPClient" interface. The system has provided a class named "com.bea.wlcp.wlng.plugin.presence.sip.south.xcap.IETFXCAPClient" which is compatible with IETF spec.

Scope: Cluster

Parameters:

className - the class name of the XDM Server provider

Throws:

ManagementException

setPresenceXDMSUsername

public void setPresenceXDMSUsername(String username)
                             throws ManagementException

Sets the username for HTTP Authentication of XDMS.

Scope: Cluster

Parameters:

username - HTTP authentication username

Throws:

ManagementException

setSubscribeExpiryValue

public void setSubscribeExpiryValue(int seconds)
                             throws ManagementException

Sets the value (in seconds) of the suggested subscription lifetime (default 300). 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. Format: int.

Scope: Cluster

Parameters:

seconds - value (in seconds) of the suggested subscription lifetime

Throws:

ManagementException

setSubscriptionCleanupTimerValue

public void setSubscriptionCleanupTimerValue(int seconds)
                                      throws ManagementException

Sets the value (in seconds) of the timer used for checking and cleanup of old subscriptions.

Scope: Cluster

Throws:

ManagementException

updateSubscriptionToBeConfirmed

public void updateSubscriptionToBeConfirmed(String presentity,
                                            String watcher)
                                     throws ManagementException

Debug operation left for testing. Update the presence rule in XDMS to "confirm" status. Note: This method is only used to help presence supplier testing since some SIP terminators can't change the "block" subscription to be "pending". Using this operation we can force the blocked subscription to be pending/confirmed.

Scope: Cluster

Throws:

ManagementException.

ManagementException

Skip navigation links