Package com.opencloud.slee.resources.insis.management

Interface ServiceKeySubscriptionManagementMBean

public interface ServiceKeySubscriptionManagementMBean

SIS-IN RA management interface for managing per-service-key subscriptions.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SIS_MANAGEMENT_TYPE	The type of this MBean.

Method Summary

Modifier and Type	Method	Description
String	getServiceKeySubscriptionsProfileTableName()	Get the name of the current service key subscriptions profile table in the SIS-IN RA entity.
ServiceKeySubscription	getSubscription(String name)	Retrieves an installed service key subscription from the SIS-IN RA.
ServiceKeySubscription	getSubscriptionByServiceKey(int serviceKey)	Retrieves the subscription for the given service key.
ServiceKeySubscription[]	getSubscriptions()	Get all installed service key subscriptions.
void	installSubscription(ServiceKeySubscription subscription)	Install a new service key subscription in the SIS-IN RA entity.
void	setServiceKeySubscriptionsProfileTableName(String tableName)	Set the name of the service key subscriptions profile table in the SIS-IN RA entity.
void	uninstallSubscription(String name)	Uninstall a service key subscription from the SIS-IN RA entity.
void	updateSubscription(ServiceKeySubscription subscription)	Update an existing service key subscription in the SIS-IN RA entity.

Field Detail

SIS_MANAGEMENT_TYPE

static final String SIS_MANAGEMENT_TYPE

The type of this MBean. This value is used as part of the MBean's Object Name.

See Also:

Constant Field Values

Method Detail

getServiceKeySubscriptionsProfileTableName

String getServiceKeySubscriptionsProfileTableName()
                                           throws ManagementException

Get the name of the current service key subscriptions profile table in the SIS-IN RA entity.

Returns:

the name of the current service key subscriptions profile table, or null if none has been configured.

Throws:

ManagementException - if an error occurs communicating with the management server.

See Also:

setServiceKeySubscriptionsProfileTableName(java.lang.String)

setServiceKeySubscriptionsProfileTableName

void setServiceKeySubscriptionsProfileTableName(String tableName)
                                         throws ManagementException

Set the name of the service key subscriptions profile table in the SIS-IN RA entity.

The SIS-IN RA's configuration must be reloaded before the configuration changes caused by this method take effect. Refer to the package summary for further details.

Parameters:

tableName - the new name of the service key subscriptions profile table. May be null.

Throws:

ManagementException - if an error occurs communicating with the management server.

See Also:

getServiceKeySubscriptionsProfileTableName()

installSubscription

void installSubscription(ServiceKeySubscription subscription)
                  throws NullPointerException,
                         AlreadyDeployedException,
                         DeploymentException,
                         ManagementException

Install a new service key subscription in the SIS-IN RA entity.

Parameters:

subscription - a ServiceKeySubscription object describing the originating and terminating services for a service key.

Throws:

NullPointerException - if subscription is null.

AlreadyDeployedException - if a service key subscription of the same name already exists.

DeploymentException - if a deployment error occurs.

ManagementException - if an error occurs communicating with the management server.

uninstallSubscription

void uninstallSubscription(String name)
                    throws NullPointerException,
                           UnrecognizedComponentException,
                           ManagementException

Uninstall a service key subscription from the SIS-IN RA entity.

Parameters:

name - the name of the subscription to remove.

Throws:

NullPointerException - if name is null.

UnrecognizedComponentException - if the named subscription does not exist.

ManagementException - if an error occurs communicating with the management server.

updateSubscription

void updateSubscription(ServiceKeySubscription subscription)
                 throws NullPointerException,
                        UnrecognizedComponentException,
                        ManagementException

Update an existing service key subscription in the SIS-IN RA entity.

Parameters:

subscription - a ServiceKeySubscription object describing the originating and terminating services for a service key. This subscription data will replace the existing data for the subscription with the name subscription.getName().

Throws:

NullPointerException - if subscription is null.

UnrecognizedComponentException - if a subscription with the name specified by subscription.getName() does not exist.

ManagementException - if an error occurs communicating with the management server.

getSubscription

ServiceKeySubscription getSubscription(String name)
                                throws NullPointerException,
                                       UnrecognizedComponentException,
                                       ManagementException

Retrieves an installed service key subscription from the SIS-IN RA.

Parameters:

name - the name of the subscription to retrieve.

Returns:

an ServiceKeySubscription object.

Throws:

NullPointerException - if name is null.

UnrecognizedComponentException - if the named subscription does not exist.

ManagementException - if an error occurs communicating with the management server.

getSubscriptionByServiceKey

ServiceKeySubscription getSubscriptionByServiceKey(int serviceKey)
                                            throws NullPointerException,
                                                   ManagementException

Retrieves the subscription for the given service key.

Parameters:

serviceKey - the subscribed service key.

Returns:

the subscription for the given service key, or null if not found.

Throws:

ManagementException - if an error occurs communicating with the management server.

NullPointerException

getSubscriptions

ServiceKeySubscription[] getSubscriptions()
                                   throws ManagementException

Get all installed service key subscriptions.

Returns:

an array of ServiceKeySubscription objects, or an empty array if there are no subscriptions installed.

Throws:

ManagementException - if an error occurs communicating with the management server.