com.opencloud.slee.resources.sis.management

Interface NetworkInterfaceDefinitionMBean

public interface NetworkInterfaceDefinitionMBean

Management interface for querying and updating a network interface definition in the SIS.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SIS_MANAGEMENT_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
CompositeData	getDescriptor() Get a JMX CompositeData object describing the properties that are currently configured on this interface.
String	getName() Get the name of this interface.
Map<String,String>	getProperties() Get this network interface's properties as a map.
NetworkInterfaceType	getType() Get the type of this interface.
void	remove() Remove this network interface from the SIS.
void	updateProperties(Map<String,String> properties) Update this network interface definition's properties.

Field Detail

SIS_MANAGEMENT_TYPE

static final String SIS_MANAGEMENT_TYPE

See Also:

Constant Field Values

Method Detail

getName

String getName()
               throws ManagementException

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

Returns:

the interface name.

Throws:

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

getType

NetworkInterfaceType getType()
                             throws ManagementException

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

Returns:

the interface type.

Throws:

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

getDescriptor

CompositeData getDescriptor()
                            throws ManagementException

Get a JMX CompositeData object describing the properties that are currently configured on this interface.

The CompositeData object returned is dynamic and contains a String field for each property currently set on the interface. The field names may be obtained by inspecting the CompositeData object's type.

There are several automatically generated fields that cannot be directly updated by clients:

• _name_: contains this interface's name. This is set when the interface is created and cannot be changed.
• _type_: contains the string value of this interface's network type, "IN" or "SIP". This is set when the interface is created and cannot be changed.
• _owner_: contains the name of the SIS instance that this interface is currently enabled on, if any. This can only be changed by enabling or disabling the network interface.

Attempting to set properties that use the above names will fail with InvalidArgumentException.

Returns:

a CompositeData object as described above.

Throws:

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

getProperties

Map<String,String> getProperties()
                                 throws ManagementException

Get this network interface's properties as a map.

Returns:

a map of property names and values.

Throws:

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

updateProperties

void updateProperties(Map<String,String> properties)
                      throws NullPointerException,
                             InvalidArgumentException,
                             InvalidConfigurationException,
                             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:

NullPointerException - if properties is null.

InvalidArgumentException - if the interface properties use any restricted names (see getDescriptor()).

InvalidConfigurationException - if the SIS instance determines that the network interface configuration is not valid.

ManagementException - if the update could not be completed due to a system-level failure.

remove

void remove()
            throws InvalidStateException,
                   ManagementException

Remove this network interface from the SIS.

Throws:

InvalidStateException - if the interface cannot be removed because it is enabled on a SIS instance.

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