Author: remm
Date: Wed Feb 6 20:16:04 2019
New Revision: 1853095
URL: http://svn.apache.org/viewvc?rev=1853095&view=rev
Log:
Add some docs on the attributes added in the JMX remote listener.
Modified:
tomcat/trunk/webapps/docs/config/listeners.xml
Modified: tomcat/trunk/webapps/docs/config/listeners.xml
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/listeners.xml?rev=1853095&r1=1853094&r2=1853095&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/listeners.xml (original)
+++ tomcat/trunk/webapps/docs/config/listeners.xml Wed Feb 6 20:16:04 2019
@@ -508,7 +508,7 @@
<p>The <strong>JMX Remote Lifecycle Listener</strong> fixes the ports used
by
the JMX/RMI Server making things much simpler if you need to connect
- jconsole or a similar tool to a remote Tomcat instance that is running
+ visualvm or a similar tool to a remote Tomcat instance that is running
behind a firewall.</p>
<p>Note: The SSL configuration can be done with attributes identical to
those
@@ -516,10 +516,13 @@
properties of the default certificate as defined for
<a href="http.html#SSL_Support_-_Certificate">SSLHostConfigCertificate</a>.
This will create a JSSE SSLContext which will be given to the JMX/RMI
registry
- when creating the server socket.</p>
-
- <p>The remainder of the configuration is via the standard system
properties for
- configuring JMX. For further information on configuring JMX see
+ when creating the server socket. OpenSSL specific attributes cannot
+ be used in the configuration as JMX remote can only use a regular
+ SSLContext.</p>
+
+ <p>The remainder of the configuration can be done via the standard system
+ properties for configuring JMX. For further information on configuring JMX
+ see
<a
href="http://docs.oracle.com/javase/6/docs/technotes/guides/management/agent.html";>
Monitoring and Management Using JMX</a> included with the Java SDK
documentation.</p>
@@ -532,6 +535,35 @@
<attributes>
+ <attribute name="accessFile" required="false">
+ <p>Defines the access file used. The attribute will be set to the
+ value of the <code>com.sun.management.jmxremote.access.file</code>
+ system property if it is defined.</p>
+ </attribute>
+
+ <attribute name="authenticate" required="false">
+ <p>Defines if authentication is used. Defaults to
+ <code>true</code>. The attribute will be set to the value of the
+ <code>com.sun.management.jmxremote.authenticate</code> system property
+ if it is defined.</p>
+ </attribute>
+
+ <attribute name="loginModuleName" required="false">
+ <p>Defines the login module used. The attribute will be set to the
+ value of the <code>com.sun.management.jmxremote.login.config</code>
+ system property if it is defined.</p>
+ </attribute>
+
+ <attribute name="passwordFile" required="false">
+ <p>Defines the password file used. The attribute will be set to the
+ value of the <code>com.sun.management.jmxremote.password.file</code>
+ system property if it is defined.</p>
+ </attribute>
+
+ <attribute name="rmiBindAddress" required="false">
+ <p>The address of the interface to be used by JMX/RMI server.</p>
+ </attribute>
+
<attribute name="rmiRegistryPortPlatform" required="true">
<p>The port to be used by the JMX/RMI registry for the Platform MBeans.
This replaces the use of the
@@ -539,12 +571,22 @@
should not be set when using this listener.</p>
</attribute>
+ <attribute name="rmiRegistrySSL" required="false">
+ <p>Defines if the RMI registry will use SSL. Defaults to
+ <code>true</code>. The attribute will be set to the value of the
+ <code>com.sun.management.jmxremote.registry.ssl</code> system property
+ if it is defined.</p>
+ </attribute>
+
<attribute name="rmiServerPortPlatform" required="true">
<p>The port to be used by the Platform JMX/RMI server.</p>
</attribute>
- <attribute name="rmiBindAddress" required="false">
- <p>The address of the interface to be used by JMX/RMI server.</p>
+ <attribute name="rmiServerSSL" required="false">
+ <p>Defines if the JMX remote server will use SSL. Defaults to
+ <code>true</code>. The attribute will be set to the value of the
+ <code>com.sun.management.jmxremote.ssl</code> system property
+ if it is defined.</p>
</attribute>
<attribute name="useLocalPorts" required="false">
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
