Package org.springframework.jmx.support

Class ConnectorServerFactoryBean

    • Method Detail

      • setServiceUrl

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

      • setEnvironment

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

      • setEnvironmentMap

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

      • 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 occurred when registering the connector server with the MBeanServer
        IOException - if there is a problem starting the connector server

      • getObject

        @Nullable
public JMXConnectorServer 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 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.

        Specified by:
        getObject in interface FactoryBean<JMXConnectorServer>
        Returns:
        an instance of the bean (can be null)
        See Also:
        FactoryBeanNotInitializedException

      • getObjectType

        public Class<? extends JMXConnectorServer> getObjectType()
        Description copied from interface: FactoryBean
        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.

        Specified by:
        getObjectType in interface FactoryBean<JMXConnectorServer>
        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<T>)

      • isSingleton

        public boolean isSingleton()
        Description copied from interface: FactoryBean
        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)?

        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.

        Specified by:
        isSingleton in interface FactoryBean<JMXConnectorServer>
        Returns:
        whether the exposed object is a singleton
        See Also:
        FactoryBean.getObject(), SmartFactoryBean.isPrototype()

      • 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