jmx-management.html

buildbot Mon, 30 Mar 2020 00:57:11 -0700

Author: buildbot
Date: Mon Mar 30 07:56:44 2020
New Revision: 1058493

Log:
Production update by buildbot for cxf


Modified:
    websites/production/cxf/content/cache/docs.pageCache
    websites/production/cxf/content/docs/jmx-management.html

Modified: websites/production/cxf/content/cache/docs.pageCache
==============================================================================
Binary files - no diff available.

Modified: websites/production/cxf/content/docs/jmx-management.html
==============================================================================
--- websites/production/cxf/content/docs/jmx-management.html (original)
+++ websites/production/cxf/content/docs/jmx-management.html Mon Mar 30 
07:56:44 2020
@@ -130,7 +130,7 @@ Apache CXF -- JMX Management
   &lt;property name="usePlatformMBeanServer" value="true" /&gt;
 &lt;/bean&gt;
 </pre>
-</div></div><p>The default InstrumentationManager accepts the following 
configuration options:</p><div class="table-wrap"><table class="wrapped 
confluenceTable"><colgroup span="1"><col span="1"><col span="1"><col 
span="1"></colgroup><tbody><tr><th colspan="1" rowspan="1" 
class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" 
class="confluenceTh"><p>Value</p></th><th colspan="1" rowspan="1" 
class="confluenceTh"><p>Default</p></th></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p>enabled</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>If the JMX integration should be enabled or 
not</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>false</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p>bus</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>The CXF bus instance to register the JMX extension 
with</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>None</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confl
 uenceTd"><p>server</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>An optional reference to an MBeanServer instance to 
register MBeans with. If not supplied, an MBeanServer is resolved using the 
"usePlatformMBeanServer" and/or "serverName" options.</p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p>None</p></td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd"><p>usePlatformMBeanServer</p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p>If true and no reference to an 
MBeanServer is supplied, the JMX extension registers MBeans with the platform 
MBean server.</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>false</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p>serverName</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>If supplied, usePlatformMBeanServer is false, and no 
reference to an MBeanServer is supplied, the JMX extension registers MBeans 
with the MBean server carrying this name.</p></td><td colspan
 ="1" rowspan="1" 
class="confluenceTd"><p>None</p></td></tr></tbody></table></div><p><br 
clear="none"></p><p>Before CXF 3.4.0, the following options were also 
available. From CXF 3.4.0, these options are removed, as there is no real 
advantage to creating a custom JMX local Connector. Local JMX monitoring can be 
done using standard tools, and remote JMX monitoring is done using the standard 
JVM JXM options (see below).</p><div class="table-wrap"><table 
class="confluenceTable"><colgroup span="1"><col span="1"><col span="1"><col 
span="1"></colgroup><tbody><tr><th colspan="1" rowspan="1" 
class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" 
class="confluenceTh"><p>Value</p></th><th colspan="1" rowspan="1" 
class="confluenceTh"><p>Default</p></th></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p>createMBServerConnectorFactory 
<strong>deprecated</strong></p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>If true, a connector is created on the MBeanServer.</p><
 /td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>true</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p>threaded <strong>deprecated</strong></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p>Determines if the creation of 
the MBean connector is performed in this thread or in a separate thread. Only 
relevant if createMBServerConnectorFactory is true.</p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p>false</p></td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd"><p>daemon 
<strong>deprecated</strong></p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>Determines if the MBean connector creation thread is 
marked as a daemon thread or not. Only relevant if 
createMBServerConnectorFactory is true.</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>false</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p>JMXServiceURL <strong>deprecated</strong></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p
 >The URL of the connector to create on the MBeanServer. Only relevant if 
 >createMBServerConnectorFactory is true.</p></td><td colspan="1" rowspan="1" 
 >class="confluenceTd"><p>service:jmx:<a shape="rect" 
 >href="rmi://cwiki.apache.org/jndi/rmi://localhost:9913/jmxrmi" 
 >rel="nofollow">rmi:///jndi/rmi://localhost:9913/jmxrmi</a></p></td></tr><tr><td
 > colspan="1" rowspan="1" class="confluenceTd">environment 
 ><strong>deprecated</strong></td><td colspan="1" rowspan="1" 
 >class="confluenceTd">This is a map that is used to configure the RMI 
 >environment.</td><td colspan="1" rowspan="1" 
 >class="confluenceTd">None</td></tr></tbody></table></div><p><br 
 >clear="none"></p><p>The MBean instrumentation provided by the above 
 >configuration will provide generic information about the WSDL supported by 
 >the web service as well as web service administration commands. To see 
 >performance metrics of the SOAP call processing, further <a shape="rect" 
 >href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=
 84806267">configuration</a> is required &#8211; these are disabled by default 
