com.j256.simplejmx.spring.BeanPublisher Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of simplejmx Show documentation
Simple JMX Classes
There is a newer version: 2.2
package com.j256.simplejmx.spring;

import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import javax.management.ObjectName;

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Required;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;

import com.j256.simplejmx.common.JmxResource;
import com.j256.simplejmx.common.JmxSelfNaming;
import com.j256.simplejmx.server.JmxServer;
import com.j256.simplejmx.server.PublishAllBeanWrapper;

/**
 * Utility class designed to be used with Spring which runs through and discovers any beans that need to be registered
 * with the {@link JmxServer}. This looks for beans that are of type {@link JmxBean}, that are of type
 * {@link PublishAllBeanWrapper}, that implement {@link JmxSelfNaming}, or that are annotated with {@link JmxResource},
 * 
 * 
 * NOTE: This will only compile if com.springframework jar(s) are available to the application. Otherwise it will
 * throw ClassNotFound exceptions if used.
 * 
 * 
 * @author graywatson
 */
public class BeanPublisher implements InitializingBean, ApplicationContextAware, DisposableBean {

	private ApplicationContext applicationContext;
	private JmxServer jmxServer;
	private Set registeredBeans = new HashSet();

	@Override
	public void afterPropertiesSet() throws Exception {
		// do the annotations
		Map beans = applicationContext.getBeansOfType(null);
		for (Object bean : beans.values()) {
			// this seems to happen with MethodInvokingFactoryBean and maybe others
			if (bean == null) {
				continue;
			}
			// we handle @JmxResource annotations or JmxSelfNaming
			ObjectName objectName = null;
			// check for more specific classes first
			if (bean instanceof JmxBean) {
				JmxBean jmxBean = (JmxBean) bean;
				objectName =
						jmxServer.register(jmxBean.getTarget(), jmxBean.getJmxResourceInfo(),
								jmxBean.getAttributeFieldInfos(), jmxBean.getAttributeMethodInfos(),
								jmxBean.getOperationInfos());
			} else if (bean instanceof PublishAllBeanWrapper) {
				objectName = jmxServer.register((PublishAllBeanWrapper) bean);
			} else if (bean instanceof JmxSelfNaming) {
				objectName = jmxServer.register((JmxSelfNaming) bean);
			} else if (bean.getClass().isAnnotationPresent(JmxResource.class)) {
				objectName = jmxServer.register(bean);
			}
			if (objectName != null) {
				registeredBeans.add(objectName);
			}
		}
	}

	@Override
	public void destroy() {
		for (ObjectName objectName : registeredBeans) {
			jmxServer.unregister(objectName);
		}
	}

	@Override
	@Required
	public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
		this.applicationContext = applicationContext;
	}

	@Required
	public void setJmxServer(JmxServer jmxServer) {
		this.jmxServer = jmxServer;
	}
}