docs/book/src/old/QMan-Qpid-Management-bridge.xml

<?xml version="1.0" encoding="utf-8"?>
<!--
 
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
 distributed with this work for additional information
 regarding copyright ownership.  The ASF licenses this file
 to you under the Apache License, Version 2.0 (the
 "License"); you may not use this file except in compliance
 with the License.  You may obtain a copy of the License at
 
   http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing,
 software distributed under the License is distributed on an
 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 
-->

<section><title>
      QMan - Qpid Management bridge
    </title><section role="h1" id="QMan-QpidManagementbridge-QMan-3AQpidManagementBridge"><title>
            QMan
            : Qpid Management Bridge
          </title>
           <para>
            QMan is a management bridge for Qpid. It allows external clients
            to manage and monitor one or more Qpid brokers.
          </para>
	  <para>
            Please note: All WS-DM related concerns have to be considered
            part of M5 release.
          </para><para>
            QMan exposes the broker management interfaces using Java
            Management Extensions (JMX) and / or OASIS Web Services
            Distributed Management (WSDM). While the first one is supposed to
            be used by java based clients only the latter is an interoperable
            protocol that enables management clients to access and receive
            notifications of management-enabled resources using Web Services.
          </para><para>
            QMan can be easily integrated in your preexisting system in
            different ways :
          </para><itemizedlist>
            <listitem><para>As a standalone application : in this case it runs as a
            server. More specifically it enables communication via RMI (for
            JMX) or via HTTP (for WS-DM); Note that when the WS-DM adapter is
            used the JMX interface is not exposed;
            </para></listitem>
            <listitem><para>As a deployable unit : it is also available as a standard
            Java web application (war); This is useful when there's a
            preexisting Application Server in your environment and you don't
            want start another additional server in order to run QMan.
            </para></listitem>
          </itemizedlist>

	  <section role="h2" id="QMan-QpidManagementbridge-UserDocumentation"><title>
            User
            Documentation
          </title>
           <para>
            With "User Documentation" we mean all information that you need
            to know in order to use QMan from a user perspective. Those
            information include :
          </para><table><title/><tgroup cols="2">
            <tbody>
              <row>
                <entry>
                  Section
                </entry>
                <entry>
                  Description
                </entry>
              </row>
              <row>
                <entry>
                  <xref linkend="qpid_Get-me-up-and-running"/>
                </entry>
                <entry>
                  How to install &amp; start QMan.
                </entry>
              </row>
              <row>
                <entry>
                  <xref linkend="qpid_QMan-User-Guide"/>
                </entry>
                <entry>
                  QMan (WS-DM version only) Administration Console.
                </entry>
              </row>
              <row>
                <entry>
                  <xref linkend="qpid_JMX-Interface-Specification"/>
                </entry>
                <entry>
                  Describes each JMX interface exposed by QMan.
                </entry>
              </row>
              <row>
                <entry>
                  <xref linkend="qpid_WS-DM-Interface-Specification"/>
                </entry>
                <entry>
                  Describes each WS-DM interface exposed by QMan.
                </entry>
              </row>
              <row>
                <entry>
                  <xref linkend="qpid_QMan-Messages-Catalogue"/>
                </entry>
                <entry>
                  Informational / Debug / Error / Warning messages catalogue.
                </entry>
              </row>
            </tbody>
          </tgroup></table>
	  <!--h2--></section>


	  <section role="h2" id="QMan-QpidManagementbridge-TechnicalDocumentation"><title>
            Technical
            Documentation
          </title>
           <para>
            If you are interested in technical details about QMan and related
            technologies this is a good starting point. In general this
            section provides information about QMan design, interfaces,
            patterns and so on...
          </para>

	  <table><title/><tgroup cols="2">
            <tbody>
              <row>
                <entry>
                  Section
                </entry>
                <entry>
                  Description
                </entry>
              </row>
              <row>
                <entry>
                  <xref linkend="qpid_QMan-System-Overview"/>
                </entry>
                <entry>
                  A short introduction about QMan deployment context.
                </entry>
              </row>
              <row>
                <entry>
                  <xref linkend="qpid_QMan-Components-View"/>
                </entry>
                <entry>
                  Describes QMan components, their interactions and
                  responsibilities.
                </entry>
              </row>
            </tbody>
          </tgroup></table>
            
<!--h2--></section>
<!--h1--></section>

</section>