public class MBeanServerConnectionFactoryBean extends java.lang.Object implements FactoryBean<javax.management.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.MBeanServerFactoryBean
,
ConnectorServerFactoryBean
,
MBeanClientInterceptor.setServer(javax.management.MBeanServerConnection)
,
NotificationListenerRegistrar.setServer(javax.management.MBeanServerConnection)
Constructor and Description |
---|
MBeanServerConnectionFactoryBean() |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet()
Creates a
JMXConnector for the given settings
and exposes the associated MBeanServerConnection . |
void |
destroy()
Closes the underlying
JMXConnector . |
javax.management.MBeanServerConnection |
getObject()
Return an instance (possibly shared or independent) of the object
managed by this factory.
|
java.lang.Class<? extends javax.management.MBeanServerConnection> |
getObjectType()
Return the type of object that this FactoryBean creates,
or
null if not known in advance. |
boolean |
isSingleton()
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)? |
void |
setBeanClassLoader(java.lang.ClassLoader classLoader)
Callback that supplies the bean
class loader to
a bean instance. |
void |
setConnectOnStartup(boolean connectOnStartup)
Set whether to connect to the server on startup.
|
void |
setEnvironment(java.util.Properties environment)
Set the environment properties used to construct the
JMXConnector
as java.util.Properties (String key/value pairs). |
void |
setEnvironmentMap(java.util.Map<java.lang.String,?> environment)
Set the environment properties used to construct the
JMXConnector
as a Map of String keys and arbitrary Object values. |
void |
setServiceUrl(java.lang.String url)
Set the service URL of the remote
MBeanServer . |
public void setServiceUrl(java.lang.String url) throws java.net.MalformedURLException
MBeanServer
.java.net.MalformedURLException
public void setEnvironment(java.util.Properties environment)
JMXConnector
as java.util.Properties
(String key/value pairs).public void setEnvironmentMap(java.util.Map<java.lang.String,?> environment)
JMXConnector
as a Map
of String keys and arbitrary Object values.public void setConnectOnStartup(boolean connectOnStartup)
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 setBeanClassLoader(java.lang.ClassLoader classLoader)
BeanClassLoaderAware
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.
setBeanClassLoader
in interface BeanClassLoaderAware
classLoader
- the owning class loader; may be null
in
which case a default ClassLoader
must be used, for example
the ClassLoader
obtained via
ClassUtils.getDefaultClassLoader()
public void afterPropertiesSet() throws java.io.IOException
JMXConnector
for the given settings
and exposes the associated MBeanServerConnection
.afterPropertiesSet
in interface InitializingBean
java.io.IOException
public javax.management.MBeanServerConnection getObject()
FactoryBean
As with a BeanFactory
, this allows support for both the
Singleton and Prototype design pattern.
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
.
As of Spring 2.0, FactoryBeans are allowed to return null
objects. The factory will consider this as normal value to be used; it
will not throw a FactoryBeanNotInitializedException in this case anymore.
FactoryBean implementations are encouraged to throw
FactoryBeanNotInitializedException themselves now, as appropriate.
getObject
in interface FactoryBean<javax.management.MBeanServerConnection>
null
)FactoryBeanNotInitializedException
public java.lang.Class<? extends javax.management.MBeanServerConnection> getObjectType()
FactoryBean
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 are creating 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.
getObjectType
in interface FactoryBean<javax.management.MBeanServerConnection>
null
if not known at the time of the callListableBeanFactory.getBeansOfType(java.lang.Class<T>)
public boolean isSingleton()
FactoryBean
FactoryBean.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.
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
.
isSingleton
in interface FactoryBean<javax.management.MBeanServerConnection>
FactoryBean.getObject()
,
SmartFactoryBean.isPrototype()
public void destroy() throws java.io.IOException
JMXConnector
.destroy
in interface DisposableBean
java.io.IOException