ConnectorServerFactoryBean (Spring Framework) - Spring Framework 1.2.9 API 文档英文版

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.jmx.support
Class ConnectorServerFactoryBean

java.lang.Object
  org.springframework.jmx.support.ConnectorServerFactoryBean

All Implemented Interfaces:: DisposableBean, FactoryBean, InitializingBean

public class ConnectorServerFactoryBean
extends Object
implements FactoryBean, InitializingBean, DisposableBean
extends Object
implements FactoryBean, InitializingBean, 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.

Since:: 1.2
Author:: Rob Harrop, Juergen Hoeller
See Also:: FactoryBean, JMXConnectorServer, MBeanServer

Nested Class Summary

static class ConnectorServerFactoryBean.DelayedConnectorStartException
          Exception to be thrown if the JMX connector server cannot be started (in a concurrent thread).

Field Summary

static String DEFAULT_SERVICE_URL
          The default service URL.

protected Log logger


Constructor Summary

ConnectorServerFactoryBean()


Method Summary

void afterPropertiesSet()
          Start the connector server.

void destroy()
          Stop the JMXConnectorServer managed by an instance of this class.

Object getObject()
          Return an instance (possibly shared or independent) of the object managed by this factory.

Class getObjectType()
          Return the type of object that this FactoryBean creates, or null if not known in advance.

boolean isSingleton()
          Is the bean managed by this factory a singleton or a prototype?

void setDaemon(boolean daemon)
          Set whether any threads started for the JMXConnectorServer should be started as daemon threads.

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

void setEnvironmentMap(Map environment)
          Set the environment properties used to construct the JMXConnector as a Map of String keys and arbitrary Object values.

void setObjectName(String objectName)
          Set the ObjectName used to register the JMXConnectorServer itself with the MBeanServer.

void setServer(MBeanServer server)
          Set the MBeanServer that the JMXConnectorServer should expose.

void setServiceUrl(String serviceUrl)
          Set the service URL for the JMXConnectorServer.

void setThreaded(boolean threaded)
          Set whether the JMXConnectorServer should be started in a separate thread.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Nested Class Summary
`static class`	`ConnectorServerFactoryBean.DelayedConnectorStartException` Exception to be thrown if the JMX connector server cannot be started (in a concurrent thread).

Field Summary
`static String`	`DEFAULT_SERVICE_URL` The default service URL.
`protected Log`	`logger`

Constructor Summary
`ConnectorServerFactoryBean()`

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

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

DEFAULT_SERVICE_URL

public static final String DEFAULT_SERVICE_URL

The default service URL.

See Also:: Constant Field Values

logger

protected final Log logger

Constructor Detail

ConnectorServerFactoryBean

public ConnectorServerFactoryBean()

Method Detail

setServer

public void setServer(MBeanServer server)

Set the MBeanServer that the JMXConnectorServer should expose.

setServiceUrl

public void setServiceUrl(String serviceUrl)

Set the service URL for the JMXConnectorServer.

setEnvironment

public void setEnvironment(Properties environment)

Set the environment properties used to construct the JMXConnectorServer as java.util.Properties (String key/value pairs).

setEnvironmentMap

public void setEnvironmentMap(Map environment)

Set the environment properties used to construct the JMXConnector as a Map of String keys and arbitrary Object values.

setObjectName

public void setObjectName(String objectName)
                   throws MalformedObjectNameException

Set the ObjectName used to register the JMXConnectorServer itself with the MBeanServer.

Throws:: MalformedObjectNameException - if the ObjectName is malformed

setThreaded

public void setThreaded(boolean threaded)

Set whether the JMXConnectorServer should be started in a separate thread.

setDaemon

public void setDaemon(boolean daemon)

Set whether any threads started for the JMXConnectorServer should be started as daemon threads.

afterPropertiesSet

public void afterPropertiesSet()
                        throws JMException,
                               IOException

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.

Specified by:: afterPropertiesSet in interface InitializingBean

Throws:: JMException - if a problem occured when registering the connector server with the MBeanServer; IOException - if there is a problem starting the connector server

getObject

public Object 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 pattern.

If this method returns null, the factory will consider the FactoryBean as not fully initialized and throw a corresponding FactoryBeanNotInitializedException.

Specified by:: getObject in interface FactoryBean

Returns:: an instance of the bean (should not be null; a null value will be considered as an indication of incomplete initialization)
See Also:: FactoryBeanNotInitializedException

getObjectType

public Class getObjectType()

Description copied from interface: FactoryBean

Return the type of object that this FactoryBean creates, or null if not known in advance. This allows to check for specific types of beans without instantiating objects, for example on autowiring.

For a singleton, this 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

Returns:: the type of object that this FactoryBean creates, or null if not known at the time of the call
See Also:: ListableBeanFactory.getBeansOfType(java.lang.Class)

isSingleton

public boolean isSingleton()

Description copied from interface: FactoryBean

Is the bean managed by this factory a singleton or a prototype? 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.

Specified by:: isSingleton in interface FactoryBean

Returns:: if this bean is a singleton
See Also:: FactoryBean.getObject()

destroy

public void destroy()
             throws IOException

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

Specified by:: destroy in interface DisposableBean

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

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ConnectorServerFactoryBean (Spring Framework) - Spring Framework 1.2.9 API 文档英文版

org.springframework.jmx.support Class ConnectorServerFactoryBean

DEFAULT_SERVICE_URL

logger

ConnectorServerFactoryBean

setServer

setServiceUrl

setEnvironment

setEnvironmentMap

setObjectName

setThreaded

setDaemon

afterPropertiesSet

getObject

getObjectType

isSingleton

destroy

org.springframework.jmx.support
Class ConnectorServerFactoryBean