com.opencloud.sipservlet.management

Interface NetworkInterfaceDefinitionMXBean

public interface NetworkInterfaceDefinitionMXBean

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Get the name of this interface.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Get this network interface's properties as a map.
void	remove() Remove this network interface from the SIP Servlet RA.
void	updateProperties(java.util.Map<java.lang.String,java.lang.String> properties) Update this network interface definition's properties.

Field Detail

TYPE

static final java.lang.String TYPE

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                  throws javax.slee.management.ManagementException

Get the name of this interface. This is the name that was specified when the interface was created.

Returns:

the interface name.

Throws:

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

getProperties

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

Get this network interface's properties as a map.

Returns:

a map of property names and values.

Throws:

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

updateProperties

void updateProperties(java.util.Map<java.lang.String,java.lang.String> properties)
               throws java.lang.NullPointerException,
                      javax.slee.resource.InvalidConfigurationException,
                      javax.slee.management.ManagementException

Update this network interface definition's properties.

Parameters:

properties - a map of property names and values. The properties in this map replace all existing properties on the network interface.

Throws:

java.lang.NullPointerException - if properties is null.

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 update could not be completed due to a system-level failure.

remove

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

Remove this network interface from the SIP Servlet RA.

Throws:

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.