com.opencloud.sipservlet.management

Interface NetworkInterfaceManagementMXBean

public interface NetworkInterfaceManagementMXBean

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE

Method Summary

Modifier and Type	Method and Description
NetworkRouteMXBean	addDefaultRoute(java.lang.String interfaceName) Add a default route to the SIP Servlet RA.
NetworkRouteMXBean	addRoute(java.lang.String rule, java.lang.String interfaceName, int position) Add a new network route to the SIP Servlet RA.
NetworkInterfaceDefinitionMXBean	createNetworkInterfaceDefinition(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> properties) Create a new network interface definition in the SIP Servlet RA.
void	disableNetworkInterface(java.lang.String name) Disable the network interface on this SIP Servlet RA instance.
void	enableNetworkInterface(java.lang.String name) Enable the network interface on this SIP Servlet RA instance.
NetworkRouteMXBean	getDefaultRoute() Get the JMX Object Name for the default network route.
java.lang.String[]	getEnabledNetworkInterfaces() Get the interfaces that are currently enabled on this SIP Servlet RA instance.
NetworkInterfaceDefinitionMXBean	getNetworkInterfaceDefinition(java.lang.String name) Get the JMX Object Name for a network interface definition.
java.lang.String[]	getNetworkInterfaceDefinitions() Get the names of all network interfaces currently configured in the SIP Servlet RA.
NetworkRouteMXBean	getRoute(int position) Get the JMX Object Name for a network route.
RouteDescriptor[]	getRoutes() Get information about network routes in the RA.
java.util.Map<java.lang.String,java.lang.String>	getSupportedNetworkInterfaceProperties() Get the network interface properties that are supported by this SIP Servlet RA instance.
void	removeDefaultRoute() Remove a default route from the SIS.
void	removeNetworkInterfaceDefinition(java.lang.String name) Remove a network interface definition from the SIP Servlet RA.
void	removeRoute(int position) Remove an existing network route from the SIP Servlet RA.

Field Detail

TYPE

static final java.lang.String TYPE

See Also:

Constant Field Values

Method Detail

createNetworkInterfaceDefinition

NetworkInterfaceDefinitionMXBean createNetworkInterfaceDefinition(java.lang.String name,
                                                                  java.util.Map<java.lang.String,java.lang.String> properties)
                                                           throws java.lang.NullPointerException,
                                                                  javax.slee.management.AlreadyDeployedException,
                                                                  javax.slee.resource.InvalidConfigurationException,
                                                                  javax.slee.management.ManagementException

Create a new network interface definition in the SIP Servlet RA.

Parameters:

name - a unique name for the interface.

properties - a map of property names and values.

Returns:

the Object Name of a NetworkInterfaceDefinitionMXBean used to manage the network interface definition.

Throws:

java.lang.NullPointerException - if any argument is null.

javax.slee.management.AlreadyDeployedException - if an interface with the same name is already defined.

javax.slee.resource.InvalidConfigurationException - if the SIP Servlet RA instance determines that the network interface configuration is not valid.

javax.slee.management.ManagementException - if the interface could not be created due to a system-level failure.

getNetworkInterfaceDefinition

NetworkInterfaceDefinitionMXBean getNetworkInterfaceDefinition(java.lang.String name)
                                                        throws java.lang.NullPointerException,
                                                               javax.slee.UnrecognizedComponentException,
                                                               javax.slee.management.ManagementException

Get the JMX Object Name for a network interface definition.

Parameters:

name - the network interface name.

Returns:

the Object Name of a NetworkInterfaceDefinitionMXBean used to manage the network interface definition.

Throws:

java.lang.NullPointerException - if name is null.

javax.slee.UnrecognizedComponentException - if the interface name is not known.

javax.slee.management.ManagementException - if the Object Name for the interface could not be obtained due to a system-level failure.

removeNetworkInterfaceDefinition

void removeNetworkInterfaceDefinition(java.lang.String name)
                               throws java.lang.NullPointerException,
                                      javax.slee.UnrecognizedComponentException,
                                      javax.slee.InvalidStateException,
                                      javax.slee.management.ManagementException

