root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Polish Javadoc for JMX factory beans

This commit is contained in:
Sam Brannen 2019-10-31 13:55:13 +01:00
parent 3b724c72b6
commit 57b4b74e7d
3 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
spring-context/src/main/java/org/springframework/jmx/support/ConnectorServerFactoryBean.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* Copyright 2002-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -39,13 +39,13 @@ import org.springframework.util.CollectionUtils;
/**
* {@link FactoryBean} that creates a JSR-160 {@link JMXConnectorServer},
* optionally registers it with the {@link MBeanServer} and then starts it.
* optionally registers it with the {@link MBeanServer}, and then starts it.
*
* <p>The {@code JMXConnectorServer} can be started in a separate thread by setting the
* {@code threaded} property to {@code true}. You can configure this thread to be a
* daemon thread by setting the {@code daemon} property to {@code true}.
*
* <p>The {@code JMXConnectorServer} is correctly shutdown when an instance of this
* <p>The {@code JMXConnectorServer} is correctly shut down when an instance of this
* class is destroyed on shutdown of the containing {@code ApplicationContext}.
*
* @author Rob Harrop

5
spring-context/src/main/java/org/springframework/jmx/support/MBeanServerConnectionFactoryBean.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* Copyright 2002-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -101,7 +101,8 @@ public class MBeanServerConnectionFactoryBean
}
/**
* Set whether to connect to the server on startup. Default is "true".
* Set whether to connect to the server on startup.
* <p>Default is {@code true}.
* <p>Can be turned off to allow for late start of the JMX server.
* In this case, the JMX connector will be fetched on first access.
*/

10
spring-context/src/main/java/org/springframework/jmx/support/MBeanServerFactoryBean.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -29,10 +29,11 @@ import org.springframework.jmx.MBeanServerNotFoundException;
import org.springframework.lang.Nullable;
/**
* {@link FactoryBean} that obtains an {@link javax.management.MBeanServer} reference
* {@link FactoryBean} that obtains a {@link javax.management.MBeanServer} reference
* through the standard JMX 1.2 {@link javax.management.MBeanServerFactory}
* API (which is available on JDK 1.5 or as part of a JMX 1.2 provider).
* Exposes the {@code MBeanServer} for bean references.
* API.
*
* <p>Exposes the {@code MBeanServer} for bean references.
*
* <p>By default, {@code MBeanServerFactoryBean} will always create
* a new {@code MBeanServer} even if one is already running. To have
@ -111,6 +112,7 @@ public class MBeanServerFactoryBean implements FactoryBean<MBeanServer>, Initial
* Set whether to register the {@code MBeanServer} with the
* {@code MBeanServerFactory}, making it available through
* {@code MBeanServerFactory.findMBeanServer()}.
* <p>Default is {@code true}.
* @see javax.management.MBeanServerFactory#createMBeanServer
* @see javax.management.MBeanServerFactory#findMBeanServer
*/