Creating a branch for experimenting with some ideas for JMS client.rajith_jms_client

git-svn-id: https://svn.apache.org/repos/asf/qpid/branches/rajith_jms_client@1128369 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 181 insertions, 0 deletions

diff --git a/qpid/doc/book/src/Configuring-Qpid-JMX-Management-Console.xml b/qpid/doc/book/src/Configuring-Qpid-JMX-Management-Console.xml
new file mode 100644
index 0000000000..72e4ba8969
--- /dev/null
+++ b/qpid/doc/book/src/Configuring-Qpid-JMX-Management-Console.xml
@@ -0,0 +1,181 @@
+<?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><title>
+      Configuring Qpid JMX Management Console
+    </title><section role="h2" id="ConfiguringQpidJMXManagementConsole-ConfiguringQpidJMXManagementConsole"><title>
+            Configuring Qpid JMX Management Console
+          </title>
+
+	  <para>
+            Qpid has a JMX management interface that exposes a number of
+            components of the running broker.
+            You can find out more about the features exposed by the JMX
+            interfaces <xref linkend="qpid_Qpid-Management-Features"/>.
+          </para><para>
+            
+          </para>
+
+	  <section role="h3" id="ConfiguringQpidJMXManagementConsole-InstallingtheQpidJMXManagementConsole"><title>
+            Installing the Qpid JMX Management Console
+          </title>
+
+	 <orderedlist>
+            <listitem><para>Unzip the archive to a suitable location.</para>
+
+	    <note><title>SSL encrypted connections</title>
+                      <para>
+                        Recent versions of the broker can make use of SSL to
+                        encrypt their RMI based JMX connections. If a broker
+                        being connected to is making use of this ability then
+                        additional console configuration may be required,
+                        particularly when using self-signed certificates. See
+                        <xref linkend="qpid_Management-Console-Security"/> for details.
+                      </para>
+	    </note>
+	  </listitem>
+          </orderedlist>
+
+	  <note>
+	    <title>JMXMP based connections</title>
+	    <para>
+	      In previous releases of Qpid (M4 and below) the broker
+	      JMX connections could make use of the JMXMPConnector for
+	      additional security over its default RMI based JMX
+	      configuration. This is no longer the case, with SSL
+	      encrypted RMI being the favored approach going forward.
+	      However, if you wish to connect to an older broker using
+	      JMXMP the console will support this so long as the
+	      <emphasis>jmxremote_optional.jar</emphasis> file is provided to it.
+	      For details see <xref linkend="qpid_Management-Console-Security"/>.
+	    </para>
+	  </note>
+<!--h3--></section>
+
+          
+	  <section role="h3" id="ConfiguringQpidJMXManagementConsole-RunningtheQpidJMXManagementConsole"><title>
+            Running the Qpid JMX Management Console
+          </title>
+
+	 <para>
+            The console can be started in the following way, depending on
+            platform:
+          </para><itemizedlist>
+            <listitem><para>Windows: by running the 'qpidmc.exe' executable file.
+            </para></listitem>
+          </itemizedlist><itemizedlist>
+            <listitem><para>Linux: by running the 'qpidmc' executable.
+            </para></listitem>
+          </itemizedlist><itemizedlist>
+            <listitem><para>Mac OS X: by launching the consoles application bundle (.app
+            file).
+            </para></listitem>
+          </itemizedlist>
+<!--h3--></section>
+
+
+	  <section role="h3" id="ConfiguringQpidJMXManagementConsole-UsingtheQpidJMXManagementConsole"><title>
+            Using the Qpid JMX Management Console
+          </title>
+
+	 <para>
+            Please see <xref linkend="Qpid-JMX-Management-Console-User-Guide"/> for details on using this Eclipse RCP
+            application.
+          </para>
+
+<!--h3--></section>
+<!--h2--></section>
+
+	  <section role="h2" id="ConfiguringQpidJMXManagementConsole-UsingJConsole"><title>
+            Using
+            JConsole
+          </title>
+
+	 <para>
+            See <xref linkend="qpid_JConsole"/>
+          </para>
+<!--h2--></section>
+
+
+	  <section role="h2" id="ConfiguringQpidJMXManagementConsole-UsingHermesJMS"><title>
+            Using
+            HermesJMS
+          </title>
+
+	 <para>
+            HermesJMS also offers integration with the Qpid management
+            interfaces. You can get instructions and more information from
+	    <ulink url="http://cwiki.apache.org/confluence/display/qpid/HermesJMS">HermesJMS</ulink>.
+          </para>
+<!--h2--></section>
+
+	  <section role="h2" id="ConfiguringQpidJMXManagementConsole-UsingMC4J"><title>
+            Using
+            MC4J
+          </title>
+
+	 <para>
+            <ulink url="qpid_www.mc4j.org">MC4J</ulink> is an alternative
+            management tool. It provide a richer "dashboard" that can
+            customise the raw MBeans.
+          </para>
+	  <section role="h4" id="ConfiguringQpidJMXManagementConsole-Installation"><title>
+            Installation
+          </title>
+
+	 <itemizedlist>
+            <listitem><para>First download and install MC4J for your platform. Version
+            1.2 beta 9 is the latest version that has been tested.
+            </para></listitem>
+            <listitem><para>Copy the directory blaze/java/management/mc4j into
+            the directory &lt;MC4J-Installation&gt;/dashboards
+            </para></listitem>
+          </itemizedlist>
+<!--h4--></section>
+
+	  <section role="h4" id="ConfiguringQpidJMXManagementConsole-Configuration"><title>
+            Configuration
+          </title>
+
+	 <para>
+            You should create a connection the JVM to be managed. Using the
+            Management-&gt;Create Server Connection menu option. The
+            connection URL should be of the form:
+            service:jmx:rmi:///jndi/rmi://localhost:8999/jmxrmi
+            making the appropriate host and post changes.
+          </para>
+<!--h4--></section>
+
+	  <section role="h4" id="ConfiguringQpidJMXManagementConsole-Operation"><title>
+            Operation
+          </title>
+
+	 <para>
+            You can view tabular summaries of the queues, exchanges and
+            connections using the Global Dashboards-&gt;QPID tree view. To
+            drill down on individual beans you can right click on the bean.
+            This will show any available graphs too.
+          </para>
+<!--h4--></section>
+<!--h2--></section>
+</section>