Interface NetworkInterfaceDefinitionMBean


  • public interface NetworkInterfaceDefinitionMBean
    Management interface for querying and updating a network interface definition in the SIS.
    • 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.
      • 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.
        • _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.