Remove a network interface definition from the SIP Servlet RA.

Parameters:

name - the network interface name.

Throws:

java.lang.NullPointerException - if name is null.

javax.slee.UnrecognizedComponentException - if the interface name is not known.

javax.slee.InvalidStateException - if the interface cannot be removed because it is enabled on a SIP Servlet RA instance.

javax.slee.management.ManagementException - if the interface could not be removed due to a system-level failure.

getNetworkInterfaceDefinitions

java.lang.String[] getNetworkInterfaceDefinitions()
                                           throws javax.slee.management.ManagementException

Get the names of all network interfaces currently configured in the SIP Servlet RA.

Returns:

an array of network interface names, empty if no network interfaces exist.

Throws:

javax.slee.management.ManagementException - if the operation could not be completed due to a system-level failure.

enableNetworkInterface

void enableNetworkInterface(java.lang.String name)
                     throws java.lang.NullPointerException,
                            javax.slee.UnrecognizedComponentException,
                            javax.slee.InvalidStateException,
                            javax.slee.management.ManagementException

Enable the network interface on this SIP Servlet RA instance. Several interfaces may be enabled at the same time.

When this method is called, the SIP Servlet RA will verify the interface's properties, and throw InvalidConfigurationException if any properties are not valid.

The SIP Servlet RA does not necessarily begin using the interface immediately - it may be necessary to reactivate the SIP Servlet RA before it can use the interface. See the SIS implementation's documentation for more information.

Parameters:

name - the network interface name.

Throws:

java.lang.NullPointerException - if name is null.

javax.slee.UnrecognizedComponentException - if the interface name is not known.

javax.slee.InvalidStateException - if the interface is already enabled on this SIP Servlet RA instance; or if it is enabled on another SIP Servlet RA instance; or the SIP Servlet RA cannot enable the interface in its current state.

javax.slee.management.ManagementException - if the operation could not be completed due to a system-level failure.

disableNetworkInterface

void disableNetworkInterface(java.lang.String name)
                      throws java.lang.NullPointerException,
                             javax.slee.UnrecognizedComponentException,
                             javax.slee.InvalidStateException,
                             javax.slee.management.ManagementException

Disable the network interface on this SIP Servlet RA instance. The SIP Servlet RA does not necessarily stop using the interface immediately - it may be necessary to deactivate the SIP Servlet RA for it to stop using the interface. See the SIP Servlet RA implementation's documentation for more information.

Parameters:

name - the network interface name.

Throws:

java.lang.NullPointerException - if name is null.

javax.slee.UnrecognizedComponentException - if the interface name is not known.

javax.slee.InvalidStateException - if the SIP Servlet RA cannot disable the interface in its current state.

javax.slee.management.ManagementException - if the operation could not be completed due to a system-level failure.

getEnabledNetworkInterfaces

java.lang.String[] getEnabledNetworkInterfaces()
                                        throws javax.slee.management.ManagementException

Get the interfaces that are currently enabled on this SIP Servlet RA instance.

Returns:

an array of interface names, empty if no network interfaces are enabled on the SIS instance

Throws:

javax.slee.management.ManagementException - if the operation could not be completed due to a system-level failure.

getSupportedNetworkInterfaceProperties

java.util.Map<java.lang.String,java.lang.String> getSupportedNetworkInterfaceProperties()
                                                                                 throws javax.slee.management.ManagementException

Get the network interface properties that are supported by this SIP Servlet RA instance.

This method returns a map where each key is a supported property name, and the corresponding value is a String description of that property.

Returns:

a map of property names to property descriptions

Throws:

javax.slee.management.ManagementException - if the operation could not be completed due to a system-level failure.

addRoute

NetworkRouteMXBean addRoute(java.lang.String rule,
                            java.lang.String interfaceName,
                            int position)
                     throws java.lang.NullPointerException,
                            javax.slee.InvalidArgumentException,
                            javax.slee.UnrecognizedComponentException,
                            javax.slee.management.AlreadyDeployedException,
                            javax.slee.InvalidStateException,
                            javax.slee.management.ManagementException

