com.opencloud.slee.resources.sis.management

Interface ExternalPlatformManagementMBean

public interface ExternalPlatformManagementMBean

Field Summary

Fields

Modifier and Type	Field and Description
static String	SIS_MANAGEMENT_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
void	activateINAddress(int position) Activate an IN address in the external platform definition managed by this MBean.
void	activateSIPAddress(int position) Activate a SIP address in the external platform definition managed by this MBean.
void	addINAddress(String address) Add an IN address to the external platform definition managed by this MBean.
void	addINAddress(String address, int position) Add an IN address to the external platform definition managed by this MBean.
void	addSIPAddress(String address) Add a SIP address to the external platform definition managed by this MBean.
void	addSIPAddress(String address, int position) Add a SIP address to the external platform definition managed by this MBean.
void	deactivateINAddress(int position) Deactivate an IN address in the external platform definition managed by this MBean.
void	deactivateSIPAddress(int position) Deactivate a SIP address in the external platform definition managed by this MBean.
CompositeData	getDescriptor() Get information about the external platform definition managed by this MBean.
ExternalAddressState	getINAddressState(int position) Get the current state of an IN address in the external platform definition managed by this MBean.
ExternalPlatformConfig	getPlatformConfig() Get the ExternalPlatformConfig object describing the configuration of the external platform definition
SISComponent[]	getReferringComponents() Get the set of components that depend on the external platform definition managed by this MBean.
ExternalAddressState	getSIPAddressState(int position) Get the current state of a SIP address in the external platform definition managed by this MBean.
void	remove() Remove the external platform definition managed by this MBean.
void	removeINAddress(int position) Remove an IN address from the external platform definition managed by this MBean.
void	removeSIPAddress(int position) Remove a SIP address from the external platform definition managed by this MBean.
void	repairINAddress(int position) Reactivate a failed IN address in the external platform definition managed by this MBean.
void	repairSIPAddress(int position) Reactivate a failed SIP address in the external platform definition managed by this MBean.
void	setPlatformConfig(ExternalPlatformConfig config) Update the configuration of this external platform definition.

Field Detail

SIS_MANAGEMENT_TYPE

static final String SIS_MANAGEMENT_TYPE

See Also:

Constant Field Values

Method Detail

getDescriptor

CompositeData getDescriptor()
                            throws ManagementException

Get information about the external platform definition managed by this MBean.

This method returns a CompositeData type with the following fields:

Field	Open Type	Description
name	String	The name given to the external platform.
selectionMode	String	The assigned external address selection mode.
detectInterval	Long	The interval (ms) between checking the proportion of failed calls for each of this platform's active addresses.
detectThreshold	Float	If the proportion of failed calls seen during a detect interval is greater than or equal to this value, the SIS marks the address as failed.
retryInterval	Long	The interval (ms) between attempts to retry a failed address, to see if it has recovered.
retryAttempts	Integer	The number of consecutive retry attempts that must succeed before the SIS will begin using a failed address again.
sipAddresses	TabularData	The set of SIP addresses for the external platform. The format of this tabular data is described below.
inAddresses	TabularData	The set of IN SCCP addresses for the external platform. The format of this tabular data is described below.

The TabularData used to describe addresses contains the following fields:

Field	Open Type	Description
position	Integer	The relative position of the address in the address list.
address	String	The address.
state	String	The current state of the address, one of "active", "inactive", or "failed".

Returns:

a CompositeData object as described above.

Throws:

ManagementException - if the service reference could not be obtained due to a system-level failure.

getReferringComponents

SISComponent[] getReferringComponents()
                                      throws ManagementException

Get the set of components that depend on the external platform definition managed by this MBean. An external platform definition may be referred to by:

• service references

Returns:

the set of referring components.

Throws:

ManagementException - if the referring components could not be retrieved due to a system-level failure.

addSIPAddress

void addSIPAddress(String address)
                   throws NullPointerException,
                          InvalidArgumentException,
                          DuplicateAddressException,
                          ManagementException

Add a SIP address to the external platform definition managed by this MBean. The new address will be appended to the end of the current list of SIP addresses for the external platform.

Any new address added to an external platform definition is assigned the ExternalAddressState.INACTIVE state.

Parameters:

address - the SIP address.

Throws:

NullPointerException - if address is null.

InvalidArgumentException - if the address is not a valid address.

