Interface UsageMBean

  • All Superinterfaces:
    UsageMBean

    public interface UsageMBean
    extends UsageMBean

    Rhino extensions to SLEE Usage MBeans.

    • Field Detail

      • NAMESPACE_KEY

        static final String NAMESPACE_KEY

        The JMX Object Name property key that identifies the namespace that the Usage MBean belongs to. This key is equal to the string "namespace". This key is only present in the Object Name if the 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
      • NODE_ID_KEY

        static final String NODE_ID_KEY

        The JMX Object Name property key that identifies the node ID of the node that the Usage MBean is providing usage information for. This key is equal to the string "nodeID". This key is only present in the Object Name if the Usage MBean is providing access to a single node’s usage state only, rather than cluster-wide state. The value of this key, if present, is the node ID.

        See Also:
        Constant Field Values
    • Method Detail

      • getNamespace

        String getNamespace()

        Get the namespace that the usage parameters managed by this Usage MBean reside in.

        Returns:
        the namespace, or null if the usage parameters reside in the default namespace.
      • getUsageParametersInterfaceType

        String getUsageParametersInterfaceType()
                                        throws ManagementException

        Get the usage parameters interface type of the usage parameter set managed by this Usage MBean.

        This method only returns a non-null value if the usage parameters interface was declared using the Rhino extension mechanism.

        Returns:
        the usage parameters interface type name, or null if the usage parameters interface was declared using the standard SLEE mechanism.
        Throws:
        ManagementException - if a system-level failure occurs.
        Since:
        Rhino 2.4.0
      • tabulateAll

        TabularData tabulateAll​(boolean reset)
                         throws ManagementException

        Get the values of all usage parameters in the usage parameter set managed by this Usage MBean.

        This method returns tabular data with the following structure:

        Field Open Type Description

        parameter-name

        String

        The name of the usage parameter.

        type

        String

        The type of the usage parameter. The value of this field is either "counter" or "sample".

        counter-value

        Long

        The value for a counter-type usage parameter. This value is null for sample-type usage parameters.

        sample-stats

        CompositeType (see below)

        The sample stats for a sample-type usage parameter. This value is null for counter-type usage parameters.

        Sample statistics are reported within the tabular data above using a composite type with the following structure:

        Field Open Type Description

        sample-count

        Long

        The number of samples recorded for the usage parameter since either the service was deployed or the usage parameter was last reset (whichever occurred most recently).

        min

        Long

        The minimum recorded value of the counted samples.

        max

        Long

        The maximum recorded value of the counted samples.

        mean

        Double

        The mean value of counted samples.

        Parameters:
        reset - if true each usage parameter is reset once its value is obtained.
        Returns:
        Tabulated values for all usage parameters in the usage parameter set managed by this Usage MBean.
        Throws:
        ManagementException - if the values of the usage parameters could not be obtained due to a system-level failure.