diff options
| author | Robert Gemmell <robbie@apache.org> | 2012-09-03 22:08:25 +0000 |
|---|---|---|
| committer | Robert Gemmell <robbie@apache.org> | 2012-09-03 22:08:25 +0000 |
| commit | 6ae4a2b06f2cb409367718a5d9f0e521863d1f23 (patch) | |
| tree | 8665922608eaebd7c266b4ed12db3f48bd90c9d5 | |
| parent | 05966e80afcd212dbad514b8b36cca65562a99e8 (diff) | |
| download | qpid-python-6ae4a2b06f2cb409367718a5d9f0e521863d1f23.tar.gz | |
QPID-4160: remove old documentation for management components that have previously been deleted
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@1380383 13f79535-47bb-0310-9956-ffa450edef68
31 files changed, 0 insertions, 1842 deletions
diff --git a/doc/book/src/java-broker/AMQP-Messaging-Broker-Java-Book.xml b/doc/book/src/java-broker/AMQP-Messaging-Broker-Java-Book.xml index 632778fab3..cb1354ad47 100644 --- a/doc/book/src/java-broker/AMQP-Messaging-Broker-Java-Book.xml +++ b/doc/book/src/java-broker/AMQP-Messaging-Broker-Java-Book.xml @@ -65,11 +65,4 @@ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="How-to-Use-SlowConsumerDisconnect.xml"/> </chapter> - -<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Qpid-JMX-Management-Console.xml"/> - -<chapter id="QpidJavaBroker-ManagementTools"> -<title>Management Tools</title> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Qpid-Java-Broker-Management-CLI.xml"/> -</chapter> </book> diff --git a/doc/book/src/java-broker/Configuring-Management-Users.xml b/doc/book/src/java-broker/Configuring-Management-Users.xml deleted file mode 100644 index a2a8d46d88..0000000000 --- a/doc/book/src/java-broker/Configuring-Management-Users.xml +++ /dev/null @@ -1,117 +0,0 @@ -<?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 Management Users - </title><para> - The Qpid Java broker has a single source of users for the system. - So a user can connect to the broker to send messages and via the - JMX console to check the state of the broker. - </para><para> - - </para> - - <section role="h2" id="ConfiguringManagementUsers-Addinganewmanagementuser"><title> - Adding - a new management user - </title> - <para> - The broker does have some minimal configuration available to - limit which users can connect to the JMX console and what they - can do when they are there. - </para><para> - There are two steps required to add a new user with rights for - the JMX console. - </para><orderedlist> - <listitem><para>Create a new user login, see HowTo:<xref linkend="qpid_Add-New-Users"/> - </para></listitem> - <listitem><para>Grant the new user permission to the JMX Console - </para></listitem> - </orderedlist> - - <section role="h3" id="ConfiguringManagementUsers-GrantingJMXConsolePermissions"><title> - Granting - JMX Console Permissions - </title> - <para> - By default new users do not have access to the JMX console. The - access to the console is controlled via the file - <emphasis>jmxremote.access</emphasis>. - </para><para> - This file contains a mapping from user to privilege. - </para><para> - There are three privileges available: - </para><orderedlist> - <listitem><para>readonly - The user is able to log in and view queues but not - make any changes. - </para></listitem> - <listitem><para>readwrite - Grants user ability to read and write queue - attributes such as alerting values. - </para></listitem> - <listitem><para>admin - Grants the user full access including ability to edit - Users and JMX Permissions in addition to readwrite access. - </para></listitem> - </orderedlist><para> - This file is read at start up and can forcibly be reloaded by an - admin user through the management console. - </para> -<!--h3--></section> - - <section role="h3" id="ConfiguringManagementUsers-AccessFileFormat"><title> - Access - File Format - </title> - <para> - The file is a standard Java properties file and has the following - format - </para> - <programlisting> -<username>=<privilege> -</programlisting> - <para> - If the username value is not a valid user (list in the specified - PrincipalDatabase) then the broker will print a warning when it - reads the file as that entry will have no meaning. - </para><para> - Only when the the username exists in both the access file and the - PrincipalDatabase password file will the user be able to login - via the JMX Console. - </para><section role="h4" id="ConfiguringManagementUsers-ExampleFile"><title> - Example File - </title> - <para> - The file will be timestamped by the management console if edited - through the console. - </para> - <programlisting> -#Generated by JMX Console : Last edited by user:admin -#Tue Jun 12 16:46:39 BST 2007 -admin=admin -guest=readonly -user=readwrite -</programlisting> - -<!--h4--></section> -<!--h3--></section> -<!--h2--></section> -</section> diff --git a/doc/book/src/java-broker/Configuring-Qpid-JMX-Management-Console.xml b/doc/book/src/java-broker/Configuring-Qpid-JMX-Management-Console.xml deleted file mode 100644 index 72e4ba8969..0000000000 --- a/doc/book/src/java-broker/Configuring-Qpid-JMX-Management-Console.xml +++ /dev/null @@ -1,181 +0,0 @@ -<?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 <MC4J-Installation>/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->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->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> diff --git a/doc/book/src/java-broker/Management-Console-Security.xml b/doc/book/src/java-broker/Management-Console-Security.xml deleted file mode 100644 index 31f63c70da..0000000000 --- a/doc/book/src/java-broker/Management-Console-Security.xml +++ /dev/null @@ -1,251 +0,0 @@ -<?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> - Management Console Security - </title><section role="h1" id="ManagementConsoleSecurity-ManagementConsoleSecurity"><title> - Management - Console Security - </title> - <itemizedlist> - <listitem><para> - <xref linkend="ManagementConsoleSecurity-SSLencryptedRMI-280.5andabove-29"/> - </para></listitem> - <listitem><para> - <xref linkend="ManagementConsoleSecurity-JMXMP-28M4andprevious-29"/> - </para></listitem> - <listitem><para> - <xref linkend="ManagementConsoleSecurity-UserAccounts-26AccessRights"/> - </para></listitem> - </itemizedlist> - <section role="h2" id="ManagementConsoleSecurity-SSLencryptedRMI-280.5andabove-29"><title> - SSL - encrypted RMI (0.5 and above) - </title> - <para> - Current versions of the broker make use of SSL encryption to - secure their RMI based JMX ConnectorServer for security purposes. - This ships enabled by default, although the test SSL keystore - used during development is not provided for security reasons - (using this would provide no security as anyone could have access - to it). - </para><section role="h3" id="ManagementConsoleSecurity-BrokerConfiguration"><title> - Broker - Configuration - </title> - - <para> - The broker configuration must be updated before the broker will - start. This can be done either by disabling the SSL support, - utilizing a purchased SSL certificate to create a keystore of - your own, or generating a self-signed keystore. - </para><para> - The broker must be configured with a keystore containing the - private and public keys associated with its SSL certificate. This - is accomplished by setting the Java environment properties - <emphasis>javax.net.ssl.keyStore</emphasis> and - <emphasis>javax.net.ssl.keyStorePassword</emphasis> respectively with the - location and password of an appropriate SSL keystore. Entries for - these properties exist in the brokers main configuration file - alongside the other management settings (see below), although the - command line options will still work and take precedence over the - configuration file. - </para> - <programlisting> -<management> - <ssl> - <enabled>true</enabled> - <!-- Update below path to your keystore location, eg ${conf}/qpid.keystore --> - <keyStorePath>${conf}/qpid.keystore</keyStorePath> - <keyStorePassword>password</keyStorePassword> - </ssl> -</management> -</programlisting> -<!--h3--></section> - - <section role="h3" id="ManagementConsoleSecurity-JMXManagementConsoleConfiguration"><title> - JMX - Management Console Configuration - </title> - - <para> - If the broker makes use of an SSL certificate signed by a known - signing CA (Certification Authority), the management console - needs no extra configuration, and will make use of Java's - built-in CA - truststore for certificate verification (you may however have to - update the system-wide default truststore if your CA is not - already present in it). - </para><para> - If however you wish to use a self-signed SSL certificate, then - the management console must be provided with an SSL truststore - containing a record for the SSL certificate so that it is able to - validate it when presented by the broker. This is performed by - setting the <emphasis>javax.net.ssl.trustStore</emphasis> and - <emphasis>javax.net.ssl.trustStorePassword</emphasis> environment variables - when starting the console. This can be done at the command line, - or alternatively an example configuration has been made within - the console's qpidmc.ini launcher configuration file that may - pre-configured in advance for repeated usage. See the <xref linkend="Qpid-JMX-Management-Console-User-Guide"/> for more - information on this configuration process. - </para> -<!--h3--></section> - - <section role="h3" id="ManagementConsoleSecurity-JConsoleConfiguration"><title> - JConsole - Configuration - </title> - - <para> - As with the JMX Management Console above, if the broker is using - a self-signed SSL certificate then in order to connect remotely - using JConsole, an appropriate trust store must be provided at - startup. See <xref linkend="qpid_JConsole"/> for further details on configuration. - </para> -<!--h3--></section> - - <section role="h3" id="ManagementConsoleSecurity-AdditionalInformation"><title> - Additional - Information - </title> - - <para> - More information on Java's handling of SSL certificate - verification and customizing the keystores can be found in the - <ulink url="http://java.sun.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#CustomizingStores">http://java.sun.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#CustomizingStores</ulink>. - </para> -<!--h3--></section> -<!--h2--></section> - - - - <section role="h2" id="ManagementConsoleSecurity-JMXMP-28M4andprevious-29"><title> - JMXMP - (M4 and previous) - </title> - - <para> - In previous releases of Qpid (M4 and below) the broker, can make - use of Sun's Java Management Extensions Messaging Protocol - (JMXMP) to provide encryption of the JMX connection, offering - increased security over the default unencrypted RMI based JMX - connection. - </para><section role="h3" id="ManagementConsoleSecurity-DownloadandInstall"><title> - Download and - Install - </title> - - <para> - This is possible by adding the jmxremote_optional.jar as provided - by Sun. This jar is covered by the Sun Binary Code License and is - not compatible with the Apache License which is why this - component is not bundled with Qpid. - </para><para> - Download the JMX Remote API 1.0.1_04 Reference Implementation - from <xref linkend="qpid_download.jsp"/>. The included - 'jmxremote-1_0_1-bin\lib\jmxremote_optional.jar' file must be - added to the broker classpath: - </para><para> - First set your classpath to something like this: - </para> - <programlisting> -CLASSPATH=jmxremote_optional.jar -</programlisting> - <para> - Then, run qpid-server passing the following additional flag: - </para> - <programlisting> -qpid-server -run:external-classpath=first -</programlisting> - <para> - Following this the configuration option can be updated to enabled - use of the JMXMP based JMXConnectorServer. - </para> -<!--h3--></section> - - <section role="h3" id="ManagementConsoleSecurity-BrokerConfiguration2"><title> - Broker - Configuration - </title> - - <para> - To enabled this security option change the - <emphasis>security-enabled</emphasis> value in your broker configuration - file. - </para> - <programlisting> - <management> - <security-enabled>true</security-enabled> - </management> -</programlisting> - <para> - You may also (for M2 and earlier) need to set the following - system properties using the environment variable QPID_OPTS: - </para><para> - QPID_OPTS="-Dcom.sun.management.jmxremote - -Dcom.sun.management.jmxremote.port=8999 - -Dcom.sun.management.jmxremote.authenticate=false - -Dcom.sun.management.jmxremote.ssl=false" - </para> -<!--h3--></section> - - <section role="h3" id="ManagementConsoleSecurity-JMXManagementConsoleConfiguration-2"><title> - JMX - Management Console Configuration - </title> - - <para> - If you wish to connect to a broker configured to use JMXMP then - the console also requires provision of the Optional sections of - the JMX Remote API that are not included within the JavaSE - platform. - </para><para> - In order to make it available to the console, place the - 'jmxremote_optional.jar' (rename the file if any additional - information is present in the file name) jar file within the - 'plugins/jmxremote.sasl_1.0.1/' folder of the console release (on - Mac OS X you will need to select 'Show package contents' from the - context menu whilst selecting the management console bundle in - order to reveal the inner file tree). - </para><para> - Following the the console will automatically load the JMX Remote - Optional classes and attempt the JMXMP connection when connecting - to a JMXMP enabled broker. - </para> -<!--h3--></section> -<!--h2--></section> - - <section role="h2" id="ManagementConsoleSecurity-UserAccounts-26AccessRights"><title> - User - Accounts & Access Rights - </title> - - <para> - In order to access the management operations via JMX, users must - have an account and have been assigned appropriate access rights. - See <xref linkend="qpid_Configuring-Management-Users"/> - </para> -<!--h2--></section> -<!--h1--></section> - - -</section> diff --git a/doc/book/src/java-broker/Qpid-JMX-Management-Console-FAQ.xml b/doc/book/src/java-broker/Qpid-JMX-Management-Console-FAQ.xml deleted file mode 100644 index 1806ab01b1..0000000000 --- a/doc/book/src/java-broker/Qpid-JMX-Management-Console-FAQ.xml +++ /dev/null @@ -1,96 +0,0 @@ -<?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> - Qpid JMX Management Console FAQ - </title> -<!-- -h3. {toggle-cloak:id=qManagementConsoleSecurity} How do I connect the management console to my broker using security ? -{cloak:id=qManagementConsoleSecurity} - -The [Management Console Security] page will give you the instructions that you should use to set this up. -{cloak} - - -h3. {toggle-cloak:id=rmiServerHostname} I am unable to connect Qpid JMX MC/JConsole to a remote broker running on Linux, but connecting to localhost on that machine works ? -{cloak:id=rmiServerHostname} - -The RMI based JMX ConnectorServer used by the broker requries two ports to operate. The console connects to an RMI Registry running on the primary (default 8999) port and retrieves the information actually needed to connect to the JMX Server. This information embeds the hostname of the remote machine, and if this is incorrect or unreachable by the connecting client the connection will fail. - -This situation arises due to the hostname configuration on Linux and is generally encountered when the remote machine does not have a DNS hostname entry on the local network, causing the hostname command to return a loopback IP instead of a fully qualified domain name or IP address accessible by remote client machines. It is described in further detail at: http://java.sun.com/javase/6/docs/technotes/guides/management/faq.html#linux1 - -To remedy this issue you can set the _java.rmi.server.hostname_ system property to control the hostname/ip reported to the RMI runtime when advertising the JMX ConnectorServer. This can also be used to dictate the address returned on a computer with multiple network interfaces to control reachability. To do so, add the value _-Djava.rmi.server.hostname=<desired hostname/ip>_ to the QPID_OPTS environment variable before starting the _qpid-server_ script. ---> - - <section role="h2" id="QpidJMXManagementConsoleFAQ-Errors"><title> - Errors - </title> - - <section role="h3" id="QpidJMXManagementConsoleFAQ-HowdoIconnectthemanagementconsoletomybrokerusingsecurity-3F"><title> - How do I connect the management console to - my broker using security ? - </title> - - <para> - The <xref linkend="qpid_Management-Console-Security"/> page will give you the instructions that you should - use to set this up. - </para> -<!--h3--></section> - - <section role="h3" id="QpidJMXManagementConsoleFAQ-IamunabletoconnectQpidJMXMC-2FJConsoletoaremotebrokerrunningonLinux-2Cbutconnectingtolocalhostonthatmachineworks-3F"><title> - I am unable to connect Qpid JMX MC/JConsole - to a remote broker running on Linux, but connecting to localhost - on that machine works ? - </title> - - <para> - The RMI - based JMX ConnectorServer used by the broker requries two ports - to operate. The console connects to an RMI Registry running on - the primary (default 8999) port and retrieves the information - actually needed to connect to the JMX Server. This information - embeds the hostname of the remote machine, and if this is - incorrect or unreachable by the connecting client the connection - will fail. - </para><para> - This - situation arises due to the hostname configuration on Linux and - is generally encountered when the remote machine does not have a - DNS hostname entry on the local network, causing the hostname - command to return a loopback IP instead of a fully qualified - domain name or IP address accessible by remote client machines. - It is described in further detail at: <xref linkend="qpid_faq"/> - </para><para> - To - remedy this issue you can set the - <emphasis>java.rmi.server.hostname</emphasis> system property to control the - hostname/ip reported to the RMI runtime when advertising the JMX - ConnectorServer. This can also be used to dictate the address - returned on a computer with multiple network interfaces to - control reachability. To do so, add the value - <emphasis>-Djava.rmi.server.hostname=<desired hostname/ip></emphasis> - to the QPID_OPTS environment variable before starting the - <emphasis>qpid-server</emphasis> script. - </para> -<!--h3--></section> -<!--h2--></section> -</section> diff --git a/doc/book/src/java-broker/Qpid-JMX-Management-Console-User-Guide.xml b/doc/book/src/java-broker/Qpid-JMX-Management-Console-User-Guide.xml deleted file mode 100644 index 35bb5dfbe8..0000000000 --- a/doc/book/src/java-broker/Qpid-JMX-Management-Console-User-Guide.xml +++ /dev/null @@ -1,793 +0,0 @@ -<?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="Qpid-JMX-Management-Console-User-Guide"><title> - Qpid JMX Management Console User Guide - </title><section role="h1" id="QpidJMXManagementConsoleUserGuide-QpidJMXManagementConsoleUserGuide"><title> - Qpid JMX Management Console User Guide - </title> - - - <para> - - The Qpid JMX Management Console is a standalone Eclipse RCP - application for managing and monitoring the Qpid Java server - utilising its JMX management interfaces. - </para><para> - This guide will give an overview of configuring the console, the - features supported by it, and how to make use of the console in - managing the various JMX Management Beans (MBeans) offered by the - Qpid Java server. - </para> -<!--h1--></section> - - - <section role="h1" id="QpidJMXManagementConsoleUserGuide-Startup-26Configuration"><title> - - Startup & Configuration - </title> - - <para> - - </para> - <section role="h2" id="QpidJMXManagementConsoleUserGuide-Startup"><title> - Startup - </title> - - <para> - - The console can be started in the following way, depending on - platform: - </para><itemizedlist> - <listitem><para> - <emphasis>Windows:</emphasis> by running the <emphasis>qpidmc.exe</emphasis> executable - file. - </para></listitem> - <listitem><para> - <emphasis>Linux:</emphasis> by running the <emphasis>qpidmc</emphasis> executable. - </para></listitem> - <listitem><para> - <emphasis>Mac OS X:</emphasis> by launching the <emphasis>Qpid Management - Console.app</emphasis> application bundle. - </para></listitem> - </itemizedlist><para> - - </para> - </section> - - - <section role="h2" id="QpidJMXManagementConsoleUserGuide-SSLconfiguration"><title> - SSL - configuration - </title> - - <para> - - Newer Qpid Java servers can protect their JMX connections with - SSL, and this is enabled by default. When attempting to connect - to a server with this enabled, the console must be able to verify - the SSL certificate presented to it by the server or the - connection will fail. - </para><para> - If the server makes use of an SSL certificate signed by a known - Signing CA (Certification Authority) then the console needs no - extra configuration, and will make use of Java's default - system-wide CA TrustStore for certificate verification (you may - however have to update the system-wide default CA TrustStore if - your certified is signed by a less common CA that is not already - present in it). - </para><para> - If however the server is equipped with a self-signed SSL - certificate, then the management console must be provided with an - appropriate SSL TrustStore containing the public key for the SSL - certificate, so that it is able to validate it when presented by - the server. The server ships with a script to create an example - self-signed SSL certificate, and store the relevant entries in a - KeyStore and matching TrustStore. This script can serve as a - guide on how to use the Java Keytool security utility to - manipulate your own stores, and more information can be found in - the JSSE Reference Guide: - <ulink url="http://java.sun.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#CustomizingStores">http://java.sun.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#CustomizingStores</ulink>. - </para><para> - Supplying the necessary details to the console is performed by - setting the <emphasis>javax.net.ssl.trustStore</emphasis> and - <emphasis>javax.net.ssl.trustStorePassword</emphasis> environment variables - when starting it. This can be done at the command line, but the - preferred option is to set the configuration within the - <emphasis>qpidmc.ini</emphasis> launcher configuration file for repeated - usage. This file is equipped with a template to ease - configuration, this should be uncommented and edited to suit your - needs. It can be found in the root of the console releases for - Windows, and Linux. For Mac OS X the file is located within the - consoles <emphasis>.app</emphasis> application bundle, and to locate and edit - it you must select <emphasis>'Show Package Contents'</emphasis> when - accessing the context menu of the application, then browse to the - <emphasis>Contents/MacOS</emphasis> sub folder to locate the file. - </para> -<!--h2--></section> - - <section role="h2" id="QpidJMXManagementConsoleUserGuide-JMXMPconfiguration"><title> - JMXMP - configuration - </title> - - <para> - - Older releases of the Qpid Java server can make use of the Java - Management Extensions Messaging Protocol (JMXMP) to provide - protection for their JMX connections. This occurs when the server - has its main configuration set with the management - <emphasis>'security-enabled'</emphasis> property set to true. - </para><para> - In order to connect to this configuration of server, the console - needs an additional library that is not included within the Java - SE platform and cannot be distributed with the console due to - licensing restrictions. - </para><para> - You can download the JMX Remote API 1.0.1_04 Reference - Implementation from the Sun website <xref linkend="qpid_download.jsp"/>. The included - <emphasis>jmxremote-1_0_1-bin/lib/jmxremote_optional.jar</emphasis> file must - be added to the <emphasis>plugins/jmxremote.sasl_1.0.1</emphasis> folder of - the console release (again, in Mac OS X you will need to select - <emphasis>'Show package contents'</emphasis> from the context menu whilst - selecting the management console bundle in order to reveal the - inner file tree). - </para><para> - Following this the console will automatically load the JMX Remote - Optional classes and negotiate the SASL authentication profile - type when encountering a JMXMP enabled Qpid Java server. - </para> -<!--h2--></section> -<!--h1--></section> - <section role="h1" id="QpidJMXManagementConsoleUserGuide-ManagingServerConnections"><title> - - Managing Server Connections - </title> - - <para> - - </para> - <section role="h2" id="QpidJMXManagementConsoleUserGuide-MainToolbar"><title> - Main Toolbar - </title> - - <para> - - The main toolbar of the console can be seen in the image below. - The left most buttons respectively allow for adding a new server - connection, reconnecting to an existing server selected in the - connection tree, disconnecting the selected server connection, - and removing the server from the connection tree. - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113098.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - - - Beside these buttons is a combo for selecting the refresh - interval; that is, how often the console requests updated - information to display for the currently open area in the main - view. Finally, the right-most button enables an immediate update. - </para> - </section> - - <section role="h2" id="QpidJMXManagementConsoleUserGuide-Connectingtoanewserver"><title> - Connecting - to a new server - </title> - - <para> - - To connect to a new server, press the <emphasis>Add New Server</emphasis> - toolbar button, or select the <emphasis>Qpid Manager -> Add New - Connection</emphasis> menu item. At this point a dialog box will be - displayed requesting the server details, namely the server - hostname, management port, and a username and password. An - example is shown below: - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113099.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - - Once all the required details are entered, pressing Connect will - initiate a connection attempt to the server. It the attempt fails - a reason will be shown and the server will not be added to the - connection tree. If the attempt is successful the server will be - added to the connections list and the entry expanded to show the - initial administration MBeans the user has access to and any - VirtualHosts present on the server, as can be seen in the figure - below. - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113100.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - - If the server supports a newer management API than the console in - use, once connected this initial screen will contain a message on - the right, indicating an upgraded console should be sought by the - user to ensure all management functionality supported by the - server is being utilised. - </para> -<!--h2--></section> - - <section role="h2" id="QpidJMXManagementConsoleUserGuide-Reconnectingtoaserver"><title> - Reconnecting - to a server - </title> - - <para> - - If a server has been connected to previously, it will be saved as - an entry in the connection tree for further use. On subsequent - connections the server can simply be selected from the tree and - using the <emphasis>Reconnect</emphasis> toolbar button or <emphasis>Qpid Manager - -> Reconnect</emphasis> menu item. At this stage the console will - prompt simply for the username and password with which the user - wishes to connect, and following a successful connection the - screen will appear as shown previously above. - </para> -<!--h2--></section> - - - <section role="h2" id="QpidJMXManagementConsoleUserGuide-Disconnectingfromaserver"><title> - Disconnecting - from a server - </title> - - <para> - - To disconnect from a server, select the connection tree node for - the server and press the <emphasis>Disconnect</emphasis> toolbar button, or - use the <emphasis>Qpid Manager -> Disconnect</emphasis> menu option. - </para> -<!--h2--></section> - - <section role="h2" id="QpidJMXManagementConsoleUserGuide-Removingaserver"><title> - Removing a - server - </title> - - <para> - - To remove a server from the connection list, select the - connection tree node for the server and press the <emphasis>Remove</emphasis> - toolbar button, or use the <emphasis>Qpid Manager -> Remove - Connection</emphasis> menu option. - </para> -<!--h2--></section> -<!--h1--></section> - - - <section role="h1" id="QpidJMXManagementConsoleUserGuide-Navigatingaconnectedserver"><title> - Navigating a connected server - </title> - - <para> - - Once connected to a server, the various areas available for - administration are accessed using the Qpid Connections tree at - the left side of the application. To open a particular MBean from - the tree for viewing, simply select it in the tree and it will be - opened in the main view. - <mediaobject><imageobject><imagedata fileref="images/3113101.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - As there may be vast numbers of Queues, Connections, and - Exchanges on the server these MBeans are not automatically added - to the tree along with the general administration MBeans. - Instead, dedicated selection areas are provided to allow users to - select which Queue/Connection/Exchange they wish to view or add - to the tree. These areas can be found by clicking on the - Connections, Exchanges, and Queues nodes in the tree under each - VirtualHost, as shown in the figure above. One or more MBeans may - be selected and added to the tree as Favourites using the button - provided. These settings are saved for future use, and each time - the console connects to the server it will check for the presence - of the MBean previously in the tree and add them if they are - still present. Queue/Connection/Exchange MBeans can be removed - from the tree by right clicking on them to expose a context menu - allowing deletion. - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113102.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - As an alternative way to open a particular MBean for viewing, - without first adding it to the tree, you can simply double click - an entry in the table within the Queue/Connection/Exchange - selection areas to open it immediately. It is also possible to - open some MBeans like this whilst viewing certain other MBeans. - When opening an MBean in either of these ways, a Back button is - enabled in the top right corner of the main view. Using this - button will return you to the selection area or MBean you were - previously viewing. The history resets each time the tree is used - to open a new area or MBean. - </para> -<!--h1--></section> - - - <section role="h1" id="QpidJMXManagementConsoleUserGuide-ConfigurationManagementMBean"><title> - - ConfigurationManagement MBean - </title> - - <para> - - The ConfigurationManagement MBean is available on newer servers, - to users with admin level management rights. It offers the - ability to perform a live reload of the <emphasis>Security</emphasis> - sections defined in the main server configuration file (e.g. - defaults to: <emphasis>etc/config.xml</emphasis>). This is mainly to allow - updating the server Firewall configuration to new settings - without a restart, and can be performed by clicking the Execute - button and confirming the prompt which follows. - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113103.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para> -<!--h1--></section> - - <section role="h1" id="QpidJMXManagementConsoleUserGuide-LoggingManagementMBean"><title> - - LoggingManagement MBean - </title> - - <para> - - The LoggingManagement MBean is available on newer servers, and - accessible by admin level users. It allows live alteration of the - logging behaviour, both at a Runtime-only level and at the - configuration file level. The latter can optionally affect the - Runtime configuration, either through use of the servers - automated LogWatch ability which detects changes to the - configuration file and reloads it, or by manually requesting a - reload. This functionality is split across two management tabs, - Runtime Options and ConfigurationFile Options. - </para> - <section role="h2" id="QpidJMXManagementConsoleUserGuide-RuntimeOptions"><title> - Runtime - Options - </title> - - <para> - - <mediaobject><imageobject><imagedata fileref="images/3113104.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - The Runtime Options tab allows manipulation of the logging - settings without affecting the configuration files (this means - the changes will be lost when the server restarts), and gives - individual access to every Logger active within the server. - </para><para> - As shown in the figure above, the table in this tab presents the - Effective Level of each Logger. This is because the Loggers form - a hierarchy in which those without an explicitly defined (in the - logging configuration file) Level will inherit the Level of their - immediate parent; that is, the Logger whose full name is a prefix - of their own, or if none satisfy that condition then the - RootLogger is their parent. As example, take the - <emphasis>org.apache.qpid</emphasis> Logger. It is parent to all those below - it which begin with <emphasis>org.apache.qpid</emphasis> and unless they have - a specific Level of their own, they will inherit its Level. This - can be seen in the figure, whereby all the children Loggers - visible have a level of WARN just like their parent, but the - RootLogger Level is INFO; the children have inherited the WARN - level from <emphasis>org.apache.qpid</emphasis> rather than INFO from the - RootLogger. - </para><para> - To aid with this distinction, the Logger Levels that are - currently defined in the configuration file are highlighted in - the List. Changing these levels at runtime will also change the - Level of all their children which haven't been set their own - Level using the runtime options. In the latest versions of the - LoggingManagement MBean, it is possible to restore a child logger - that has had an explicit level se, to inheriting that of its - parent by setting it to an INHERITED level that removes any - previously set Level of its own. - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113105.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - In order to set one of more Loggers to a new Level, they should - be selected in the table (or double click an individual Logger to - modify it) and the <emphasis>Edit Selected Logger(s)</emphasis> button - pressed to load the dialog shown above. At this point, any of the - available Levels supported by the server can be applied to the - Loggers selected and they will immediately update, as will any - child Loggers without their own specific Level. - </para><para> - The RootLogger can be similarly edited using the button at the - bottom left of the window. - </para> -<!--h2--></section> - - <section role="h2" id="QpidJMXManagementConsoleUserGuide-ConfigurationFileOptions"><title> - ConfigurationFile - Options - </title> - - <para> - - The ConfigurationFile Options tab allows alteration of the Level - settings for the Loggers defined in the configuration file, - allowing changes to persist following a restart of the server. - Changes made to the configuration file are only applied - automatically while the sever is running if it was configured to - enable the LogWatch capability, meaning it will monitor the - configuration file for changes and apply the new configuration - when the change is detected. If this was not enabled, the changes - will be picked up when the server is restarted. The status of the - LogWatch feature is shown at the bottom of the tab. - Alternatively, in the latest versions of the LoggingManagement - MBean it is possible to reload the logging configuration file on - demand. - </para><para> - Manipulating the Levels is as on the Runtime Options tab, either - double-click an individual Logger entry or select multiple - Loggers and use the button to load the dialog to set the new - Level. - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113106.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - One issue to note of when reloading the configuration file - settings, either automatically using LogWatch or manually, is - that any Logger set to a specific Level using the Runtime Options - tab that is not defined in the configuration file will maintain - that Level when the configuration file is reloaded. In other - words, if a Logger is defined in the configuration file, then the - configuration file will take precedence at reload, otherwise the - Runtime options take precedence. - </para><para> - This situation will be immediately obvious by examining the - Runtime Options tab to see the effective Level of each Logger - – unless it has been altered with the RuntimeOptions or - specifically set in the configuration file, a Logger Level should - match that of its parent. In the latest versions of the - LoggingManagement MBean, it is possible to use the RuntimeOptions - to restore a child logger to inheriting from its parent by - setting it with an INHERITED level that removes any previously - set Level of its own. - - </para> -<!--h2--></section> -<!--h1--></section> - - - - <section role="h1" id="QpidJMXManagementConsoleUserGuide-ServerInformationMBean"><title> - ServerInformation MBean - </title> - - <para> - - <mediaobject><imageobject><imagedata fileref="images/3113107.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - The ServerInformation MBean currently only conveys various pieces - of version information to allow precise identification of the - server version and its management capabilities. In future it is - likely to convey additional server-wide details and/or - functionality. - </para> -<!--h1--></section> - - <section role="h1" id="QpidJMXManagementConsoleUserGuide-UserManagementMBean"><title> - - UserManagement MBean - </title> - - <para> - - The UserManagement MBean is accessible by admin level users, and - allows manipulation of existing user accounts and creation of new - user accounts. - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113108.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - - To add a new user, press the <emphasis>Add New User</emphasis> button, which - will load the dialog shown below. - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113109.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - Here you may enter the new users Username, Password, and select - their JMX Management Rights. This controls whether or not they - have access to the management interface, and if so what - capabilities are accessible. <emphasis>Read Only</emphasis> access allows - undertaking any operations that do not alter the server state, - such as viewing messages. <emphasis>Read + Write</emphasis> access allows use - of all operations which are not deemed admin-only (such as those - in the UserManagement MBean itself). <emphasis>Admin</emphasis> access allows - a user to utilize any operation, and view the admin-only MBeans - (currently these are ConfigurationManagement, LoggingManagement, - and UserManagement). - </para><para> - One or more users at a time may be deleted by selecting them in - the table and clicking the <emphasis>Delete User(s)</emphasis> button. The - console will then prompt for confirmation before undertaking the - removals. Similarly, the access rights for one or more users may - be updated by selecting them in the table and clicking the - <emphasis>Set Rights</emphasis> button. The console will then display a - dialog enabling selection of the new access level and - confirmation to undertake the update. - </para><para> - An individual user password may be updated by selecting the user - in the table in and clicking the <emphasis>Set Password</emphasis> button. - The console will then display a dialog enabling input of the new - password and confirmation to undertake the update. - </para><para> - - The server caches the user details in memory to aid performance. - If may sometimes be necessary to externally modify the password - and access right files on disk. In order for these changes to be - known to the server without a restart, it must be instructed to - reload the file contents. This can be done using the provided - <emphasis>Reload User Details</emphasis> button (on older servers, only the - management rights file is reloaded, on newer servers both files - are. The description on screen will indicate the behaviour). - After pressing this button the console will seek confirmation - before proceeding. - </para> -<!--h1--></section> - - - <section role="h1" id="QpidJMXManagementConsoleUserGuide-VirtualHostManagerMBean"><title> - - VirtualHostManager MBean - </title> - - <para> - - Each VirtualHost in the server has an associated - VirtualHostManager MBean. This allows viewing, creation, and - deletion of Queues and Exchanges within the VirtualHost. - </para><para> - Clicking the <emphasis>Create</emphasis> button in the Queue section will - open a dialog allowing specification of the Name, Owner - (optional), and durability properties of the new Queue, and - confirmation of the operation. - </para><para> - One or more Queues may be deleted by selecting them in the table - and clicking the <emphasis>Delete</emphasis> button. This will unregister the - Queue bindings, remove the subscriptions and delete the Queue(s). - The console will prompt for confirmation before undertaking the - operation. - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113110.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - Clicking the <emphasis>Create</emphasis> button in the Exchange section will - open a dialog allowing specification of the Name, Type, and - Durable attributes of the new Exchange, and confirmation of the - operation. - </para><para> - One or more Exchanges may be deleted by selecting them in the - table and clicking the <emphasis>Delete</emphasis> button. This will - unregister all the related channels and Queue bindings then - delete the Exchange(s). The console will prompt for confirmation - before undertaking the operation. - </para><para> - - Double-clicking on a particular Queue or Exchange name in the - tables will open the MBean representing it. - </para> -<!--h1--></section> - - - - <section role="h1" id="QpidJMXManagementConsoleUserGuide-Notifications"><title> - - Notifications - </title> - - <para> - - MBeans on the server can potentially send Notifications that - users may subscribe to. When managing an individual MBean that - offers Notifications types for subscription, the console supplies - a Notifications tab to allow (un)subscription to the - Notifications if desired and viewing any that are received - following subscription. - </para><para> - In order to provide quicker access to/awareness of any received - Notifications, each VirtualHost area in the connection tree has a - Notifications area that aggregates all received Notifications for - MBeans in that VirtualHost. An example of this can be seen in the - figure below. - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113111.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - All received Notifications will be displayed until such time as - the user removes them, either in this aggregated view, or in the - Notifications area of the individual MBean that generated the - Notification. - </para><para> - They may be cleared selectively or all at once. To clear - particular Notifications, they should be selected in the table - before pressing the <emphasis>Clear</emphasis> button. To clear all - Notifications, simply press the <emphasis>Clear</emphasis> button without - anything selected in the table, at which point the console will - request confirmation of this clear-all action. - </para> -<!--h1--></section> - - <section role="h1" id="QpidJMXManagementConsoleUserGuide-ManagingQueues"><title> - Managing - Queues - </title> - - <para> - - As mentioned in earlier discussion of Navigation, Queue MBeans - can be opened either by double clicking an entry in the Queues - selection area, or adding a queue to the tree as a favourite and - clicking on its tree node. Unique to the Queue selection screen - is the ability to view additional attributes beyond just that of - the Queue Name. This is helpful for determining which Queues - satisfy a particular condition, e.g. having <X> messages on - the queue. The example below shows the selection view with - additional attributes <emphasis>Consumer Count, Durable, MessageCount, - and QueueDepth</emphasis> (selected using the <emphasis>Select - Attributes</emphasis> button at the bottom right corner of the - table)<emphasis>.</emphasis> - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113112.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - Upon opening a Queue MBean, the Attributes tab is displayed, as - shown below. This allows viewing the value all attributes, - editing those which are writable values (highlighted in blue) if - the users management permissions allow, viewing descriptions of - their purpose, and graphing certain numerical attribute values as - they change over time. - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113113.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - The next tab contains the operations that can be performed on the - queue. The main table serves as a means of viewing the messages - on the queue, and later for selecting specific messages to - operate upon. It is possible to view any desired range of - messages on the queue by specifying the visible range using the - fields at the top and pressing the <emphasis>Set</emphasis> button. Next to - this there are helper buttons to enable faster browsing through - the messages on the queue; these allow moving forward and back by - whatever number of messages is made visible by the viewing range - set. The Queue Position column indicates the position of each - message on the queue, but is only present when connected to newer - servers as older versions cannot provide the necessary - information to show this (unless only a single message position - is requested). - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113114.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - Upon selecting a message in the table, its header properties and - redelivery status are updated in the area below the table. Double - clicking a message in the table (or using the <emphasis>View Message - Content</emphasis> button to its right) will open a dialog window - displaying the contents of the message. - </para><para> - One or more messages can be selected in the table and moved to - another queue in the VirtualHost by using the <emphasis>Move - Message(s)</emphasis> button, which opens a dialog to enable selection - of the destination and confirmation of the operation. Newer - servers support the ability to similarly copy the selected - messages to another queue in a similar fashion, or delete the - selected messages from the queue after prompting for - confirmation. - </para><para> - Finally, all messages (that have not been acquired by consumers) - on the queue can be deleted using the <emphasis>Clear Queue</emphasis> - button, which will generate a prompt for confirmation. On newer - servers, the status bar at the lower left of the application will - report the number of messages actually removed. - </para> -<!--h1--></section> - - - <section role="h1" id="QpidJMXManagementConsoleUserGuide-ManagingExchanges"><title> - - Managing Exchanges - </title> - - <para> - Exchange MBeans are opened for management operations in similar - fashion as described for Queues, again showing an Attributes tab - initially, with the Operations tab next: - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113115.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - Of the four default Exchange Types <emphasis>(direct, fanout, headers, - and topic)</emphasis> all but <emphasis>headers</emphasis> have their bindings - presented in the format shown above. The left table provides the - binding/routing keys present in the exchange. Selecting one of - these entries in the table prompts the right table to display all - the queues associated with this key. Pressing the <emphasis>Create</emphasis> - button opens a dialog allowing association of an existing queue - with the entered Binding. - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113116.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - The <emphasis>headers</emphasis> Exchange type (default instantiation - <emphasis>amq.match or amq.headers</emphasis>) is presented as below: - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113117.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - In the previous figure, the left table indicates the binding - number, and the Queue associated with the binding. Selecting one - of these entries in the table prompts the right table to display - the header values that control when the binding matches an - incoming message. - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113118.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - </para><para> - Pressing the <emphasis>Create</emphasis> button when managing a - <emphasis>headers</emphasis> Exchange opens a dialog allowing creation of a - new binding, associating an existing Queue with a particular set - of header keys and values. The <emphasis>x-match</emphasis> key is required, - and instructs the server whether to match the binding with - incoming messages based on ANY or ALL of the further key-value - pairs entered. If it is desired to enter more than 4 pairs, you - may press the <emphasis>Add additional field</emphasis> button to create a - new row as many times as is required. - - When managing a <emphasis>headers</emphasis> Exchange, double clicking an - entry in the left-hand table will open the MBean for the Queue - specified in the binding properties. - </para><para> - When managing another Exchange Type, double clicking the Queue - Name in the right-hand table will open the MBean of the Queue - specified. - </para> -<!--h1--></section> - - <section role="h1" id="QpidJMXManagementConsoleUserGuide-ManagingConnections"><title> - - Managing Connections - </title> - - <para> - - Exchange MBeans are opened for management operations in similar - fashion as described for Queues, again showing an Attributes tab - initially, with the Operations tab next, and finally a - Notifications tab allowing subscription and viewing of - Notifications. The Operations tab can be seen in the figure - below. - </para><para> - <mediaobject><imageobject><imagedata fileref="images/3113119.png" format="PNG" scalefit="1"/></imageobject><textobject><phrase/></textobject><caption><para/></caption></mediaobject> - The main table shows the properties of all the Channels that are - present on the Connection, including whether they are - <emphasis>Transactional</emphasis>, the <emphasis>Number of Unacked Messages</emphasis> - on them, and the <emphasis>Default Queue</emphasis> if there is one (or - <emphasis>null</emphasis> if there is not). - </para><para> - The main operations supported on a connection are Commiting and - Rolling Back of Transactions on a particular Channel, if the - Channel is Transactional. This can be done by selecting a - particular Channel in the table and pressing the <emphasis>Commit - Transactions</emphasis> or <emphasis>Rollback Transactions</emphasis> buttons at - the lower right corner of the table, at which point the console - will prompt for confirmation of the action. These buttons are - only active when the selected Channel in the table is - Transactional. - </para><para> - The final operation supported is closing the Connection. After - pressing the <emphasis>Close Connection</emphasis> button, the console will - prompt for confirmation of the action. If this is carried out, - the MBean for the Connection being managed will be removed from - the server. The console will be notified of this by the server - and display an information dialog to that effect, as it would if - any other MBean were to be unregistered whilst being viewed. - </para><para> - Double clicking a row in the table will open the MBean of the - associated <emphasis>Default Queue</emphasis> if there is one. - </para> - -<!--h1--></section> -</section> diff --git a/doc/book/src/java-broker/Qpid-JMX-Management-Console.xml b/doc/book/src/java-broker/Qpid-JMX-Management-Console.xml deleted file mode 100644 index fb46f4a01a..0000000000 --- a/doc/book/src/java-broker/Qpid-JMX-Management-Console.xml +++ /dev/null @@ -1,53 +0,0 @@ -<?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. - ---> - -<chapter id="Qpid-JMX-Management-Console"> - - <title> - Qpid JMX Management Console - </title> - - <section role="h2" id="QpidJMXManagementConsole-QpidJMXManagementConsole"> - - <title> Qpid JMX Management Console </title> - - <section role="h3" id="QpidJMXManagementConsole-Overview"> - - <title> - Overview - </title> - - <para> - The Qpid JMX Management Console is a standalone Eclipse - RCP application that communicates with the broker using - JMX. - </para> - - <xi:include href="Configuring-Management-Users.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <xi:include href="Configuring-Qpid-JMX-Management-Console.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <xi:include href="Management-Console-Security.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <xi:include href="Qpid-JMX-Management-Console-FAQ.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <xi:include href="Qpid-JMX-Management-Console-User-Guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <xi:include href="Qpid-Management-Features.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> -<!--h3--></section> -<!--h2--></section> -</chapter> diff --git a/doc/book/src/java-broker/Qpid-Java-Broker-Management-CLI.xml b/doc/book/src/java-broker/Qpid-Java-Broker-Management-CLI.xml deleted file mode 100644 index 84c4b7b7a4..0000000000 --- a/doc/book/src/java-broker/Qpid-Java-Broker-Management-CLI.xml +++ /dev/null @@ -1,159 +0,0 @@ -<?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="Qpid-Java-Broker-Management-CLI"><title> - Qpid Java Broker Management CLI - </title> - <section role="h2" id="QpidJavaBrokerManagementCLI-HowtobuildApacheQpidCLI"><title> - How to - build Apache Qpid CLI - </title> - - - <section role="h3" id="QpidJavaBrokerManagementCLI-BuildInstructionsGeneral"><title> - Build - Instructions - General - </title> - - <para> - At the very beginning please build Apache Qpid by refering this - installation guide from here <xref linkend="qpid_qpid-java-build-how-to"/>. - </para><para> - After successfully build Apache Qpid you'll be able to start - Apache Qpid Java broker,then only you are in a position to use - Qpid CLI. - </para> -<!--h3--></section> - - <section role="h3" id="QpidJavaBrokerManagementCLI-CheckouttheSource"><title> - Check - out the Source - </title> - - <para> - First check out the source from subversion repository. Please - visit the following link for more information about different - versions of Qpid CLI. - </para><para> - <xref linkend="qpid_list"/> - </para> -<!--h3--></section> - - <section role="h3" id="QpidJavaBrokerManagementCLI-Prerequisites"><title> - Prerequisites - </title> - - <para> - For the broker code you need JDK 1.5.0_15 or later. You should - set JAVA_HOME and include the bin directory in your PATH. - </para><para> - Check it's ok by executing java -v ! - </para> -<!--h3--></section> - - <section role="h3" id="QpidJavaBrokerManagementCLI-BuildingApacheQpidCLI"><title> - Building - Apache Qpid CLI - </title> - - <para> - This project is currently having only an ant build system.Please - install ant build system before trying to install Qpid CLI. - </para> -<!--h3--></section> - - - - <section role="h3" id="QpidJavaBrokerManagementCLI-Compiling"><title> - Compiling - </title> - - <para> - To compile the source please run following command - </para> - <programlisting> -ant compile -</programlisting> - <para> - To compile the test source run the following command - </para> - <programlisting> -ant compile-tests -</programlisting> -<!--h3--></section> - - - <section role="h3" id="QpidJavaBrokerManagementCLI-RunningCLI"><title> - Running CLI - </title> - - <para> - After successful compilation set QPID_CLI environment variable to - the main source directory.(set the environment variable to the - directory where ant build script stored in the SVN - checkout).Please check whether the Qpid Java broker is up an - running in the appropriate location and run the following command - to start the Qpid CLI by running the qpid-cli script in the bin - directory. - </para><para> - $QPID_CLI/bin/qpid-cli -h <hostname of the broker> -p - <broker running port> - For more details please have a look in to README file which ships - with source package of Qpid CLI. - </para> -<!--h3--></section> - - - <section role="h3" id="QpidJavaBrokerManagementCLI-Otheranttargets"><title> - Other - ant targets - </title> - - <para>For now we are supporting those ant targets.</para> - - <variablelist> - <varlistentry> - <term>ant clean</term> - <listitem><para>Clean the complete build including CLI build and test build.</para></listitem> - </varlistentry> - <varlistentry> - <term>ant jar</term> - <listitem><para>Create the jar file for the project without test cases.</para></listitem> - </varlistentry> - <varlistentry> - <term>ant init</term> - <listitem><para>Create the directory structure for build.</para></listitem> - </varlistentry> - <varlistentry> - <term>ant compile-tests </term> - <listitem><para>This compiles all the test source.</para></listitem> - </varlistentry> - <varlistentry> - <term>ant test </term> - <listitem><para>Run all the test cases.</para></listitem> - </varlistentry> - - </variablelist> - -<!--h3--></section> -<!--h2--></section> -</section> diff --git a/doc/book/src/java-broker/Qpid-Management-Features.xml b/doc/book/src/java-broker/Qpid-Management-Features.xml deleted file mode 100644 index c90d7e97c6..0000000000 --- a/doc/book/src/java-broker/Qpid-Management-Features.xml +++ /dev/null @@ -1,185 +0,0 @@ -<?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> - Qpid Management Features - </title> - <para> - <emphasis>Management tool:</emphasis> See our <xref linkend="qpid_Qpid-JMX-Management-Console"/> for - details of how to use various console options with the Qpid - management features. - </para> - <para> - The management of QPID is categorised into following types- - </para> - <orderedlist> - <listitem><para>Exchange - </para></listitem> - <listitem><para>Queue - </para></listitem> - <listitem><para>Connection - </para></listitem> - <listitem><para>Broker - </para></listitem> - </orderedlist> - <para> - <emphasis>1) Managing and Monitoring Exchanges</emphasis>: Following is - the list of features, which we can have available for managing - and monitoring an Exchange running on a Qpid Server Domain- - </para> - <orderedlist> - <listitem><para>Displaying the following information for monitoring purpose- - <orderedlist> - <listitem><para>The list of queues bound to the exchange along with the - routing keys. - </para></listitem> - <listitem><para> - General Exchange properties(like name, - durable etc). - </para></listitem> - </orderedlist> - </para></listitem> - <listitem><para> - Binding an existing queue with the - exchange. - </para></listitem> - </orderedlist> - <para> - <emphasis>2) Managing and Monitoring - Queues</emphasis>: Following are the - features, which we can have for a Queue on a Qpid Server - Domain- - </para> - <orderedlist> - <listitem><para> - Displaying the following information about - the queue for monitoring purpose- - <orderedlist> - <listitem><para> - General Queue properties(like name, - durable, etc.) - </para></listitem> - <listitem><para> - The maximum size of a message that can - be accepted from the message producer. - </para></listitem> - <listitem><para> - The number of the active consumers - accessing the Queue. - </para></listitem> - <listitem><para> - The total number of - consumers (Active and Suspended). - </para></listitem> - <listitem><para> - The number of undelivered messages - in the Queue. - </para></listitem> - <listitem><para> - The total number of messages received - on the Queue since startup. - </para></listitem> - <listitem><para> - The maximum number of bytes for - the Queue that can be stored on the Server. - </para></listitem> - <listitem><para>The maximum number of messages for the Queue that can be - stored on the Server. - </para></listitem> - </orderedlist> - </para></listitem> - <listitem><para> - Viewing the messages on the Queue. - </para></listitem> - <listitem><para> - Deleting message from top of the - Queue. - </para></listitem> - <listitem><para> - Clearing the Queue. - </para></listitem> - <listitem><para> - Browsing the DeadMessageQueue - Messages - which are expired or undelivered because of some reason are - routed to the DeadMessageQueue. This queue can not be - deleted. [Note: The is open because it depends on how - these kind of messages will be handeled?] - </para></listitem> - </orderedlist> - <para> - <emphasis>3) Managing and Monitoring - Connections</emphasis>: Following are the - features, which we can have for a connection on a QPID - Server Domain- - </para> - <orderedlist> - <listitem><para> - Displaying general connection - properties(like remote address, etc.). - </para></listitem> - <listitem><para>Setting maximum number of channels allowed for a - connection. - </para></listitem> - <listitem><para>View all related channels and channel properties. - </para></listitem> - <listitem><para>Closing a channel. - </para></listitem> - <listitem><para>Commit or Rollback transactions of a channel, if the channel - is transactional. - </para></listitem> - <listitem><para>Notification for exceeding the maximum number of - channels. - </para></listitem> - <listitem><para>Dropping a connection. - </para></listitem> - <listitem><para>The work for <xref linkend="qpid_Network-IO-Interface"/> implies that - there are potentially some additional requirements - <orderedlist> - <listitem><para>Alert when tcp flow control kicks in - </para></listitem> - <listitem><para>Information available about current memory usage - available through JMX interface - </para></listitem> - <listitem><para>Dynamic removal of buffer bounds? (fundamentally not - possible with TransportIO) - </para></listitem> - <listitem><para>Management functionality added to JMX interface - UI - changes? - </para></listitem> - </orderedlist> - </para></listitem> - </orderedlist> - <para> - <emphasis>4) Managing the Broker</emphasis>: Features for the Broker- - </para> - <orderedlist> - <listitem><para>Creating an Exchange. - </para></listitem> - <listitem><para>Unregistering an Exchange. - </para></listitem> - <listitem><para>Creating a Queue. - </para></listitem> - <listitem><para>Deleting a Queue. - </para></listitem> - </orderedlist> -</section> diff --git a/doc/book/src/java-broker/images/3113098.png b/doc/book/src/java-broker/images/3113098.png Binary files differdeleted file mode 100644 index 7de85030c6..0000000000 --- a/doc/book/src/java-broker/images/3113098.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113099.png b/doc/book/src/java-broker/images/3113099.png Binary files differdeleted file mode 100644 index fb6fc65d73..0000000000 --- a/doc/book/src/java-broker/images/3113099.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113100.png b/doc/book/src/java-broker/images/3113100.png Binary files differdeleted file mode 100644 index a7d727b854..0000000000 --- a/doc/book/src/java-broker/images/3113100.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113101.png b/doc/book/src/java-broker/images/3113101.png Binary files differdeleted file mode 100644 index 30731277c2..0000000000 --- a/doc/book/src/java-broker/images/3113101.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113102.png b/doc/book/src/java-broker/images/3113102.png Binary files differdeleted file mode 100644 index f150a21b10..0000000000 --- a/doc/book/src/java-broker/images/3113102.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113103.png b/doc/book/src/java-broker/images/3113103.png Binary files differdeleted file mode 100644 index a91efb4306..0000000000 --- a/doc/book/src/java-broker/images/3113103.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113104.png b/doc/book/src/java-broker/images/3113104.png Binary files differdeleted file mode 100644 index c5ef12d8b1..0000000000 --- a/doc/book/src/java-broker/images/3113104.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113105.png b/doc/book/src/java-broker/images/3113105.png Binary files differdeleted file mode 100644 index b155f9d9a1..0000000000 --- a/doc/book/src/java-broker/images/3113105.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113106.png b/doc/book/src/java-broker/images/3113106.png Binary files differdeleted file mode 100644 index 22bcdd084e..0000000000 --- a/doc/book/src/java-broker/images/3113106.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113107.png b/doc/book/src/java-broker/images/3113107.png Binary files differdeleted file mode 100644 index cf5dd97e89..0000000000 --- a/doc/book/src/java-broker/images/3113107.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113108.png b/doc/book/src/java-broker/images/3113108.png Binary files differdeleted file mode 100644 index c0e5eafde2..0000000000 --- a/doc/book/src/java-broker/images/3113108.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113109.png b/doc/book/src/java-broker/images/3113109.png Binary files differdeleted file mode 100644 index 139d81d849..0000000000 --- a/doc/book/src/java-broker/images/3113109.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113110.png b/doc/book/src/java-broker/images/3113110.png Binary files differdeleted file mode 100644 index 2207f15cd7..0000000000 --- a/doc/book/src/java-broker/images/3113110.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113111.png b/doc/book/src/java-broker/images/3113111.png Binary files differdeleted file mode 100644 index 5737f41caf..0000000000 --- a/doc/book/src/java-broker/images/3113111.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113112.png b/doc/book/src/java-broker/images/3113112.png Binary files differdeleted file mode 100644 index d9ee094ab4..0000000000 --- a/doc/book/src/java-broker/images/3113112.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113113.png b/doc/book/src/java-broker/images/3113113.png Binary files differdeleted file mode 100644 index e80812f83c..0000000000 --- a/doc/book/src/java-broker/images/3113113.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113114.png b/doc/book/src/java-broker/images/3113114.png Binary files differdeleted file mode 100644 index b237181150..0000000000 --- a/doc/book/src/java-broker/images/3113114.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113115.png b/doc/book/src/java-broker/images/3113115.png Binary files differdeleted file mode 100644 index 84ad42b567..0000000000 --- a/doc/book/src/java-broker/images/3113115.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113116.png b/doc/book/src/java-broker/images/3113116.png Binary files differdeleted file mode 100644 index 18b979792f..0000000000 --- a/doc/book/src/java-broker/images/3113116.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113117.png b/doc/book/src/java-broker/images/3113117.png Binary files differdeleted file mode 100644 index 3b33ef67ac..0000000000 --- a/doc/book/src/java-broker/images/3113117.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113118.png b/doc/book/src/java-broker/images/3113118.png Binary files differdeleted file mode 100644 index 60451f88cf..0000000000 --- a/doc/book/src/java-broker/images/3113118.png +++ /dev/null diff --git a/doc/book/src/java-broker/images/3113119.png b/doc/book/src/java-broker/images/3113119.png Binary files differdeleted file mode 100644 index 16ded074bd..0000000000 --- a/doc/book/src/java-broker/images/3113119.png +++ /dev/null |
