Class LifecycleMBeanBase

    • Field Detail

      • mserver

        @Deprecated
        protected javax.management.MBeanServer mserver
        Deprecated.
    • Constructor Detail

      • LifecycleMBeanBase

        public LifecycleMBeanBase()
    • Method Detail

      • setDomain

        public final void setDomain​(java.lang.String domain)
        Description copied from interface: JmxEnabled
        Specify the domain under which this component should be registered. Used with components that cannot (easily) navigate the component hierarchy to determine the correct domain to use.
        Specified by:
        setDomain in interface JmxEnabled
        Parameters:
        domain - The name of the domain under which this component should be registered
      • getDomain

        public final java.lang.String getDomain()
        Specified by:
        getDomain in interface JmxEnabled
        Returns:
        the domain under which this component will be / has been registered.
      • getDomainInternal

        protected abstract java.lang.String getDomainInternal()
        Method implemented by sub-classes to identify the domain in which MBeans should be registered.
        Returns:
        The name of the domain to use to register MBeans.
      • getObjectName

        public final javax.management.ObjectName getObjectName()
        Specified by:
        getObjectName in interface JmxEnabled
        Returns:
        the name under which this component has been registered with JMX.
      • getObjectNameKeyProperties

        protected abstract java.lang.String getObjectNameKeyProperties()
        Allow sub-classes to specify the key properties component of the ObjectName that will be used to register this component.
        Returns:
        The string representation of the key properties component of the desired ObjectName
      • register

        protected final javax.management.ObjectName register​(java.lang.Object obj,
                                                             java.lang.String objectNameKeyProperties)
        Utility method to enable sub-classes to easily register additional components that don't implement JmxEnabled with an MBean server.
        Note: This method should only be used once initInternal() has been called and before destroyInternal() has been called.
        Parameters:
        obj - The object the register
        objectNameKeyProperties - The key properties component of the object name to use to register the object
        Returns:
        The name used to register the object
      • unregister

        protected final void unregister​(java.lang.String objectNameKeyProperties)
        Utility method to enable sub-classes to easily unregister additional components that don't implement JmxEnabled with an MBean server.
        Note: This method should only be used once initInternal() has been called and before destroyInternal() has been called.
        Parameters:
        objectNameKeyProperties - The key properties component of the object name to use to unregister the object
      • unregister

        protected final void unregister​(javax.management.ObjectName on)
        Utility method to enable sub-classes to easily unregister additional components that don't implement JmxEnabled with an MBean server.
        Note: This method should only be used once initInternal() has been called and before destroyInternal() has been called.
        Parameters:
        on - The name of the component to unregister
      • postDeregister

        public final void postDeregister()
        Not used - NOOP.
        Specified by:
        postDeregister in interface javax.management.MBeanRegistration
      • postRegister

        public final void postRegister​(java.lang.Boolean registrationDone)
        Not used - NOOP.
        Specified by:
        postRegister in interface javax.management.MBeanRegistration
      • preDeregister

        public final void preDeregister()
                                 throws java.lang.Exception
        Not used - NOOP.
        Specified by:
        preDeregister in interface javax.management.MBeanRegistration
        Throws:
        java.lang.Exception
      • preRegister

        public final javax.management.ObjectName preRegister​(javax.management.MBeanServer server,
                                                             javax.management.ObjectName name)
                                                      throws java.lang.Exception
        Specified by:
        preRegister in interface javax.management.MBeanRegistration
        Throws:
        java.lang.Exception