doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-JMX.xml

<?xml version="1.0" encoding="utf-8"?>
<!--

 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
 distributed with this work for additional information
 regarding copyright ownership.  The ASF licenses this file
 to you under the Apache License, Version 2.0 (the
 "License"); you may not use this file except in compliance
 with the License.  You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing,
 software distributed under the License is distributed on an
 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.

-->

<section id="Java-Broker-Configuring-And-Managing-JMX-Management">
    <title>JMX Management</title>

    <section id="Java-Broker-Configuring-And-Managing-JMX-Management-Introduction">
        <title>Introduction</title>
        <para>
            The brokers JMX Management Plugin provides the support for creating JMX MBeans for broker objects such as Queues, Exchanges, Connections etc.
        </para>
        <para>
            It is included into the brokers Initial Configuration by default, and is responsible for servicing the RMI and JMX_RMI ports configured on the broker, with the former serving as the RMI Registry used to advertise the actual JMX Connector Server started on the latter.
        </para>
    </section>


    <section id="Java-Broker-Configuring-And-Managing-JMX-Management-Plugin-Configuration">
        <title>JMX Management Plugin Configuration</title>

        <para>
            The JMX Management Plugin can be configured through the <link linkend="Java-Broker-Configuring-And-Managing-Web-Console">Web Management Console</link>
            and underlying REST management interface. By double-clicking on the JMX Management Plugin name in the object tree a tab for the plugin
            is displayed with its current settings, which can be changed by clicking on the "Edit" button.

            The following attributes can be set on the JMX Management Plugin:
            <itemizedlist>
                <listitem><para><emphasis>Use Platform MBean Server</emphasis>. The JMX Management Plugin can start its own MBean Server or it can use the JVMs 'Platform MBean Server'.
                By default this is true, and the Platform MBean Server is used.</para></listitem>
            </itemizedlist>
            NOTE: Changes to the "Use Platform MBean Server" attribute only take effect at broker restart.
        </para>
    </section>
</section>