to avoid unnecessary runtime overhead.</p><p>If you're using Maven, make sure 
you have the following dependency added to the pom.xml for the web service 
provider:</p><div class="code panel pdl" style="border-width: 1px;"><div 
class="codeContent panelContent pdl">
+</div></div><p>The default InstrumentationManager accepts the following 
configuration options:</p><div class="table-wrap"><table class="wrapped 
confluenceTable"><colgroup span="1"><col span="1"><col span="1"><col 
span="1"></colgroup><tbody><tr><th colspan="1" rowspan="1" 
class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" 
class="confluenceTh"><p>Value</p></th><th colspan="1" rowspan="1" 
class="confluenceTh"><p>Default</p></th></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p>enabled</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>If the JMX integration should be enabled or 
not</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>false</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p>bus</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>The CXF bus instance to register the JMX extension 
with</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>None</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confl
 uenceTd"><p>server</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>An optional reference to an MBeanServer instance to 
register MBeans with. If not supplied, an MBeanServer is resolved using the 
"usePlatformMBeanServer" and/or "serverName" options.</p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p>None</p></td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd"><p>usePlatformMBeanServer</p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p>If true and no reference to an 
MBeanServer is supplied, the JMX extension registers MBeans with the platform 
MBean server.</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>false</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p>serverName</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>If supplied, usePlatformMBeanServer is false, and no 
reference to an MBeanServer is supplied, the JMX extension registers MBeans 
with the MBean server carrying this name.</p></td><td colspan
 ="1" rowspan="1" 
class="confluenceTd"><p>None</p></td></tr></tbody></table></div><p>Before CXF 
3.4.0, the following options were also available. From CXF 3.4.0, these options 
are removed, as there is no real advantage to creating a custom JMX local 
Connector. Local JMX monitoring can be done using standard tools, and remote 
JMX monitoring is done using the standard JVM JXM options (see below).</p><div 
class="table-wrap"><table class="wrapped confluenceTable"><colgroup 
span="1"><col span="1"><col span="1"><col span="1"></colgroup><tbody><tr><th 
colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" 
rowspan="1" class="confluenceTh"><p>Value</p></th><th colspan="1" rowspan="1" 
class="confluenceTh"><p>Default</p></th></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p>createMBServerConnectorFactory 
<strong>deprecated</strong></p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>If true, a connector is created on the 
MBeanServer.</p></td><td colspan=
 "1" rowspan="1" class="confluenceTd"><p>true</p></td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd"><p>threaded 
<strong>deprecated</strong></p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>Determines if the creation of the MBean connector is 
performed in this thread or in a separate thread. Only relevant if 
createMBServerConnectorFactory is true.</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>false</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p>daemon <strong>deprecated</strong></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p>Determines if the MBean 
connector creation thread is marked as a daemon thread or not. Only relevant if 
createMBServerConnectorFactory is true.</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>false</p></td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p>JMXServiceURL <strong>deprecated</strong></p></td><td 
colspan="1" rowspan="1" class="confluenceTd"><p>The URL of the 
 connector to create on the MBeanServer. Only relevant if 
createMBServerConnectorFactory is true.</p></td><td colspan="1" rowspan="1" 
class="confluenceTd"><p>service:jmx:<a shape="rect" 
href="rmi://cwiki.apache.org/jndi/rmi://localhost:9913/jmxrmi" 
rel="nofollow">rmi:///jndi/rmi://localhost:9913/jmxrmi</a></p></td></tr><tr><td 
colspan="1" rowspan="1" class="confluenceTd">environment 
<strong>deprecated</strong></td><td colspan="1" rowspan="1" 
class="confluenceTd">This is a map that is used to configure the RMI 
environment.</td><td colspan="1" rowspan="1" 
class="confluenceTd">None</td></tr></tbody></table></div><p><br 
clear="none"></p><p>The MBean instrumentation provided by the above 
configuration will provide generic information about the WSDL supported by the 
web service as well as web service administration commands. To see performance 
metrics of the SOAP call processing, further <a shape="rect" 
href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=84806267";>config
 uration</a> is required &#8211; these are disabled by default to avoid 
unnecessary runtime overhead.</p><p>If you're using Maven, make sure you have 
the following dependency added to the pom.xml for the web service 
provider:</p><div class="code panel pdl" style="border-width: 1px;"><div 
class="codeContent panelContent pdl">
 <pre class="brush: java; gutter: false; theme: Default">&lt;dependency&gt;
     &lt;groupId&gt;org.apache.cxf&lt;/groupId&gt;
     &lt;artifactId&gt;cxf-rt-management&lt;/artifactId&gt;
