QPID-5470: Improve QMF README documentation and update JavaDocs to reflect new location of QMF2 API docs

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

1 files changed, 155 insertions, 8 deletions

diff --git a/qpid/tools/src/java/README.txt b/qpid/tools/src/java/README.txt
index 0755dcd885..28e6176c9a 100644
--- a/qpid/tools/src/java/README.txt
+++ b/qpid/tools/src/java/README.txt
@@ -19,12 +19,163 @@
  *
  */
 
-This is a Java JMS implementation of the QMF2 API specified at
-https://cwiki.apache.org/qpid/qmfv2-api-proposal.html
+********************************************** Introduction ***********************************************
+
+This directory provides a set of Java and JavaScript based tools that allow interaction with the Qpid brokers.
+The tools are based on QMF2 (Qpid Management Framework v2) and work with the C++ broker by default. In order
+to enable QMF2 support in the Java Broker you must compile the QMF plugin (see README-Java-Broker.txt)
+
+The main prerequisite is that The Qpid Java jar needs to be on your classpath - I tend to use qpid-all.jar but
+client only jars should be OK too, it's pretty much built on pure JMS.
+
+In order to build the Java QMF2 API, the tools and the Java Broker QMF2 plugin simply do:
+
+ant all
+
+If you don't want the QMF2 plugin for the Java Broker simply do:
+
+ant
+
+
+N.B. At the moment the QMF2 API and tools use the "traditional" Qpid AMQP 0.10 JMS API. The intention is that
+over time this will migrate to AMQP 1.0 and move from being QMF2 based to using the AMQP 1.0 Management Spec.
+However there is no concrete schedule for this migration at this time.
+
+************************************************* The API *************************************************
+
+The tools are build on a Java JMS implementation of the QMF2 API specified at
+https://cwiki.apache.org/confluence/display/qpid/QMFv2+API+Proposal
+
+When successfully build via "ant all" there is fairly comprehensive JavaDoc available in:
+qpid/tools/src/java/docs/api/index.html
+
+Though looking at the source code for the tools (see "The Tools" below) might be a quicker way to get started.
+
+
+The source code for the Java QMF2 API can be found under:
+qpid/tools/src/java/src/main/java/org/apache/qpid/qmf2/console
+qpid/tools/src/java/src/main/java/org/apache/qpid/qmf2/agent
+qpid/tools/src/java/src/main/java/org/apache/qpid/qmf2/common
+
+console: contains the classes for the QMF2 "console", which is what most of the tools make use of
+agent: contains the classes for the QMF2 "agent", which it what exposes management services, this is
+       what the Java Broker plugin uses to "externalise" its management model as QMF.
+common: contains classes common to both the console and the agent.
+
+************************************************ The Tools ************************************************
+
+There are executable shell scripts that should allow the Java based tools to be run fairly easily in:
+qpid/qpid-trunk/qpid/tools/src/java/bin
+
+The source code for the Java QMF2 API can be found under:
+qpid/tools/src/java/src/main/java/org/apache/qpid/qmf2/tools
+
+The available tools are:
+QpidConfig: Is a Java port of the standard Python based qpid-config tool. This exercises most of the QMF2 API
+            and is probably a good bet to see how things work if you want to use the API in your own projects.
+QpidCtrl: Is a Java port of the qpid-ctrl tool found in qpid/cpp/src/tests. This is a little known, but useful
+          little tool that lets one send low-level QMF constructs from the command line. The JavaDoc is the
+          best place to look for example usage.
+QpidPrintEvents: Is a Java port of the Python qpid-printevents and illustrates the asynchronous delivery
+                 of QMF2 notification events.
+QpidQueueStats: Is a Java port of the Python qpid-queue-stats. This was written mainly to illustrate the use
+                of the QMF2 "QuerySubscription" API that lets one specify how to be asynchronously notified
+                of changes to QMF Management Objects matching a specified set of criteria.
+ConnectionAudit: Is a tool that allows one to audit connections to one or more Qpid brokers. It uses QMF
+                 Events to identify when connections have been made to a broker and if so it logs information
+                 about the connection. A whitelist can be specified to flag connections that you don't
+                 want to have logged (e.g. ones that you like).
+ConnectionLogger: Is similar to ConnectionAudit but a bit simpler this tool just logs connections being made
+                  the tool is mainly there to illustrate how to dereference the associations between the
+                  various QMF Management Objects (Connection, Session, Subscription, Queue, Binding Exchange etc.)
+QueueFuse: Is a tool that monitors QMF Events looking for a QueueThresholdExceeded, which occurs when a queue
+           gets more than 80% full. When this Event occurs the tool sends a QMF method to "purge" 10% of the
+           messages off the offending queue, i.e. it acts rather like a fuse. It's mainly a bit of a toy, but
+           it's a pretty good illustration of how to trigger QMF method invocation from QMF Events. It would
+           be pretty easy to modify this to redirect messages to a different queue if a particular queue fills.
+QpidRestAPI: This is a Web Service that exposes QMF2 via a REST API see "The GUI" section below.
+
+************************************************* The GUI *************************************************
+
+There is a fairly comprehensive Web based GUI available for Qpid that works with the C++ Broker and also the
+Java Broker if the QMF plugin has been installed (see README-Java-Broker.txt).
+
+The GUI is in the form of a pure client side "single page" Web App written in JavaScript that uses the
+QpidRestAPI to proxy the QMF API. QpidRestAPI also serves up the GUI.
+
+There is comprehensive JavaDoc for the QpidRestAPI, the most useful classes to look at are:
+QpidRestAPI: This describes the various command line options available.
+QpidServer: This provides documentation for the actual REST API itself, in effect the REST mapping for QMF
+
+QpidRestAPI provides a fairly complete REST mapping for QMF, it was primarily written as the back-end to
+the GUI, but there's no reason why it couldn't be used in its own right.
+
+
+To get started, the simplest and probably most common use case can be kicked of simply by firing up the
+REST API via:
+./QpidRestAPI
+
+This will bind the HTTP port to 8080 on the "wildcard" address (0.0.0.0). The QMF connection will default to
+the host that QpidRestAPI is running on and use the default AMQP port 5672.
+
+If you point a Browser to <host>:8080 the GUI should start up asking for a User Name and Password, the
+defaults for those are the rather "traditional" admin admin.
+
+
+If you have a non-trivial broker set-up you'll probably see "Failed to Connect", which is most likely due
+to having authentication enabled (you can check this by firing up the C++ broker using qpidd --auth no)
+
+
+There are a few ways to configure the Brokers that you can control via the GUI:
+The first way is to specify the -a (or --broker-addr) command line option e.g.
+./QpidRestAPI -a guest/guest@localhost
+
+This option accepts the Broker Address syntax used by the standard Python tools and it also accepts the
+Java ConnectionURL syntax specified here (though to be honest the syntax used by the Python tools is simpler)
+http://qpid.apache.org/releases/qpid-0.24/programming/book/QpidJNDI.html#section-jms-connection-url
+
+
+This way of specifying the AMQP address of the default broker that you want to manage is probably the best
+approach, but it is possible to add as many QMF Console Connections as you like by clicking
+"Add QMF Console Connection" on the GUI Settings page. The popup lets you specify the Address URL such as
+"guest/guest@host:5672" - again it also accepts the JMS Connection URLs, though I only use them if I'm
+doing a copy/paste of an existing Connection URL.
+The Name is simply a "friendly name" that you want to use to identify a particular Broker.
+
+
+Clearly if you want to be able to manage a number of brokers you'd probably prefer not to have to enter
+them every time you fire up the GUI - particularly because the list gets wiped if you hit refresh :-)
+
+The good news is that the initial set of Console Connections is configurable via the file:
+qpid/tools/src/java/bin/qpid-web/web/ui/config.js
+
+
+This is a simple JSON file and it contains example Console Connection configuration including a fairly complex one
+
+If you use this mechanism to configure the GUI you can quickly switch between however many Brokers
+you'd like to be able to control.
+
+
+As mentioned above the default User Name and Password are admin and admin, these are set in the file
+qpid/tools/src/java/bin/qpid-web/authentication/account.properties
+
+
+It's worth pointing out that at the moment authentication is limited to basic uthentication. This is mainly
+due to lack of time/energy/motivation to do anything fancier (I only tend to use it on a private network)
+I also had a need to minimise dependencies, so the Web Server is actually based on the Java 1.6
+com.sun.net.httpserver Web Server.
+
+
+In practice though basic authentication shouldn't be as much of a restriction as it might sound especially
+if you're only managing a single Broker.
+
+When one fires up QpidRestAPI with the -a option the Broker connection information does not pass between the
+GUI and the QpidRestAPI so it's ultimately no less secure than using say qpid-config in this case though
+note that if one configures multiple Brokers via config.js the contents of that file get served to the GUI
+when it gets loaded so you probably want to restrict use of the GUI to the same network you'd be happy to
+run qpid-config from.
 
-The Qpid Java jar needs to be on your classpath - I tend to use qpid-all.jar but client only jars should be OK too.
 
-QMF2 support is now available for the Qpid Java Broker see README-Java-Broker.txt for details.
 
 
 
@@ -87,7 +238,3 @@ to put the patched AMQMessageDelegate_0_10 ahead of the unpatched one. This is a
 call the various test and tool classes.
 
 
-
-
-
-