org.springframework.jmx.support
Class MBeanServerConnectionFactoryBean

java.lang.Object
  org.springframework.jmx.support.MBeanServerConnectionFactoryBean

All Implemented Interfaces:

DisposableBean, FactoryBean, InitializingBean

public class MBeanServerConnectionFactoryBean
extends Object
implements FactoryBean, InitializingBean, DisposableBean

FactoryBean implementation that creates an MBeanServerConnection to a remote MBeanServer exposed via a JMXServerConnector. Exposes the MBeanServer for bean references.

Since:

1.2

Author:

Rob Harrop, Juergen Hoeller

See Also:

MBeanServerFactoryBean, ConnectorServerFactoryBean

Constructor Summary

MBeanServerConnectionFactoryBean()

Method Summary

void	afterPropertiesSet() Creates a JMXConnector for the given settings and exposes the associated MBeanServerConnection.
void	destroy() Closes the underlying JMXConnector.
Object	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
Class	getObjectType() Return the type of object that this FactoryBean creates, or null if not known in advance.
boolean	isSingleton() Is the bean managed by this factory a singleton or a prototype?
void	setConnectOnStartup(boolean connectOnStartup) Set whether to connect to the server on startup.
void	setEnvironment(Properties environment) Set the environment properties used to construct the JMXConnector as java.util.Properties (String key/value pairs).
void	setEnvironmentMap(Map environment) Set the environment properties used to construct the JMXConnector as a Map of String keys and arbitrary Object values.
void	setServiceUrl(String url) Set the service URL of the remote MBeanServer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MBeanServerConnectionFactoryBean

public MBeanServerConnectionFactoryBean()

Method Detail

setServiceUrl

public void setServiceUrl(String url)
                   throws MalformedURLException

Set the service URL of the remote MBeanServer.

Throws:

MalformedURLException

setEnvironment

public void setEnvironment(Properties environment)

Set the environment properties used to construct the JMXConnector as java.util.Properties (String key/value pairs).

setEnvironmentMap

public void setEnvironmentMap(Map environment)

Set the environment properties used to construct the JMXConnector as a Map of String keys and arbitrary Object values.

setConnectOnStartup

public void setConnectOnStartup(boolean connectOnStartup)

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.

afterPropertiesSet

public void afterPropertiesSet()
                        throws IOException

Creates a JMXConnector for the given settings and exposes the associated MBeanServerConnection.

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

IOException

getObject

public Object getObject()

Description copied from interface: FactoryBean

Return an instance (possibly shared or independent) of the object managed by this factory. As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

If this method returns null, the factory will consider the FactoryBean as not fully initialized and throw a corresponding FactoryBeanNotInitializedException.

Specified by:

getObject in interface FactoryBean

Returns:

an instance of the bean (should not be null; a null value will be considered as an indication of incomplete initialization)

See Also:

FactoryBeanNotInitializedException

getObjectType

public Class getObjectType()

Description copied from interface: FactoryBean

Return the type of object that this FactoryBean creates, or null if not known in advance. This allows to check for specific types of beans without instantiating objects, for example on autowiring.

For a singleton, this should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

NOTE: Autowiring will simply ignore FactoryBeans that return null here. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.

Specified by:

getObjectType in interface FactoryBean

Returns:

the type of object that this FactoryBean creates, or null if not known at the time of the call

See Also:

ListableBeanFactory.getBeansOfType(java.lang.Class)

isSingleton

public boolean isSingleton()

Description copied from interface: FactoryBean

Is the bean managed by this factory a singleton or a prototype? That is, will getObject() always return the same object (a reference that can be cached)?

NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

Specified by:

isSingleton in interface FactoryBean

Returns:

if this bean is a singleton

See Also:

FactoryBean.getObject()

destroy

public void destroy()
             throws IOException

Closes the underlying JMXConnector.

Specified by:

destroy in interface DisposableBean

Throws:

IOException