org.springframework.jmx.support
Class MBeanServerFactoryBean

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

All Implemented Interfaces:

DisposableBean, FactoryBean, InitializingBean

public class MBeanServerFactoryBean
extends Object
implements FactoryBean, InitializingBean, DisposableBean

FactoryBean that obtains an MBeanServer instance through the standard JMX 1.2 MBeanServerFactory API (which is available on JDK 1.5 or as part of a JMX 1.2 provider).

Exposes the MBeanServer for bean references.

Since:

1.2

Author:

Rob Harrop, Juergen Hoeller

See Also:

MBeanServerFactory.createMBeanServer(), MBeanServerFactory.newMBeanServer(), MBeanServerConnectionFactoryBean, ConnectorServerFactoryBean

Constructor Summary

MBeanServerFactoryBean()

Method Summary

void	afterPropertiesSet() Creates the MBeanServer instance.
void	destroy() Unregisters the MBeanServer instance, if necessary.
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	setDefaultDomain(String defaultDomain) Set the default domain to be used by the MBeanServer, to be passed to MBeanServerFactory.createMBeanServer() or MBeanServerFactory.findMBeanServer().
void	setRegisterWithFactory(boolean registerWithFactory) Setting this value to true will cause the MBeanServer to be created with a call to MBeanServerFactory.createMBeanServer(), and thus it will be possible to retrieve a reference to the MBeanServer using MBeanServerFactory.findMBeanServer().

Methods inherited from class java.lang.Object

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

Constructor Detail

MBeanServerFactoryBean

public MBeanServerFactoryBean()

Method Detail

setRegisterWithFactory

public void setRegisterWithFactory(boolean registerWithFactory)

Setting this value to true will cause the MBeanServer to be created with a call to MBeanServerFactory.createMBeanServer(), and thus it will be possible to retrieve a reference to the MBeanServer using MBeanServerFactory.findMBeanServer().

See Also:

MBeanServerFactory.createMBeanServer(), MBeanServerFactory.findMBeanServer(java.lang.String)

setDefaultDomain

public void setDefaultDomain(String defaultDomain)

Set the default domain to be used by the MBeanServer, to be passed to MBeanServerFactory.createMBeanServer() or MBeanServerFactory.findMBeanServer().

Default is none.

See Also:

MBeanServerFactory.createMBeanServer(String), MBeanServerFactory.findMBeanServer(String)

afterPropertiesSet

public void afterPropertiesSet()

Creates the MBeanServer instance.

Specified by:

afterPropertiesSet in interface InitializingBean

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?

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

destroy

public void destroy()

Unregisters the MBeanServer instance, if necessary.

Specified by:

destroy in interface DisposableBean