Class MBeanServerConnectionFactoryBean

java.lang.Object
org.springframework.jmx.support.MBeanServerConnectionFactoryBean
All Implemented Interfaces:
Aware, BeanClassLoaderAware, DisposableBean, FactoryBean<MBeanServerConnection>, InitializingBean
public class MBeanServerConnectionFactoryBean extends Object implements FactoryBean<MBeanServerConnection>, BeanClassLoaderAware, InitializingBean, DisposableBean
FactoryBean that creates a JMX 1.2 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:

  • Constructor Details

    • MBeanServerConnectionFactoryBean

      public MBeanServerConnectionFactoryBean()

  • Method Details

    • 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(@Nullable Map<String,?> 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.

    • setBeanClassLoader

      public void setBeanClassLoader(ClassLoader classLoader)
      Description copied from interface: BeanClassLoaderAware
      Callback that supplies the bean class loader to a bean instance.

      Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean's InitializingBean.afterPropertiesSet() method or a custom init-method.

      Specified by:
      setBeanClassLoader in interface BeanClassLoaderAware
      Parameters:
      classLoader - the owning class loader

    • 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 @Nullable MBeanServerConnection 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 patterns.

      If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException.

      FactoryBeans are allowed to return null objects. The bean factory will consider this as a normal value to be used and will not throw a FactoryBeanNotInitializedException in this case. However, FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves, as appropriate.

      Specified by:
      getObject in interface FactoryBean<MBeanServerConnection>
      Returns:
      an instance of the bean (can be null)
      See Also:

    • getObjectType

      public Class<? extends MBeanServerConnection> getObjectType()
      Description copied from interface: FactoryBean
      Return the type of object that this FactoryBean creates, or null if not known in advance.

      This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

      In the case of implementations that create a singleton object, this method 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<MBeanServerConnection>
      Returns:
      the type of object that this FactoryBean creates, or null if not known at the time of the call
      See Also:

    • isSingleton

      public boolean isSingleton()
      Description copied from interface: FactoryBean
      Is the object managed by this factory a singleton? That is, will FactoryBean.getObject() always return the same object (a reference that can be cached)?

      NOTE: If a FactoryBean indicates that it holds 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.

      NOTE: This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its SmartFactoryBean.isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

      The default implementation returns true, since a FactoryBean typically manages a singleton instance.

      Specified by:
      isSingleton in interface FactoryBean<MBeanServerConnection>
      Returns:
      whether the exposed object is a singleton
      See Also:

    • destroy

      public void destroy() throws IOException
      Closes the underlying JMXConnector.
      Specified by:
      destroy in interface DisposableBean
      Throws:
      IOException