public class MBeanServerFactoryBean
extends java.lang.Object
implements org.springframework.beans.factory.FactoryBean<javax.management.MBeanServer>, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean
FactoryBean that obtains an MBeanServer reference
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.
By default, MBeanServerFactoryBean will always create
a new MBeanServer even if one is already running. To have
the MBeanServerFactoryBean attempt to locate a running
MBeanServer first, set the value of the
"locateExistingServerIfPossible" property to "true".
setLocateExistingServerIfPossible(boolean),
locateMBeanServer(java.lang.String),
MBeanServer,
MBeanServerFactory.findMBeanServer(java.lang.String),
MBeanServerFactory.createMBeanServer(),
MBeanServerFactory.newMBeanServer(),
MBeanServerConnectionFactoryBean,
ConnectorServerFactoryBean| Constructor and Description |
|---|
MBeanServerFactoryBean() |
| Modifier and Type | Method and Description |
|---|---|
void |
afterPropertiesSet()
Creates the
MBeanServer instance. |
protected javax.management.MBeanServer |
createMBeanServer(java.lang.String defaultDomain,
boolean registerWithFactory)
Create a new
MBeanServer instance and register it with the
MBeanServerFactory, if desired. |
void |
destroy()
Unregisters the
MBeanServer instance, if necessary. |
javax.management.MBeanServer |
getObject() |
java.lang.Class<? extends javax.management.MBeanServer> |
getObjectType() |
boolean |
isSingleton() |
protected javax.management.MBeanServer |
locateMBeanServer(java.lang.String agentId)
Attempt to locate an existing
MBeanServer. |
void |
setAgentId(java.lang.String agentId)
Set the agent id of the
MBeanServer to locate. |
void |
setDefaultDomain(java.lang.String defaultDomain)
Set the default domain to be used by the
MBeanServer,
to be passed to MBeanServerFactory.createMBeanServer()
or MBeanServerFactory.findMBeanServer(). |
void |
setLocateExistingServerIfPossible(boolean locateExistingServerIfPossible)
Set whether or not the
MBeanServerFactoryBean should attempt
to locate a running MBeanServer before creating one. |
void |
setRegisterWithFactory(boolean registerWithFactory)
Set whether to register the
MBeanServer with the
MBeanServerFactory, making it available through
MBeanServerFactory.findMBeanServer(). |
protected final Log logger
public void setLocateExistingServerIfPossible(boolean locateExistingServerIfPossible)
MBeanServerFactoryBean should attempt
to locate a running MBeanServer before creating one.
Default is false.
public void setAgentId(java.lang.String agentId)
MBeanServer to locate.
Default is none. If specified, this will result in an automatic attempt being made to locate the attendant MBeanServer, and (importantly) if said MBeanServer cannot be located no attempt will be made to create a new MBeanServer (and an MBeanServerNotFoundException will be thrown at resolution time).
Specifying the empty String indicates the platform MBeanServer.
MBeanServerFactory.findMBeanServer(String)public void setDefaultDomain(java.lang.String defaultDomain)
MBeanServer,
to be passed to MBeanServerFactory.createMBeanServer()
or MBeanServerFactory.findMBeanServer().
Default is none.
MBeanServerFactory.createMBeanServer(String),
MBeanServerFactory.findMBeanServer(String)public void setRegisterWithFactory(boolean registerWithFactory)
MBeanServer with the
MBeanServerFactory, making it available through
MBeanServerFactory.findMBeanServer().MBeanServerFactory.createMBeanServer(),
MBeanServerFactory.findMBeanServer(java.lang.String)public void afterPropertiesSet()
throws MBeanServerNotFoundException
MBeanServer instance.afterPropertiesSet in interface org.springframework.beans.factory.InitializingBeanMBeanServerNotFoundExceptionprotected javax.management.MBeanServer locateMBeanServer(java.lang.String agentId)
throws MBeanServerNotFoundException
MBeanServer.
Called if locateExistingServerIfPossible is set to true.
The default implementation attempts to find an MBeanServer using
a standard lookup. Subclasses may override to add additional location logic.
agentId - the agent identifier of the MBeanServer to retrieve.
If this parameter is null, all registered MBeanServers are
considered.MBeanServer if foundMBeanServerNotFoundException - if no MBeanServer could be foundsetLocateExistingServerIfPossible(boolean),
JmxUtils.locateMBeanServer(String),
MBeanServerFactory.findMBeanServer(String)protected javax.management.MBeanServer createMBeanServer(java.lang.String defaultDomain,
boolean registerWithFactory)
MBeanServer instance and register it with the
MBeanServerFactory, if desired.defaultDomain - the default domain, or null if noneregisterWithFactory - whether to register the MBeanServer
with the MBeanServerFactoryMBeanServerFactory.createMBeanServer(),
MBeanServerFactory.newMBeanServer()public javax.management.MBeanServer getObject()
getObject in interface org.springframework.beans.factory.FactoryBean<javax.management.MBeanServer>public java.lang.Class<? extends javax.management.MBeanServer> getObjectType()
getObjectType in interface org.springframework.beans.factory.FactoryBean<javax.management.MBeanServer>public boolean isSingleton()
isSingleton in interface org.springframework.beans.factory.FactoryBean<javax.management.MBeanServer>public void destroy()
MBeanServer instance, if necessary.destroy in interface org.springframework.beans.factory.DisposableBean