Interface AMXMBeanInterface

  • All Known Implementing Classes:
    AMXClient, AMXImpl

    @ManagedObject
    @Description("Base interface for any MBean that works in the AMX framework")
    public interface AMXMBeanInterface
    Base interface supported by all AMXMBeanInterface MBeans. All MBeans generated by gmbal comply with this interface, which means that the attributes and operations defined in this Java interface all appear in each MBean generated by calling ManagedObjectManager.register.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      AMXMBeanInterface[] getChildren()
      Containment hierarchy: Get all AMXMBeanInterface contained by this one, in no particular order.
      java.util.Map<java.lang.String,​?> getMeta()
      Get all metadata about this MBean.
      java.lang.String getName()
      Usually the same as the ObjectName 'name' property, but can differ if the actual name contains characters that must be escaped for an ObjectName and/or if the MBean has a mutable name attribute.
      AMXMBeanInterface getParent()
      "go up one level": the MBean containing this one, can be null for root
    • Method Detail

      • getMeta

        java.util.Map<java.lang.String,​?> getMeta()
        Get all metadata about this MBean.
        Returns:
        The descriptor, which will be a ModelMBeanInfoSupport instance.
      • getName

        @ManagedAttribute(id="Name")
        @Description("Return the name of this MBean.")
        java.lang.String getName()
        Usually the same as the ObjectName 'name' property, but can differ if the actual name contains characters that must be escaped for an ObjectName and/or if the MBean has a mutable name attribute. The type property can be obtained from the ObjectName
      • getParent

        @ManagedAttribute(id="Parent")
        @Description("The container that contains this MBean")
        AMXMBeanInterface getParent()
        "go up one level": the MBean containing this one, can be null for root
        Returns:
        The container of this MBean (null if already at root).
      • getChildren

        @ManagedAttribute(id="Children")
        @Description("All children of this AMX MBean")
        AMXMBeanInterface[] getChildren()
        Containment hierarchy: Get all AMXMBeanInterface contained by this one, in no particular order. Valid only if isContainer(). Note that using an array sidesteps Map/Set/OpenType issues
        Returns:
        All children of this AMXMBeanInterface MBean.