public class ConnectorServerFactoryBean extends MBeanRegistrationSupport implements org.springframework.beans.factory.FactoryBean<javax.management.remote.JMXConnectorServer>, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean
FactoryBean
that creates a JSR-160 JMXConnectorServer
,
optionally registers it with the MBeanServer
and then starts it.
The JMXConnectorServer
can be started in a separate thread by setting the
threaded
property to true
. You can configure this thread to be a
daemon thread by setting the daemon
property to true
.
The JMXConnectorServer
is correctly shutdown when an instance of this
class is destroyed on shutdown of the containing ApplicationContext
.
JMXConnectorServer
,
MBeanServer
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_SERVICE_URL
The default service URL
|
logger, REGISTRATION_FAIL_ON_EXISTING, REGISTRATION_IGNORE_EXISTING, REGISTRATION_REPLACE_EXISTING, server
Constructor and Description |
---|
ConnectorServerFactoryBean() |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet()
Start the connector server.
|
void |
destroy()
Stop the
JMXConnectorServer managed by an instance of this class. |
javax.management.remote.JMXConnectorServer |
getObject() |
java.lang.Class<? extends javax.management.remote.JMXConnectorServer> |
getObjectType() |
boolean |
isSingleton() |
void |
setDaemon(boolean daemon)
Set whether any threads started for the
JMXConnectorServer should be
started as daemon threads. |
void |
setEnvironment(java.util.Properties environment)
Set the environment properties used to construct the
JMXConnectorServer
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 |
setForwarder(javax.management.remote.MBeanServerForwarder forwarder)
Set an MBeanServerForwarder to be applied to the
JMXConnectorServer . |
void |
setObjectName(java.lang.Object objectName)
Set the
ObjectName used to register the JMXConnectorServer
itself with the MBeanServer , as ObjectName instance
or as String . |
void |
setServiceUrl(java.lang.String serviceUrl)
Set the service URL for the
JMXConnectorServer . |
void |
setThreaded(boolean threaded)
Set whether the
JMXConnectorServer should be started in a separate thread. |
doRegister, doUnregister, getRegisteredObjectNames, getServer, onRegister, onRegister, onUnregister, setRegistrationBehavior, setRegistrationBehaviorName, setRegistrationPolicy, setServer, unregisterBeans
public static final java.lang.String DEFAULT_SERVICE_URL
public void setServiceUrl(java.lang.String serviceUrl)
JMXConnectorServer
.public void setEnvironment(java.util.Properties environment)
JMXConnectorServer
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 setForwarder(javax.management.remote.MBeanServerForwarder forwarder)
JMXConnectorServer
.public void setObjectName(java.lang.Object objectName) throws javax.management.MalformedObjectNameException
ObjectName
used to register the JMXConnectorServer
itself with the MBeanServer
, as ObjectName
instance
or as String
.javax.management.MalformedObjectNameException
- if the ObjectName
is malformedpublic void setThreaded(boolean threaded)
JMXConnectorServer
should be started in a separate thread.public void setDaemon(boolean daemon)
JMXConnectorServer
should be
started as daemon threads.public void afterPropertiesSet() throws javax.management.JMException, java.io.IOException
threaded
flag is set to true
,
the JMXConnectorServer
will be started in a separate thread.
If the daemon
flag is set to true
, that thread will be
started as a daemon thread.afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
javax.management.JMException
- if a problem occurred when registering the connector server
with the MBeanServer
java.io.IOException
- if there is a problem starting the connector serverpublic javax.management.remote.JMXConnectorServer getObject()
getObject
in interface org.springframework.beans.factory.FactoryBean<javax.management.remote.JMXConnectorServer>
public java.lang.Class<? extends javax.management.remote.JMXConnectorServer> getObjectType()
getObjectType
in interface org.springframework.beans.factory.FactoryBean<javax.management.remote.JMXConnectorServer>
public boolean isSingleton()
isSingleton
in interface org.springframework.beans.factory.FactoryBean<javax.management.remote.JMXConnectorServer>
public void destroy() throws java.io.IOException
JMXConnectorServer
managed by an instance of this class.
Automatically called on ApplicationContext
shutdown.destroy
in interface org.springframework.beans.factory.DisposableBean
java.io.IOException
- if there is an error stopping the connector server