Spring Context 6.1.4 · org.springframework.jmx.support.ConnectorServerFactoryBean

Modifier and Type	Field and Description
private JMXConnectorServer	connectorServer
private boolean	daemon
public static final String	DEFAULT_SERVICE_URL The default service URL.
private final Map<String, Object>	environment
private MBeanServerForwarder	forwarder
private ObjectName	objectName
private String	serviceUrl
private boolean	threaded

Access	Constructor and Description
public	ConnectorServerFactoryBean()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Start the connector server.
public void	destroy() Implements org.springframework.beans.factory.DisposableBean.destroy. Stop the `JMXConnectorServer` managed by an instance of this class.
public JMXConnectorServer	getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory.
public Class<? extends JMXConnectorServer>	getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance.
public boolean	isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton?
public void	setDaemon(boolean daemon) Set whether any threads started for the `JMXConnectorServer` should be started as daemon threads.
public void	setEnvironment(Properties environment) Set the environment properties used to construct the `JMXConnectorServer` as `java.util.Properties` (String key/value pairs).
public void	setEnvironmentMap(Map<String, ?> environment) Set the environment properties used to construct the `JMXConnector` as a `Map` of String keys and arbitrary Object values.
public void	setForwarder(MBeanServerForwarder forwarder) Set an MBeanServerForwarder to be applied to the `JMXConnectorServer`.
public void	setObjectName(Object objectName) Set the `ObjectName` used to register the `JMXConnectorServer` itself with the `MBeanServer`, as `ObjectName` instance or as `String`.
public void	setServiceUrl(String serviceUrl) Set the service URL for the `JMXConnectorServer`.
public void	setThreaded(boolean threaded) Set whether the `JMXConnectorServer` should be started in a separate thread.

Inherited from org.springframework.jmx.support.MBeanRegistrationSupport:: doRegister doUnregister getRegisteredObjectNames getServer onRegister onRegister onUnregister setRegistrationPolicy setServer unregisterBeans

connectorServer	back to summary
private JMXConnectorServer connectorServer Annotations @Nullable

daemon	back to summary
private boolean daemon

DEFAULT_SERVICE_URL	back to summary
public static final String DEFAULT_SERVICE_URL The default service URL.

environment	back to summary
private final Map<String, Object> environment

forwarder	back to summary
private MBeanServerForwarder forwarder Annotations @Nullable

objectName	back to summary
private ObjectName objectName Annotations @Nullable

serviceUrl	back to summary
private String serviceUrl

threaded	back to summary
private boolean threaded

ConnectorServerFactoryBean	back to summary
public ConnectorServerFactoryBean()

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() throws JMException, IOException Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Start the connector server. If the `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. Annotations @Override Exceptions JMException: if a problem occurred when registering the connector server with the `MBeanServer` IOException: if there is a problem starting the connector server

public void afterPropertiesSet() throws JMException, IOException

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Start the connector server. If the 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.

Annotations

@Override

Exceptions

JMException:: if a problem occurred when registering the connector server with the MBeanServer
IOException:: if there is a problem starting the connector server

destroy back to summary

destroy	back to summary
public void destroy() throws IOException Implements org.springframework.beans.factory.DisposableBean.destroy. Stop the `JMXConnectorServer` managed by an instance of this class. Automatically called on `ApplicationContext` shutdown. Annotations @Override Exceptions IOException: if there is an error stopping the connector server

public void destroy() throws IOException

Implements org.springframework.beans.factory.DisposableBean.destroy.

Stop the JMXConnectorServer managed by an instance of this class. Automatically called on ApplicationContext shutdown.

Annotations

@Override

Exceptions

IOException:: if there is an error stopping the connector server

getObject back to summary

getObject	back to summary
public JMXConnectorServer getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Doc from org.springframework.beans.factory.FactoryBean.getObject. 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 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. Returns:JMXConnectorServer an instance of the bean (can be `null`) Annotations @Override @Nullable

public JMXConnectorServer getObject()

Implements org.springframework.beans.factory.FactoryBean.getObject.

Doc from org.springframework.beans.factory.FactoryBean.getObject.

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 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.

Returns:JMXConnectorServer

an instance of the bean (can be null)

Annotations

@Override
@Nullable

getObjectType back to summary

getObjectType	back to summary
public Class<? extends JMXConnectorServer> getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Doc from org.springframework.beans.factory.FactoryBean.getObjectType. 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 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. Returns:Class<? extends JMXConnectorServer> the type of object that this FactoryBean creates, or `null` if not known at the time of the call Annotations @Override

public Class<? extends JMXConnectorServer> getObjectType()

Implements org.springframework.beans.factory.FactoryBean.getObjectType.

Doc from org.springframework.beans.factory.FactoryBean.getObjectType.

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 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.

Returns:Class<? extends JMXConnectorServer>

the type of object that this FactoryBean creates, or null if not known at the time of the call

Annotations

@Override

isSingleton back to summary

isSingleton	back to summary
public boolean isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Doc from org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton? That is, will `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`. The default implementation returns `true`, since a `FactoryBean` typically manages a singleton instance. Returns:boolean whether the exposed object is a singleton Annotations @Override

public boolean isSingleton()

Overrides default org.springframework.beans.factory.FactoryBean.isSingleton.

Doc from org.springframework.beans.factory.FactoryBean.isSingleton.

Is the object managed by this factory a singleton? That is, will 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.

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

Returns:boolean

whether the exposed object is a singleton

Annotations

@Override

setDaemon	back to summary
public void setDaemon(boolean daemon) Set whether any threads started for the `JMXConnectorServer` should be started as daemon threads.

setEnvironment	back to summary
public void setEnvironment(Properties environment) Set the environment properties used to construct the `JMXConnectorServer` as `java.util.Properties` (String key/value pairs).

setEnvironmentMap	back to summary
public void setEnvironmentMap(Map<String, ?> environment) Set the environment properties used to construct the `JMXConnector` as a `Map` of String keys and arbitrary Object values.

setForwarder	back to summary
public void setForwarder(MBeanServerForwarder forwarder) Set an MBeanServerForwarder to be applied to the `JMXConnectorServer`.

setObjectName back to summary

setObjectName	back to summary
public void setObjectName(Object objectName) throws MalformedObjectNameException Set the `ObjectName` used to register the `JMXConnectorServer` itself with the `MBeanServer`, as `ObjectName` instance or as `String`. Exceptions MalformedObjectNameException: if the `ObjectName` is malformed

public void setObjectName(Object objectName) throws MalformedObjectNameException

Set the ObjectName used to register the JMXConnectorServer itself with the MBeanServer, as ObjectName instance or as String.

Exceptions

MalformedObjectNameException:: if the ObjectName is malformed

setServiceUrl	back to summary
public void setServiceUrl(String serviceUrl) Set the service URL for the `JMXConnectorServer`.

setThreaded	back to summary
public void setThreaded(boolean threaded) Set whether the `JMXConnectorServer` should be started in a separate thread.

public Class ConnectorServerFactoryBean

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail