Class AbstractMXBean

  • Direct Known Subclasses:
    DelegatingSystemReadyMonitorMXBean

    public abstract class AbstractMXBean
    extends Object
    This class is inspired from the original implementation in controller.
    Author:
    Thomas Pantelis, Faseela K
    • Constructor Detail

      • AbstractMXBean

        protected AbstractMXBean​(@NonNull String mbeanName,
                                 @NonNull String mbeanType,
                                 @Nullable String mbeanCategory)
        Constructor.
        Parameters:
        mbeanName - Used as the name property in the bean's ObjectName.
        mbeanType - Used as the type property in the bean's ObjectName.
        mbeanCategory - Used as the Category property in the bean's ObjectName.
    • Method Detail

      • register

        public void register()
        This method is a wrapper for registerMBean with void return type so it can be invoked by dependency injection frameworks such as Spring and Blueprint.
      • registerMBean

        public final boolean registerMBean()
        Registers this bean with the platform MBean server with the domain defined by BASE_JMX_PREFIX.
        Returns:
        true is successfully registered, false otherwise.
      • unregister

        public void unregister()
        This method is a wrapper for unregisterMBean with void return type so it can be invoked by dependency injection frameworks such as Spring and Blueprint.
      • unregisterMBean

        public boolean unregisterMBean()
        Unregisters this bean with the platform MBean server.
        Returns:
        true is successfully unregistered, false otherwise.
      • invokeMBeanFunction

        public Object invokeMBeanFunction​(String functionName)
        invoke an mbean function with the platform MBean server.
        Returns:
        Object if successfully executed, "" otherwise.
      • readMBeanAttribute

        public Object readMBeanAttribute​(String attribute)
        Read an mbean attribute from the platform MBean server.
        Returns:
        Object if successfully executed, "" otherwise.
      • getMBeanName

        public String getMBeanName()
        Returns the name property of the bean's ObjectName.
      • getMBeanType

        public String getMBeanType()
        Returns the type property of the bean's ObjectName.
      • getMBeanCategory

        public @Nullable String getMBeanCategory()
        Returns the Category property of the bean's ObjectName.