io.hawt.util.MBeanSupport Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hawtio-system Show documentation
hawtio :: hawtio-system
The newest version!
package io.hawt.util;

import java.lang.management.ManagementFactory;

import javax.management.InstanceAlreadyExistsException;
import javax.management.MBeanServer;
import javax.management.ObjectInstance;
import javax.management.ObjectName;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * A helpful base class for MBeans
 */
public abstract class MBeanSupport {
    private static final Logger LOG = LoggerFactory.getLogger(MBeanSupport.class);

    private ObjectName objectName;
    private ObjectInstance objectInstance;
    private MBeanServer mBeanServer;
    private boolean registered;

    public void init() throws Exception {
        // let's check if we have a config directory if not lets create one...
        // now lets expose the mbean...
        if (objectName == null) {
            objectName = new ObjectName(getDefaultObjectName());
        }
        if (mBeanServer == null) {
            mBeanServer = ManagementFactory.getPlatformMBeanServer();
        }
        if (!registered && !mBeanServer.isRegistered(objectName)) {
            try {
                objectInstance = mBeanServer.registerMBean(this, objectName);
            } catch (InstanceAlreadyExistsException iaee) {
                // Try to remove and re-register
                LOG.warn("This mbean is already registered " + objectName + ". There must be multiple deployment units with this mbean inside.");
                /*
                mBeanServer.unregisterMBean(objectName);
                mBeanServer.registerMBean(this, objectName);
                */
            }
            registered = true;
        }
    }

    public void destroy() throws Exception {
        if (registered && objectName != null && mBeanServer != null) {
            registered = false;
            try {
                // favor object name from object instance as some containers may use special naming
                if (objectInstance != null && objectInstance.getObjectName() != null) {
                    mBeanServer.unregisterMBean(objectInstance.getObjectName());
                } else {
                    mBeanServer.unregisterMBean(objectName);
                }
            } catch (Exception e) {
                LOG.debug("Error unregistering mbean " + objectName + ". This exception is ignored.", e);
            }
        }
    }

    public MBeanServer getMBeanServer() {
        return mBeanServer;
    }

    public void setMBeanServer(MBeanServer mBeanServer) {
        this.mBeanServer = mBeanServer;
    }

    public ObjectName getObjectName() {
        return objectName;
    }

    public void setObjectName(ObjectName objectName) {
        this.objectName = objectName;
    }

    protected abstract String getDefaultObjectName();
}