@@ -151,7 +151,6 @@ Apache CXF -- JMX Management
 &lt;cxf:bus bus="cxf"&gt;
   &lt;cxf:properties&gt;
     &lt;entry key="bus.jmx.enabled" value="true" /&gt;
-    &lt;entry key="bus.jmx.JMXServiceURL" 
value="service:jmx:rmi:///jndi/rmi://localhost:9914/jmxrmi" /&gt;
     &lt;entry key="bus.jmx.usePlatformMBeanServer" value="true" /&gt;
   &lt;/cxf:properties&gt;
 &lt;/cxf:bus&gt;
@@ -159,7 +158,7 @@ Apache CXF -- JMX Management
 </pre>
 </div></div><div class="table-wrap"><table class="wrapped 
confluenceTable"><colgroup span="1"><col span="1"><col 
span="1"></colgroup><tbody><tr><td colspan="1" rowspan="1" 
class="confluenceTd"><p><img class="emoticon emoticon-warning" 
src="https://cwiki.apache.org/confluence/s/-7iq2vk/8301/13280cd41a592ca5883bbc1ae415b58671505365/_/images/icons/emoticons/warning.svg";
 data-emoticon-name="warning" alt="(warning)"></p></td><td colspan="1" 
rowspan="1" class="confluenceTd"><p><strong>Changes in CXF 2.5.x</strong> <br 
clear="none" class="atl-forced-newline">Starting from 2.5.0, if&#160;a 
MBeanServer is available in the Spring context or as an OSGi server (when 
running in OSGi), the InstrumentationManger will be automatically enabled and 
will use that MBeanServer and the CXF MBeans will be registered. Therefore, the 
instrumentation manager configuration shown above is not needed in such 
cases.</p></td></tr></tbody></table></div><p>To test the configuration start up 
your service and connect
  to it by using JConsole from the JDK. Then you can browse to your 
endpoint:<br clear="none"><br clear="none">&#160;<br clear="none"><span 
class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image" 
src="jmx-management.data/jconsole_service_endpoint.png"></span><br 
clear="none">&#160;</p><p><span class="confluence-anchor-link" 
id="JMXManagement-cxf_in_servicemix"></span></p><h1 
id="JMXManagement-Remoteaccess">Remote access</h1><p>Remove access to JMX is 
configured using the standard JVM JMX options. For example:</p><div class="code 
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
 <pre class="brush: java; gutter: false; theme: 
Default">-Dcom.sun.management.jmxremote 
-Dcom.sun.management.jmxremote.port=9913 
-Dcom.sun.management.jmxremote.authenticate=false 
-Dcom.sun.management.jmxremote.ssl=false 
-Djava.rmi.server.hostname=localhost</pre>
-</div></div><p><br clear="none"></p><p>Then you can connect using jconsole 
specifying either of the following for the remote 
process:</p><ul><li>localhost:9913</li><li>service:jmx:rmi:///jndi/rmi://localhost:9913/jmxrmi</li></ul><h1
 id="JMXManagement-ConfiguringCXFtoUsetheServiceMix4MBeanServer">Configuring 
CXF to Use the ServiceMix 4 MBeanServer</h1><p>If you are embedding a CXF 
service in a ServiceMix 4 container, the configuration is slightly different 
from above. You don't want to start a new MBeanServer and you probably don't 
want to create additional connectors as the container manages both of these for 
you. You can get a reference to the container's MBeanServer through the OSGi 
framework and inject this reference into the JMX integration extension. Don't 
forget to add the Spring OSGI namespace and schemaLocation to your CXF 
configuration file if they are not already present.</p><div class="code panel 
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>Then you can connect using jconsole specifying either of the 
following for the remote 
process:</p><ul><li>localhost:9913</li><li>service:jmx:rmi:///jndi/rmi://localhost:9913/jmxrmi</li></ul><h1
 id="JMXManagement-ConfiguringCXFtoUsetheServiceMix4MBeanServer">Configuring 
CXF to Use the ServiceMix 4 MBeanServer</h1><p>If you are embedding a CXF 
service in a ServiceMix 4 container, the configuration is slightly different 
from above. You don't want to start a new MBeanServer and you probably don't 
want to create additional connectors as the container manages both of these for 
you. You can get a reference to the container's MBeanServer through the OSGi 
framework and inject this reference into the JMX integration extension. Don't 
forget to add the Spring OSGI namespace and schemaLocation to your CXF 
configuration file if they are not already present.</p><div class="code panel 
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
 <pre class="brush: java; gutter: false; theme: Default">
 &lt;!-- OSGi namespace and schemaLocation required --&gt;
 &lt;beans ...

svn commit: r1058493 - in /websites/production/cxf/content: cache/docs.pageCache docs/jmx-management.html

Reply via email to