com.opencloud.slee.resources.sis.management

Interface AddressSubscriptionManagementMBean

public interface AddressSubscriptionManagementMBean

SIS-IN RA management interface for managing per-address subscriptions.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
String	getAddressSubscriptionsProfileTableName() Get the name of the current address subscriptions profile table in the SIS-IN RA entity.
AddressSubscription	getSubscription(String name) Retrieves an installed address subscription from the SIS-IN RA entity.
AddressSubscription	getSubscriptionByAddress(String address) Retrieves the subscription for the given address.
AddressSubscription[]	getSubscriptions() Get all installed address subscriptions.
void	installSubscription(AddressSubscription subscription) Install a new address subscription in the SIS-IN RA entity.
void	setAddressSubscriptionsProfileTableName(String tableName) Set the name of the address subscriptions profile table in the SIS-IN RA entity.
void	uninstallSubscription(String name) Uninstall an address subscription from the SIS-IN RA entity.
void	updateSubscription(AddressSubscription subscription) Update an existing address 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

getAddressSubscriptionsProfileTableName

String getAddressSubscriptionsProfileTableName()
                                        throws ManagementException

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

Returns:

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

Throws:

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

See Also:

setAddressSubscriptionsProfileTableName(java.lang.String)

setAddressSubscriptionsProfileTableName

void setAddressSubscriptionsProfileTableName(String tableName)
                                      throws ManagementException

Set the name of the address 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 address subscriptions profile table. May be null.

Throws:

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

See Also:

getAddressSubscriptionsProfileTableName()

installSubscription

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

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

Parameters:

subscription - an AddressSubscription object describing the originating and terminating services for an address.

Throws:

NullPointerException - if subscription is null.

AlreadyDeployedException - if an address 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 an address 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(AddressSubscription subscription)
                 throws NullPointerException,
                        UnrecognizedComponentException,
                        ManagementException

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

Parameters:

subscription - an AddressSubscription object describing the originating and terminating services for an address. 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

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

Retrieves an installed address subscription from the SIS-IN RA entity.

Parameters:

name - the name of the subscription to retrieve.

Returns:

the address subscription.

Throws:

NullPointerException - if name is null.

UnrecognizedComponentException - if the named subscription does not exist.

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

getSubscriptionByAddress

AddressSubscription getSubscriptionByAddress(String address)
                                      throws NullPointerException,
                                             ManagementException

Retrieves the subscription for the given address.

Parameters:

address - the subscribed address.

Returns:

the subscription for the given address, or null if not found.

Throws:

NullPointerException - if address is null.

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

getSubscriptions

AddressSubscription[] getSubscriptions()
                                throws ManagementException

Get all installed address subscriptions.

Returns:

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

Throws:

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