Package com.opencloud.rhino.management.resource

Interface ResourceUsageMBean

    • Field Detail

      • NAMESPACE_KEY

        static final String NAMESPACE_KEY

        The JMX Object Name property key that identifies the namespace that the Resource Usage MBean belongs to. This key is equal to the string "namespace". This key is only present in the Object Name if the Resource Usage MBean resides in a user-defined namespace, rather than the default namespace. The value of this key, if present, is the quoted name of the namespace.

        Since:
        Rhino 2.5.0
        See Also:
        Constant Field Values

    • Method Detail

      • getUsageMBean

        ObjectName getUsageMBean​(int nodeID)
                  throws ManagementException

        Get the JMX Object Name of a UsageMBean object that provides management access to the unnamed usage parameter set on the specified node for the resource adaptor entity that this MBean is providing usage management access for.

        When using the savanna clustering mode, the Usage MBean referenced by the Object Name returned by this method will operate only on the usage state stored by the specified node, in contrast to the Usage MBean referenced by ResourceUsageMBean.getUsageMBean() which will operate on and/or aggregate usage state from the entire cluster.

        When using the pool clustering mode, a Usage MBean will only operate on the usage state stored by the node the management client directs this method call at, as determined by RhinoHousekeepingMBean.getNodeID(). This method can only be used to obtain the Object Name of a Usage MBean for this node, and specifying any other node ID as an argument to this method will result in a ManagementException being thrown. As such, when using the pool clustering mode, the Usage MBean referenced by ResourceUsageMBean.getUsageMBean() and the Usage MBean referenced by this method for this node exhibit the same state and behaviour.

        The Usage MBean referenced by the Object Name does not emit usage notifications. Usage notifications are only emitted by the Usage MBean referenced by ResourceUsageMBean.getUsageMBean().

        Parameters:
        nodeID - the node ID of the node whose usage state should be accessed by the Usage MBean.
        Returns:
        the Object Name of a UsageMBean object for the unnamed usage parameter set for the resource adaptor entity.
        Throws:
        ManagementException - if the Object Name could not be obtained due to a system-level failure, or if the pool clustering mode is being used and nodeID is not equal to this node’s ID.

      • getUsageMBean

        ObjectName getUsageMBean​(String paramSetName,
                         int nodeID)
                  throws NullPointerException,
                         UnrecognizedUsageParameterSetNameException,
                         ManagementException

        Get the JMX Object Name of a UsageMBean object that provides management access to the named usage parameter set on the specified node for the resource adaptor entity that this MBean is providing usage management access for.

        When using the savanna clustering mode, the Usage MBean referenced by the Object Name returned by this method will operate only on the usage state stored by the specified node, in contrast to the Usage MBean referenced by getUsageMBean(String) which will operate on and/or aggregate usage state from the entire cluster.

        When using the pool clustering mode, a Usage MBean will only operate on the usage state stored by the node the management client directs this method call at, as determined by RhinoHousekeepingMBean.getNodeID(). This method can only be used to obtain the Object Name of a Usage MBean for this node, and specifying any other node ID as an argument to this method will result in a ManagementException being thrown. As such, when using the pool clustering mode, the Usage MBean referenced by getUsageMBean(String) and the Usage MBean referenced by this method for this node exhibit the same state and behaviour.

        The Usage MBean referenced by the Object Name does not emit usage notifications. Usage notifications are only emitted by the Usage MBean referenced by getUsageMBean(String).

        Parameters:
        paramSetName - the name of the usage parameter set. The name must be one of the names returned by ResourceUsageMBean.getUsageParameterSets().
        nodeID - the node ID of the node whose usage state should be accessed by the Usage MBean.
        Returns:
        the Object Name of a UsageMBean object for the named usage parameter set for the resource adaptor entity.
        Throws:
        NullPointerException - if paramSetName is null.
        UnrecognizedUsageParameterSetNameException - if the named usage parameter set has not been created for the resource adaptor entity.
        ManagementException - if the Object Name could not be obtained due to a system-level failure, or if the pool clustering mode is being used and nodeID is not equal to this node’s ID.

      • getUsageParametersInterfaceTypes

        String[] getUsageParametersInterfaceTypes()
                                   throws ManagementException

        Get the names of the usage parameters interface types that resource adaptor of the resource adaptor entity that this MBean is providing usage management access for has declared. This method only returns a non zero-length result if the resource adaptor has declared usage parameter interfaces using the Rhino extension mechanism.

        Returns:
        the names of the usage parameters interface types that the resource adaptor has declared.
        Throws:
        ManagementException - if the names could not be obtained due to a system-level failure.
        Since:
        Rhino 2.4.0