DuplicateAddressException - if the address has already been added to this external platform definition.

ManagementException - if the address cannot be added due to a system-level failure.

addSIPAddress

void addSIPAddress(String address,
                 int position)
                   throws NullPointerException,
                          InvalidArgumentException,
                          DuplicateAddressException,
                          ManagementException

Add a SIP address to the external platform definition managed by this MBean. The new address will be inserted into the current list of SIP addresses for the external platform at the specified position.

Any new address added to an external platform definition is assigned the ExternalAddressState.INACTIVE state.

Parameters:

address - the SIP address.

position - the list position to insert the address. A value less than or equal to zero inserts the new address at the beginning of the list. A value greater than or equal to the current number of addresses adds the new address to the end of the list.

Throws:

NullPointerException - if address is null.

InvalidArgumentException - if the address is not a valid address.

DuplicateAddressException - if the address has already been added to this external platform definition.

ManagementException - if the address cannot be added due to a system-level failure.

removeSIPAddress

void removeSIPAddress(int position)
                      throws InvalidArgumentException,
                             ManagementException

Remove a SIP address from the external platform definition managed by this MBean.

Parameters:

position - the list position of the address to remove.. This must be a value between 0 and one less than the number of SIP addresses currently present.

Throws:

InvalidArgumentException - if an invalid position is specified.

ManagementException - if the address cannot be removed due to a system-level failure.

activateSIPAddress

void activateSIPAddress(int position)
                        throws InvalidArgumentException,
                               InvalidStateException,
                               ManagementException

Activate a SIP address in the external platform definition managed by this MBean. An external address must be activated before the SIS will consider sending any traffic to it.

Parameters:

position - the list position of the address to activate. This must be a value between 0 and one less than the number of SIP addresses currently present.

Throws:

InvalidArgumentException - if an invalid position is specified.

InvalidStateException - if the address is already in the ACTIVE state.

ManagementException - if the address cannot be activated due to a system-level failure.

deactivateSIPAddress

void deactivateSIPAddress(int position)
                          throws InvalidArgumentException,
                                 InvalidStateException,
                                 ManagementException

Deactivate a SIP address in the external platform definition managed by this MBean.

Parameters:

position - the list position of the address to deactivate. This must be a value between 0 and one less than the number of SIP addresses currently present.

Throws:

InvalidArgumentException - if an invalid position is specified.

InvalidStateException - if the address is already in the INACTIVE state.

ManagementException - if the address cannot be activated due to a system-level failure.

repairSIPAddress

void repairSIPAddress(int position)
                      throws InvalidArgumentException,
                             InvalidStateException,
                             ManagementException

Reactivate a failed SIP address in the external platform definition managed by this MBean. This operation is provided so that administrators can manually restore a failed address to active state, bypassing the SIS's retry attempts. Alarms for the failed address are cleared.

Parameters:

position - the list position of the address to reactivate. This must be a value between 0 and one less than the number of SIP addresses currently present.

Throws:

InvalidArgumentException - if an invalid position is specified.

InvalidStateException - if the address is not in the FAILED state.

ManagementException - if the address cannot be reactivated due to a system-level failure.

getSIPAddressState

ExternalAddressState getSIPAddressState(int position)
                                        throws InvalidArgumentException,
                                               ManagementException

Get the current state of a SIP address in the external platform definition managed by this MBean.

Parameters:

position - the list position of the address. This must be a value between 0 and one less than the number of SIP addresses currently present.

Returns:

the current state of the address.

Throws:

InvalidArgumentException - if an invalid position is specified.

ManagementException - if the current state of the address cannot be obtained due to a system-level failure.

addINAddress

void addINAddress(String address)
                  throws NullPointerException,
                         InvalidArgumentException,
                         DuplicateAddressException,
                         ManagementException

Add an IN address to the external platform definition managed by this MBean. The new address will be appended to the end of the current list of IN addresses for the external platform.

Any new address added to an external platform definition is assigned the ExternalAddressState.INACTIVE state.

Parameters:

address - the IN address. The address string must be formatted as described by SccpAddressParser

Throws:

NullPointerException - if address is null.

InvalidArgumentException - if the address is not a valid address.

DuplicateAddressException - if the address has already been added to this external platform definition.

ManagementException - if the address cannot be added due to a system-level failure.

addINAddress

void addINAddress(String address,
                int position)
                  throws NullPointerException,
                         InvalidArgumentException,
                         DuplicateAddressException,
                         ManagementException

