org.springframework.jmx.support.MBeanServerConnectionFactoryBean Maven / Gradle / Ivy
/*
* Copyright 2002-2007 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.jmx.support;
import java.io.IOException;
import java.net.MalformedURLException;
import java.util.Map;
import java.util.Properties;
import javax.management.MBeanServerConnection;
import javax.management.remote.JMXConnector;
import javax.management.remote.JMXConnectorFactory;
import javax.management.remote.JMXServiceURL;
import org.springframework.aop.TargetSource;
import org.springframework.aop.framework.ProxyFactory;
import org.springframework.aop.target.AbstractLazyCreationTargetSource;
import org.springframework.beans.factory.BeanClassLoaderAware;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.util.ClassUtils;
/**
* FactoryBean implementation that creates an MBeanServerConnection
* to a remote MBeanServer exposed via a JMXServerConnector.
* Exposes the MBeanServer for bean references.
*
* @author Rob Harrop
* @author Juergen Hoeller
* @since 1.2
* @see MBeanServerFactoryBean
* @see ConnectorServerFactoryBean
*/
public class MBeanServerConnectionFactoryBean
implements FactoryBean, BeanClassLoaderAware, InitializingBean, DisposableBean {
private JMXServiceURL serviceUrl;
private Map environment;
private boolean connectOnStartup = true;
private ClassLoader beanClassLoader = ClassUtils.getDefaultClassLoader();
private JMXConnector connector;
private MBeanServerConnection connection;
private JMXConnectorLazyInitTargetSource connectorTargetSource;
/**
* Set the service URL of the remote MBeanServer.
*/
public void setServiceUrl(String url) throws MalformedURLException {
this.serviceUrl = new JMXServiceURL(url);
}
/**
* Set the environment properties used to construct the JMXConnector
* as java.util.Properties (String key/value pairs).
*/
public void setEnvironment(Properties environment) {
this.environment = environment;
}
/**
* Set the environment properties used to construct the JMXConnector
* as a Map of String keys and arbitrary Object values.
*/
public void setEnvironmentMap(Map environment) {
this.environment = environment;
}
/**
* Set whether to connect to the server on startup. Default is "true".
* Can be turned off to allow for late start of the JMX server.
* In this case, the JMX connector will be fetched on first access.
*/
public void setConnectOnStartup(boolean connectOnStartup) {
this.connectOnStartup = connectOnStartup;
}
public void setBeanClassLoader(ClassLoader classLoader) {
this.beanClassLoader = classLoader;
}
/**
* Creates a JMXConnector for the given settings
* and exposes the associated MBeanServerConnection.
*/
public void afterPropertiesSet() throws IOException {
if (this.serviceUrl == null) {
throw new IllegalArgumentException("serviceUrl is required");
}
if (this.connectOnStartup) {
connect();
}
else {
createLazyConnection();
}
}
/**
* Connects to the remote MBeanServer using the configured service URL and
* environment properties.
*/
private void connect() throws IOException {
this.connector = JMXConnectorFactory.connect(this.serviceUrl, this.environment);
this.connection = this.connector.getMBeanServerConnection();
}
/**
* Creates lazy proxies for the JMXConnector and MBeanServerConnection
*/
private void createLazyConnection() {
this.connectorTargetSource = new JMXConnectorLazyInitTargetSource();
TargetSource connectionTargetSource = new MBeanServerConnectionLazyInitTargetSource();
this.connector = (JMXConnector)
new ProxyFactory(JMXConnector.class, this.connectorTargetSource).getProxy(this.beanClassLoader);
this.connection = (MBeanServerConnection)
new ProxyFactory(MBeanServerConnection.class, connectionTargetSource).getProxy(this.beanClassLoader);
}
public Object getObject() {
return this.connection;
}
public Class getObjectType() {
return (this.connection != null ? this.connection.getClass() : MBeanServerConnection.class);
}
public boolean isSingleton() {
return true;
}
/**
* Closes the underlying JMXConnector.
*/
public void destroy() throws IOException {
if (this.connectorTargetSource == null || this.connectorTargetSource.isInitialized()) {
this.connector.close();
}
}
/**
* Lazily creates a JMXConnector using the configured service URL
* and environment properties.
* @see MBeanServerConnectionFactoryBean#setServiceUrl(String)
* @see MBeanServerConnectionFactoryBean#setEnvironment(java.util.Properties)
*/
private class JMXConnectorLazyInitTargetSource extends AbstractLazyCreationTargetSource {
protected Object createObject() throws Exception {
return JMXConnectorFactory.connect(serviceUrl, environment);
}
public Class getTargetClass() {
return JMXConnector.class;
}
}
/**
* Lazily creates an MBeanServerConnection.
*/
private class MBeanServerConnectionLazyInitTargetSource extends AbstractLazyCreationTargetSource {
protected Object createObject() throws Exception {
return connector.getMBeanServerConnection();
}
public Class getTargetClass() {
return MBeanServerConnection.class;
}
}
}