Add a new network route to the SIP Servlet RA.

Rules are of the format "<type> [<value>]":

• For SIP, the rule type may be "ip", "domain", "regex", "all", or "none". If the rule type is "ip", "domain", or "regex", a value must be specified for the rule.

Parameters:

rule - the rule to match for this route to be selected.

interfaceName - the name of the network interface to be used if this route is selected.

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

Returns:

the Object Name of a NetworkRouteMXBean used to manage the network route.

Throws:

java.lang.NullPointerException - if rule or interfaceName is null.

javax.slee.InvalidArgumentException - if the rule is invalid.

javax.slee.UnrecognizedComponentException - if the interface name is not known.

javax.slee.management.AlreadyDeployedException - if an identical route already exists in the routing table.

javax.slee.InvalidStateException - if the specified network interface is not enabled on this SIP Servlet RA instance.

javax.slee.management.ManagementException - if the operation could not be completed due to a system-level failure.

getRoute

NetworkRouteMXBean getRoute(int position)
                     throws javax.slee.UnrecognizedComponentException,
                            javax.slee.management.ManagementException

Get the JMX Object Name for a network route.

Parameters:

position - the route list position to get.

Returns:

the Object Name of a NetworkRouteMXBean used to manage the network route.

Throws:

javax.slee.UnrecognizedComponentException - if a route does not exist in the specified position.

javax.slee.management.ManagementException - if the Object Name for the route could not be obtained due to a system-level failure.

removeRoute

void removeRoute(int position)
          throws javax.slee.InvalidArgumentException,
                 javax.slee.management.ManagementException

Remove an existing network route from the SIP Servlet RA.

Parameters:

position - the route list position to remove.

Throws:

javax.slee.InvalidArgumentException - if an invalid position is specified.

javax.slee.management.ManagementException - if the operation could not be completed due to a system-level failure.

addDefaultRoute

NetworkRouteMXBean addDefaultRoute(java.lang.String interfaceName)
                            throws java.lang.NullPointerException,
                                   javax.slee.UnrecognizedComponentException,
                                   javax.slee.management.AlreadyDeployedException,
                                   javax.slee.InvalidStateException,
                                   javax.slee.management.ManagementException

Add a default route to the SIP Servlet RA. At most one default route per network interface type can be specified at any one time.

Parameters:

interfaceName - the name of the network interface to be used for the default route.

Returns:

the the NetworkRouteMXBean used to manage the network route.

Throws:

java.lang.NullPointerException - if either argument is null.

javax.slee.UnrecognizedComponentException - if the interface name is not known.

javax.slee.management.AlreadyDeployedException - if a default route has already been specified for the network interface type.

javax.slee.InvalidStateException - if the specified network interface is not enabled on this SIS instance.

javax.slee.management.ManagementException - if the operation could not be completed due to a system-level failure.

getDefaultRoute

NetworkRouteMXBean getDefaultRoute()
                            throws javax.slee.UnrecognizedComponentException,
                                   javax.slee.management.ManagementException

Get the JMX Object Name for the default network route.

Returns:

the the NetworkRouteMXBean used to manage the network route.

Throws:

javax.slee.UnrecognizedComponentException - if a default route does not exist.

javax.slee.management.ManagementException - if the Object Name for the route could not be obtained due to a system-level failure.

removeDefaultRoute

void removeDefaultRoute()
                 throws javax.slee.InvalidStateException,
                        javax.slee.management.ManagementException

Remove a default route from the SIS.

Throws:

javax.slee.InvalidStateException - if a default route has not been specified for the network interface type.

javax.slee.management.ManagementException - if the operation could not be completed due to a system-level failure.

getRoutes

RouteDescriptor[] getRoutes()
                     throws javax.slee.management.ManagementException

Get information about network routes in the RA.

Returns:

an array of RouteDescriptor, ordered by position

Throws:

javax.slee.management.ManagementException - if the operation could not be completed due to a system-level failure.