Add an IN address to the external platform definition managed by this MBean. The new address will be inserted into the current list of IN addresses for the external platform at the specified position.

Any new address added to an external platform definition is assigned the ExternalAddressState.INACTIVE state.

Parameters:

address - the IN address. The address string must be formatted as described by SccpAddressParser

position - the list position to insert the address. A value less than or equal to zero inserts the new address at the beginning of the list. A value greater than or equal to the current number of addresses adds the new address to the end of the list.

Throws:

NullPointerException - if address is null.

InvalidArgumentException - if the address is not a valid address.

DuplicateAddressException - if the address has already been added to this external platform definition.

ManagementException - if the address cannot be added due to a system-level failure.

removeINAddress

void removeINAddress(int position)
                     throws InvalidArgumentException,
                            ManagementException

Remove an IN address from the external platform definition managed by this MBean.

Parameters:

position - the list position of the address to remove.. This must be a value between 0 and one less than the number of IN addresses currently present.

Throws:

InvalidArgumentException - if an invalid position is specified.

ManagementException - if the address cannot be removed due to a system-level failure.

activateINAddress

void activateINAddress(int position)
                       throws InvalidArgumentException,
                              InvalidStateException,
                              ManagementException

Activate an IN address in the external platform definition managed by this MBean. An external address must be activated before the SIS will consider sending any traffic to it.

Parameters:

position - the list position of the address to activate. This must be a value between 0 and one less than the number of IN addresses currently present.

Throws:

InvalidArgumentException - if an invalid position is specified.

InvalidStateException - if the address is already in the ACTIVE state.

ManagementException - if the address cannot be activated due to a system-level failure.

deactivateINAddress

void deactivateINAddress(int position)
                         throws InvalidArgumentException,
                                InvalidStateException,
                                ManagementException

Deactivate an IN address in the external platform definition managed by this MBean.

Parameters:

position - the list position of the address to deactivate. This must be a value between 0 and one less than the number of IN addresses currently present.

Throws:

InvalidArgumentException - if an invalid position is specified.

InvalidStateException - if the address is already in the INACTIVE state.

ManagementException - if the address cannot be activated due to a system-level failure.

repairINAddress

void repairINAddress(int position)
                     throws InvalidArgumentException,
                            InvalidStateException,
                            ManagementException

Reactivate a failed IN address in the external platform definition managed by this MBean. This operation is provided so that administrators can manually restore a failed address to active state, bypassing the SIS's retry attempts. Alarms for the failed address are cleared.

Parameters:

position - the list position of the address to reactivate. This must be a value between 0 and one less than the number of IN addresses currently present.

Throws:

InvalidArgumentException - if an invalid position is specified.

InvalidStateException - if the address is not in the FAILED state.

ManagementException - if the address cannot be reactivated due to a system-level failure.

getINAddressState

ExternalAddressState getINAddressState(int position)
                                       throws InvalidArgumentException,
                                              ManagementException

Get the current state of an IN address in the external platform definition managed by this MBean.

Parameters:

position - the list position of the address. This must be a value between 0 and one less than the number of IN addresses currently present.

Returns:

the current state of the address.

Throws:

InvalidArgumentException - if an invalid position is specified.

ManagementException - if the current state of the address cannot be obtained due to a system-level failure.

remove

void remove()
            throws DependencyException,
                   ManagementException

Remove the external platform definition managed by this MBean.

If this method returns without error, this MBean will be deregistered from the MBean Server.

Throws:

DependencyException - if the external platform definition cannot currently be removed due to an external service reference dependency on it.

ManagementException - if the external platform definition could not be removed due to a system-level failure.

getPlatformConfig

ExternalPlatformConfig getPlatformConfig()
                                         throws ManagementException

Get the ExternalPlatformConfig object describing the configuration of the external platform definition

Returns:

the platform configuration

Throws:

ManagementException - if the value could not be obtained due to a system-level failure.

setPlatformConfig

void setPlatformConfig(ExternalPlatformConfig config)
                       throws InvalidArgumentException,
                              ManagementException

Update the configuration of this external platform definition.

Parameters:

config - an ExternalPlatformConfig object containing the new configuration

Throws:

InvalidArgumentException - if any attributes of the configuration are invalid

ManagementException - if the external platform definition could not be updated due to a system-level failure.