Added: qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html?rev=1632181&view=auto ============================================================================== --- qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html (added) +++ qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html Wed Oct 15 21:29:55 2014 @@ -0,0 +1,138 @@ +<!DOCTYPE html> +<!-- + - + - 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. + - +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en"> + <head> + <title>6.5. AMQP Intrinstic Management - Apache Qpid™</title> + <meta http-equiv="X-UA-Compatible" content="IE=edge"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <link rel="stylesheet" href="/site.css" type="text/css" async="async"/> + <link rel="stylesheet" href="/deferred.css" type="text/css" defer="defer"/> + <script type="text/javascript">var _deferredFunctions = [];</script> + <script type="text/javascript" src="/deferred.js" defer="defer"></script> + <!--[if lte IE 8]> + <link rel="stylesheet" href="/ie.css" type="text/css"/> + <script type="text/javascript" src="/html5shiv.js"></script> + <![endif]--> + </head> + <body> + <div id="-content"> + <div id="-top" class="panel"> + <a id="-menu-link"><img width="16" height="16" src="data:image/png;base64," alt="Menu"/></a> + + <a id="-search-link"><img width="22" height="16" src="data:image/png;base64," alt="Search"/></a> + + <ul id="-global-navigation"> + <li><a id="-logotype" href="/index.html">Apache Qpid<sup>™</sup></a></li> + <li><a href="/download.html">Download</a></li> + <li><a href="/documentation.html">Documentation</a></li> + <li><a href="/discussion.html">Discussion</a></li> + <li><a href="/issues.html">Issues</a></li> + <li><a href="/source-code.html">Source Code</a></li> + <li><a href="/resources.html">More Resources</a></li> + </ul> + </div> + + <div id="-menu" class="panel" style="display: none;"> + <section> + <h3>Project</h3> + + <ul> + <li><a href="/overview.html">Overview</a></li> + <li><a href="/proton/index.html">Qpid Proton</a></li> + <li><a href="/contributors.html">Contributors</a></li> + <li><a href="/get-involved.html">Get involved</a></li> + </ul> + </section> + + <section> + <h3>Software</h3> + + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/documentation.html">Documentation</a></li> + <li><a href="/components/index.html">Components</a></li> + <li><a href="/releases/index.html">Releases</a></li> + </ul> + </section> + + <section> + <h3>Resources</h3> + + <ul> + <li><a href="/discussion.html">Discussion</a></li> + <li><a href="/issues.html">Issues</a></li> + <li><a href="/source-code.html">Source code</a></li> + <li><a href="/resources.html">More resources</a></li> + </ul> + </section> + + <section> + <h3>More</h3> + + <ul> + <li><a href="/amqp.html">AMQP</a></li> + <li><a href="/developer.html">Developer central</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/qpid/";>Wiki</a></li> + </ul> + </section> + </div> + + <div id="-search" class="panel" style="display: none;"> + <form action="http://www.google.com/search"; method="get"> + <input type="hidden" name="sitesearch" value="qpid.apache.org"/> + <input type="text" name="q" maxlength="255" autofocus="autofocus" tabindex="1"/> + <button type="submit">Search</button> + <p><a href="/search.html">More ways to search</a></p> + </form> + </div> + + <div id="-middle" class="panel"> + <ul id="-path-navigation"><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-trunk/index.html">Qpid Trunk</a></li><li><a href="/releases/qpid-trunk/java-broker/book/index.html">AMQP Messaging Broker (Java)</a></li><li>6.5. AMQP Intrinstic Management</li></ul> + <div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">6.5. AMQP Intrinstic Management</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Channel-JMX.html">Prev</a> </td><th align="center" width="60%">Chapter 6. Management Channels</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Channel-QMF.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Channel-AMQP-Intrinstic"></a>6.5. AMQP Intrinstic Management</h2></div></div></div><p>The AMQP protocols 0-8..0-10 allow for creation, deletion and query of Exchanges, Queue + and Bindings.</p><p>The exact details of how to utilise this commands depends of the client. See the + documentation accompanying the client for details.</p></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Management-Channel-JMX.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Channel.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Channel-QMF.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">6.4. JMX Management </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 6.6. QMF</td></tr></table></div></div> + + <hr/> + + <ul id="-apache-navigation"> + <li><a href="http://www.apache.org/";>Apache</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks!</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/";><img id="-apache-feather" width="48" height="14" src="data:image/png;base64," alt="Apache"/></a></li> + </ul> + + <p id="-legal"> + Apache Qpid, Messaging built on AMQP; Copyright © 2013 + The Apache Software Foundation; Licensed under + the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache + License, Version 2.0</a>; Apache Qpid, Qpid, Qpid Proton, + Proton, Apache, the Apache feather logo, and the Apache Qpid + project logo are trademarks of The Apache Software + Foundation; All other marks mentioned may be trademarks or + registered trademarks of their respective owners + </p> + </div> + </div> + </body> +</html>
Added: qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-JMX.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-JMX.html?rev=1632181&view=auto ============================================================================== --- qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-JMX.html (added) +++ qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-JMX.html Wed Oct 15 21:29:55 2014 @@ -0,0 +1,273 @@ +<!DOCTYPE html> +<!-- + - + - 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. + - +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en"> + <head> + <title>6.4. JMX Management - Apache Qpid™</title> + <meta http-equiv="X-UA-Compatible" content="IE=edge"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <link rel="stylesheet" href="/site.css" type="text/css" async="async"/> + <link rel="stylesheet" href="/deferred.css" type="text/css" defer="defer"/> + <script type="text/javascript">var _deferredFunctions = [];</script> + <script type="text/javascript" src="/deferred.js" defer="defer"></script> + <!--[if lte IE 8]> + <link rel="stylesheet" href="/ie.css" type="text/css"/> + <script type="text/javascript" src="/html5shiv.js"></script> + <![endif]--> + </head> + <body> + <div id="-content"> + <div id="-top" class="panel"> + <a id="-menu-link"><img width="16" height="16" src="data:image/png;base64," alt="Menu"/></a> + + <a id="-search-link"><img width="22" height="16" src="data:image/png;base64," alt="Search"/></a> + + <ul id="-global-navigation"> + <li><a id="-logotype" href="/index.html">Apache Qpid<sup>™</sup></a></li> + <li><a href="/download.html">Download</a></li> + <li><a href="/documentation.html">Documentation</a></li> + <li><a href="/discussion.html">Discussion</a></li> + <li><a href="/issues.html">Issues</a></li> + <li><a href="/source-code.html">Source Code</a></li> + <li><a href="/resources.html">More Resources</a></li> + </ul> + </div> + + <div id="-menu" class="panel" style="display: none;"> + <section> + <h3>Project</h3> + + <ul> + <li><a href="/overview.html">Overview</a></li> + <li><a href="/proton/index.html">Qpid Proton</a></li> + <li><a href="/contributors.html">Contributors</a></li> + <li><a href="/get-involved.html">Get involved</a></li> + </ul> + </section> + + <section> + <h3>Software</h3> + + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/documentation.html">Documentation</a></li> + <li><a href="/components/index.html">Components</a></li> + <li><a href="/releases/index.html">Releases</a></li> + </ul> + </section> + + <section> + <h3>Resources</h3> + + <ul> + <li><a href="/discussion.html">Discussion</a></li> + <li><a href="/issues.html">Issues</a></li> + <li><a href="/source-code.html">Source code</a></li> + <li><a href="/resources.html">More resources</a></li> + </ul> + </section> + + <section> + <h3>More</h3> + + <ul> + <li><a href="/amqp.html">AMQP</a></li> + <li><a href="/developer.html">Developer central</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/qpid/";>Wiki</a></li> + </ul> + </section> + </div> + + <div id="-search" class="panel" style="display: none;"> + <form action="http://www.google.com/search"; method="get"> + <input type="hidden" name="sitesearch" value="qpid.apache.org"/> + <input type="text" name="q" maxlength="255" autofocus="autofocus" tabindex="1"/> + <button type="submit">Search</button> + <p><a href="/search.html">More ways to search</a></p> + </form> + </div> + + <div id="-middle" class="panel"> + <ul id="-path-navigation"><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-trunk/index.html">Qpid Trunk</a></li><li><a href="/releases/qpid-trunk/java-broker/book/index.html">AMQP Messaging Broker (Java)</a></li><li>6.4. JMX Management</li></ul> + <div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">6.4. JMX Management</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Channel-REST-API.html">Prev</a> </td><th align="center" width="60%">Chapter 6. Management Channels</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Channel-AMQP-Intrinstic.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Channel-JMX"></a>6.4. JMX Management</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-JMX-Introduction"></a>6.4.1. Introduction</h3></div></div></div><p>The JMX management plugin provides a series of managed beans (MBeans) allowing you to + control and monitor the Broker via an industry compliant interface. This provides a + convenient integration point for a variety of Infrastructure Monitoring Solutions, + tools such as Jconsole and VisualVM, as well as custom Java programs and scripts.</p><p>The following sections describe how to connect to JMX, the configuration of the JMX + plugin covering topis including securing with SSL, programmatically interacting with + Qpid MBeans and finally a summary of all the MBeans made available from by the + plugin.</p><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Important</h3><p>For new development work, the reader is directed towards the strategic <a class="link" href="Java-Broker-Management-Channel-Web-Console.html" title="6.2. Web Management Console">Web Management + Console</a> and the <a class="link" href="Java-Broker-Management-Channel-REST-API.html" title="6.3. REST API">REST API</a>. Use the + Web/REST interfaces in preference to JMX whenever possible. The JMX interface may be + withdrawn in a future release.</p></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-JMX-Plugin-DefaultConfiguration"></a>6.4.2. Default Configuration</h3></div></div></div><p>By default, the Broker is shipped with JMX enabled.</p><p>The RMI registry port runs on port <code class="literal">8999</code> and the JMX connector on + port <code class="literal">9099</code>. The connector is not SSL protected. Qpid will use the + <a class="ulink" href="http://docs.oracle.com/javase/6/docs/api/java/lang/management/ManagementFactory.html#getPlatformMBeanServer()" target="_top">Platform MBeanServer</a>.</p><p>To change these settings, use the <a class="link" href="Java-Broker-Management-Channel-Web-Console.html" title="6.2. Web Management Console">Web Management + interface</a>.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-JMX-Plugin-ConnectingToJMX"></a>6.4.3. Connecting to JMX</h3></div></div></div><p>The following example uses Jconsole to illustrates how to connect to JMX and assume + the defaults described above. Jconsole is a management tool that comes with the JDK. It + provides a very simple view of the MBeans, but requires no special configuration to be + used with Qpid.</p><p>For full details of Jconsole itself refer to Oracle's <a class="ulink" href="http://java.sun.com/javase/6/docs/technotes/guides/management/jconsole.html"; target="_top">JConsole Guide</a>.</p><p>Jconsole can be used to connect to local or remote Java processes. On startup, it + presents a list of all the Java processes running on the local host and also allows you + to specify a service url to connect to a Java process running on a remote host.</p><p>To start Jconsole on the command line, type:</p><pre class="programlisting">jconsole</pre><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-JMX-Plugin-ConnectingToJMX-Local"></a>6.4.3.1. Local</h4></div></div></div><p>To connect to a Broker running locally, simply select the process from the list. + You can identify the Broker by looking for its classname + <code class="literal">org.apache.qpid.server.Main</code>.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-JMX-Plugin-ConnectingToJMX-Remote"></a>6.4.3.2. Remote</h4></div></div></div><p>To connect to a broker running remotely, provide the hostname and port number of + the <span class="emphasis"><em>RMI registry port</em></span> (e.g. <code class="literal">hostname:8999</code>) + and a valid username and password.</p><p>You can also provide a service url in the form + <code class="literal">service:jmx:rmi:///jndi/rmi://hostname:8999/jmxrmi</code></p><div class="figure"><a id="idp976544"></a><p class="title"><strong>Figure 6.7. Making a remote JMX connection to a Broker using jconsole</strong></p><div class="figure-contents"><div><img alt="Making a remote JMX connection to a Broker using jconsole" src="images/JMX-Connect-Remote.png" /></div></div></div><br class="figure-break" /></div><p>Once you are connected expand the tree of nodes marked + <code class="literal">org.apache.qpid</code> to begin to interact with the Qpid MBeans.</p><div class="figure"><a id="idp979200"></a><p class="title"><strong>Figure 6.8. Qpid MBean hierarchy</strong></p><div class="figure-contents"><div><img alt="Qpid MBean hierarchy" src="images/JMX-Connect-MBeans.png" /></div></div></div><br class="figure-break" /><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-JMX-Plugin-ConnectingToJMX-SSL"></a>6.4.3.3. Connecting to a remote Broker protected by SSL</h4></div></div></div><p>If you are connecting to a remote Broker whose JMX connector port has been secured + with SSL certificate signed by a private CA (or a self-signed certificate), you will + need to pass a trust store and trust store password to Jconsole. If this is + required, start jconsole with the following options:</p><pre class="programlisting">jconsole -J-Djavax.net.ssl.trustStore=jmxtruststore.jks -J-Djavax.net.ssl.trustStorePassword=password</pre></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-JMX-Example-Client"></a>6.4.4. Example JMX Client</h3></div></div></div><p>The following java snippet illustrates a JMX client that connects to Qpid over JMX + passing a userid and password, looks up the <a class="ulink" href="http://svn.apache.org/viewvc/qpid/trunk/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedBroker.java?view=co"; target="_top">ManagedBroker</a> object corresponding to the <code class="literal">myvhost</code> + virtualhost, then invokes a method on the virtualhost to create a new queue.</p><p>A full introduction to custom JMX clients is beyond the scope of this book. For this + the reader is directed toward Oracle's <a class="ulink" href="http://docs.oracle.com/javase/tutorial/jmx/"; target="_top">JMX + tutorial.</a></p><div class="example"><a id="Java-Broker-Management-JMX-Example-Client-Code"></a><p class="title"><strong>Example 6.3. JMX Client illustrating the creation of a new queue</strong></p><div class="example-contents"><pre class="programlisting"> +Map<String, Object< environment = new HashMap<String, Object>(); +environment.put(JMXConnector.CREDENTIALS, new String[] {"admin","password"}); +// Connect to service +JMXServiceURL url = new JMXServiceURL("service:jmx:rmi:///jndi/rmi://localhost:8999/jmxrmi"); +JMXConnector jmxConnector = JMXConnectorFactory.connect(url, environment); +MBeanServerConnection mbsc = jmxConnector.getMBeanServerConnection(); +// Object name for ManagedBroker mbean for virtualhost myvhost +ObjectName objectName = new ObjectName("org.apache.qpid:type=VirtualHost.VirtualHostManager,VirtualHost=\"myvhost\""); +// Get the ManagedBroker object +ManagedBroker managedBroker = JMX.newMBeanProxy(mbsc, objectName, ManagedBroker.class);; + +// Create the queue named "myqueue" +managedBroker.createNewQueue("myqueue", null, true);</pre></div></div><br class="example-break" /><p>The Qpid classes required for a custom JMX client are included in the + <code class="literal">qpid-management-common</code> artefact.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-JMX-MBeans"></a>6.4.5. The MBeans</h3></div></div></div><p>The following table summarises the available MBeans. The MBeans are self-describing: + each attribute and operation carry a description describing their purpose. This + description is visible when using tools such Jconsole. They are also available on + Management interfaces themselves (linked below).</p><div class="table"><a id="idp993248"></a><p class="title"><strong>Table 6.2. Qpid Broker MBeans</strong></p><div class="table-contents"><table border="1" summary="Qpid Broker MBeans"><colgroup><col /><col /></colgroup><thead><tr><th>Management Interface</th><th>Object Name</th></tr></thead><tbody><tr><td rowspan="2"> + <p> + <a class="ulink" href="http://svn.apache.org/viewvc/qpid/trunk/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedBroker.java?view=co"; target="_top">ManagedBroker</a> + </p> + </td><td> + <p> + <code class="literal">org.apache.qpid:type=VirtualHost.VirtualHostManager,VirtualHost="<em class="replaceable"><code>virtualhostname</code></em>"</code> + </p> + </td></tr><tr><td> + <p>MBean corresponding to the named virtualhost. Allows operations + such as the creation/deletion of queues and exchanges on that + virtualhost and virtualhost level statistics.</p> + </td></tr><tr><td rowspan="2"> + <p> + <a class="ulink" href="http://svn.apache.org/viewvc/qpid/trunk/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedQueue.java?view=co"; target="_top">ManagedQueue</a> + </p> + </td><td> + <p> + <code class="literal">org.apache.qpid:type=VirtualHost.Queue,VirtualHost="<em class="replaceable"><code>virtualhostname</code></em>",name="<em class="replaceable"><code>queuename</code></em>"</code> + </p> + </td></tr><tr><td> + <p>MBean corresponding to the named queue on the given virtualhost. + Allows queue management operations such as view message, move + message and clear queue. Exposes attributes such as queue depth and + durability.</p> + </td></tr><tr><td rowspan="2"> + <p> + <a class="ulink" href="http://svn.apache.org/viewvc/qpid/trunk/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedExchange.java?view=co"; target="_top">ManagedExchange</a> + </p> + </td><td> + <p> + <code class="literal">org.apache.qpid:type=VirtualHost.Exchange,VirtualHost="<em class="replaceable"><code>virtualhostname</code></em>",name="<em class="replaceable"><code>amq.direct</code></em>",ExchangeType=<em class="replaceable"><code>type</code></em></code> + </p> + </td></tr><tr><td> + <p>MBean corresponding to the named exchange on the given + virtualhost. Allows exchange management operations such as the + creation and removal of bindings. The supported exchange types are + exposed by the <code class="literal">exchangeTypes</code> attribute of the + virtualhost.</p> + </td></tr><tr><td rowspan="2"> + <p> + <a class="ulink" href="http://svn.apache.org/viewvc/qpid/trunk/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedConnection.java?view=co"; target="_top">ManagedConnection</a> + </p> + </td><td> + <p> + <code class="literal">org.apache.qpid:type=VirtualHost.Connection,VirtualHost="<em class="replaceable"><code>virtualhostname</code></em>",name="<em class="replaceable"><code>/peerid:ephemeralport</code></em>"</code> + </p> + </td></tr><tr><td> + <p>MBean representing a active AMQP connection to the named virtual + host. Name is formed from the IP and ephemeral port of the peer. + Attributes include the client version and connection level + statistics.</p> + </td></tr><tr><td rowspan="2"> + <p> + <a class="ulink" href="http://svn.apache.org/viewvc/qpid/trunk/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/UserManagement.java?view=co"; target="_top">UserManagement</a> + </p> + </td><td> + <p> + <code class="literal">org.apache.qpid:type=UserManagement,name="UserManagement-<em class="replaceable"><code>authentication + manager name</code></em>"</code> + </p> + </td></tr><tr><td> + <p>When using <a class="link" href="Java-Broker-Security.html#Java-Broker-Security-PlainPasswordFile-Provider" title="8.1.6. Plain Password File">Plain + password provider</a> or <a class="link" href="Java-Broker-Security.html#Java-Broker-Security-Base64MD5PasswordFile-Provider" title="8.1.7. Base64MD5 Password File">Base 64 MD5 password provider</a>, permits user operations + such creation and deletion of users. and password changes.</p> + </td></tr><tr><td rowspan="2"> + <p> + <a class="ulink" href="http://svn.apache.org/viewvc/qpid/trunk/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ServerInformation.java?view=co"; target="_top">ServerInformation</a> + </p> + </td><td> + <p> + <code class="literal">org.apache.qpid:type=ServerInformation,name=ServerInformation</code> + </p> + </td></tr><tr><td> + <p>Exposes broker wide statistics, product version number and JMX + management API version number.</p> + </td></tr><tr><td rowspan="2"> + <p> + <a class="ulink" href="http://svn.apache.org/viewvc/qpid/trunk/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/LoggingManagement.java?view=co"; target="_top">LoggingManagement</a> + </p> + </td><td> + <p> + <code class="literal">org.apache.qpid:type=LoggingManagement,name=LoggingManagement</code> + </p> + </td></tr><tr><td> + <p>MBean permitting control of the Broker's logging. Exposes + operations allow the logging level to be controlled at runtime + (without restarting the Broker) and others that allow changes to be + written back to the log4j.xml logging configuration file, or the + contents of the log4.xml file to be re-read at runtime.</p> + </td></tr></tbody></table></div></div><br class="table-break" /></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Management-Channel-REST-API.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Channel.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Channel-AMQP-Intrinstic.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">6.3. REST API </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 6.5. AMQP Intrinstic Management</td></tr></table></div></div> + + <hr/> + + <ul id="-apache-navigation"> + <li><a href="http://www.apache.org/";>Apache</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks!</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/";><img id="-apache-feather" width="48" height="14" src="data:image/png;base64," alt="Apache"/></a></li> + </ul> + + <p id="-legal"> + Apache Qpid, Messaging built on AMQP; Copyright © 2013 + The Apache Software Foundation; Licensed under + the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache + License, Version 2.0</a>; Apache Qpid, Qpid, Qpid Proton, + Proton, Apache, the Apache feather logo, and the Apache Qpid + project logo are trademarks of The Apache Software + Foundation; All other marks mentioned may be trademarks or + registered trademarks of their respective owners + </p> + </div> + </div> + </body> +</html> Added: qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-QMF.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-QMF.html?rev=1632181&view=auto ============================================================================== --- qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-QMF.html (added) +++ qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-QMF.html Wed Oct 15 21:29:55 2014 @@ -0,0 +1,136 @@ +<!DOCTYPE html> +<!-- + - + - 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. + - +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en"> + <head> + <title>6.6. QMF - Apache Qpid™</title> + <meta http-equiv="X-UA-Compatible" content="IE=edge"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <link rel="stylesheet" href="/site.css" type="text/css" async="async"/> + <link rel="stylesheet" href="/deferred.css" type="text/css" defer="defer"/> + <script type="text/javascript">var _deferredFunctions = [];</script> + <script type="text/javascript" src="/deferred.js" defer="defer"></script> + <!--[if lte IE 8]> + <link rel="stylesheet" href="/ie.css" type="text/css"/> + <script type="text/javascript" src="/html5shiv.js"></script> + <![endif]--> + </head> + <body> + <div id="-content"> + <div id="-top" class="panel"> + <a id="-menu-link"><img width="16" height="16" src="data:image/png;base64," alt="Menu"/></a> + + <a id="-search-link"><img width="22" height="16" src="data:image/png;base64," alt="Search"/></a> + + <ul id="-global-navigation"> + <li><a id="-logotype" href="/index.html">Apache Qpid<sup>™</sup></a></li> + <li><a href="/download.html">Download</a></li> + <li><a href="/documentation.html">Documentation</a></li> + <li><a href="/discussion.html">Discussion</a></li> + <li><a href="/issues.html">Issues</a></li> + <li><a href="/source-code.html">Source Code</a></li> + <li><a href="/resources.html">More Resources</a></li> + </ul> + </div> + + <div id="-menu" class="panel" style="display: none;"> + <section> + <h3>Project</h3> + + <ul> + <li><a href="/overview.html">Overview</a></li> + <li><a href="/proton/index.html">Qpid Proton</a></li> + <li><a href="/contributors.html">Contributors</a></li> + <li><a href="/get-involved.html">Get involved</a></li> + </ul> + </section> + + <section> + <h3>Software</h3> + + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/documentation.html">Documentation</a></li> + <li><a href="/components/index.html">Components</a></li> + <li><a href="/releases/index.html">Releases</a></li> + </ul> + </section> + + <section> + <h3>Resources</h3> + + <ul> + <li><a href="/discussion.html">Discussion</a></li> + <li><a href="/issues.html">Issues</a></li> + <li><a href="/source-code.html">Source code</a></li> + <li><a href="/resources.html">More resources</a></li> + </ul> + </section> + + <section> + <h3>More</h3> + + <ul> + <li><a href="/amqp.html">AMQP</a></li> + <li><a href="/developer.html">Developer central</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/qpid/";>Wiki</a></li> + </ul> + </section> + </div> + + <div id="-search" class="panel" style="display: none;"> + <form action="http://www.google.com/search"; method="get"> + <input type="hidden" name="sitesearch" value="qpid.apache.org"/> + <input type="text" name="q" maxlength="255" autofocus="autofocus" tabindex="1"/> + <button type="submit">Search</button> + <p><a href="/search.html">More ways to search</a></p> + </form> + </div> + + <div id="-middle" class="panel"> + <ul id="-path-navigation"><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-trunk/index.html">Qpid Trunk</a></li><li><a href="/releases/qpid-trunk/java-broker/book/index.html">AMQP Messaging Broker (Java)</a></li><li>6.6. QMF</li></ul> + <div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">6.6. QMF</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Channel-AMQP-Intrinstic.html">Prev</a> </td><th align="center" width="60%">Chapter 6. Management Channels</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Managing-Entities.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Channel-QMF"></a>6.6. QMF</h2></div></div></div><p>QMF is provided by an optional plugin.</p></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Management-Channel-AMQP-Intrinstic.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Cha nnel.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Managing-Entities.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">6.5. AMQP Intrinstic Management </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> Chapter 7. Managing Entities</td></tr></table></div></div> + + <hr/> + + <ul id="-apache-navigation"> + <li><a href="http://www.apache.org/";>Apache</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks!</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/";><img id="-apache-feather" width="48" height="14" src="data:image/png;base64," alt="Apache"/></a></li> + </ul> + + <p id="-legal"> + Apache Qpid, Messaging built on AMQP; Copyright © 2013 + The Apache Software Foundation; Licensed under + the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache + License, Version 2.0</a>; Apache Qpid, Qpid, Qpid Proton, + Proton, Apache, the Apache feather logo, and the Apache Qpid + project logo are trademarks of The Apache Software + Foundation; All other marks mentioned may be trademarks or + registered trademarks of their respective owners + </p> + </div> + </div> + </body> +</html> Added: qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-REST-API.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-REST-API.html?rev=1632181&view=auto ============================================================================== --- qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-REST-API.html (added) +++ qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-REST-API.html Wed Oct 15 21:29:55 2014 @@ -0,0 +1,245 @@ +<!DOCTYPE html> +<!-- + - + - 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. + - +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en"> + <head> + <title>6.3. REST API - Apache Qpid™</title> + <meta http-equiv="X-UA-Compatible" content="IE=edge"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <link rel="stylesheet" href="/site.css" type="text/css" async="async"/> + <link rel="stylesheet" href="/deferred.css" type="text/css" defer="defer"/> + <script type="text/javascript">var _deferredFunctions = [];</script> + <script type="text/javascript" src="/deferred.js" defer="defer"></script> + <!--[if lte IE 8]> + <link rel="stylesheet" href="/ie.css" type="text/css"/> + <script type="text/javascript" src="/html5shiv.js"></script> + <![endif]--> + </head> + <body> + <div id="-content"> + <div id="-top" class="panel"> + <a id="-menu-link"><img width="16" height="16" src="data:image/png;base64," alt="Menu"/></a> + + <a id="-search-link"><img width="22" height="16" src="data:image/png;base64," alt="Search"/></a> + + <ul id="-global-navigation"> + <li><a id="-logotype" href="/index.html">Apache Qpid<sup>™</sup></a></li> + <li><a href="/download.html">Download</a></li> + <li><a href="/documentation.html">Documentation</a></li> + <li><a href="/discussion.html">Discussion</a></li> + <li><a href="/issues.html">Issues</a></li> + <li><a href="/source-code.html">Source Code</a></li> + <li><a href="/resources.html">More Resources</a></li> + </ul> + </div> + + <div id="-menu" class="panel" style="display: none;"> + <section> + <h3>Project</h3> + + <ul> + <li><a href="/overview.html">Overview</a></li> + <li><a href="/proton/index.html">Qpid Proton</a></li> + <li><a href="/contributors.html">Contributors</a></li> + <li><a href="/get-involved.html">Get involved</a></li> + </ul> + </section> + + <section> + <h3>Software</h3> + + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/documentation.html">Documentation</a></li> + <li><a href="/components/index.html">Components</a></li> + <li><a href="/releases/index.html">Releases</a></li> + </ul> + </section> + + <section> + <h3>Resources</h3> + + <ul> + <li><a href="/discussion.html">Discussion</a></li> + <li><a href="/issues.html">Issues</a></li> + <li><a href="/source-code.html">Source code</a></li> + <li><a href="/resources.html">More resources</a></li> + </ul> + </section> + + <section> + <h3>More</h3> + + <ul> + <li><a href="/amqp.html">AMQP</a></li> + <li><a href="/developer.html">Developer central</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/qpid/";>Wiki</a></li> + </ul> + </section> + </div> + + <div id="-search" class="panel" style="display: none;"> + <form action="http://www.google.com/search"; method="get"> + <input type="hidden" name="sitesearch" value="qpid.apache.org"/> + <input type="text" name="q" maxlength="255" autofocus="autofocus" tabindex="1"/> + <button type="submit">Search</button> + <p><a href="/search.html">More ways to search</a></p> + </form> + </div> + + <div id="-middle" class="panel"> + <ul id="-path-navigation"><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-trunk/index.html">Qpid Trunk</a></li><li><a href="/releases/qpid-trunk/java-broker/book/index.html">AMQP Messaging Broker (Java)</a></li><li>6.3. REST API</li></ul> + <div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">6.3. REST API</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Channel-Web-Console.html">Prev</a> </td><th align="center" width="60%">Chapter 6. Management Channels</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Channel-JMX.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Channel-REST-API"></a>6.3. REST API</h2></div></div></div><p> This section provides a brief overview of the REST interface, which can be used directly to + monitor and manage the Broker instance.</p><p>The REST interface support traditional REST model which uses the GET method requests to + retrieve the information about broker configured objects, DELETE method requests to delete the + configured object, PUT to create or update the configured object and POST to perform the + configured objects updates not available with the PUT requests.</p><p>The REST API is versioned with the version number built into the URL. The general form of + the URL is <code class="literal">/api/<version></code>. For convenience the alias + <code class="literal">latest</code> signifies the latest supported version. There are also some + ancillary services prefixed by <code class="literal">/service</code>.</p><p>The table below lists the available REST services with brief description how they can be + used.</p><div class="table"><a id="idp643680"></a><p class="title"><strong>Table 6.1. Rest services</strong></p><div class="table-contents"><table border="1" summary="Rest services"><colgroup><col /><col /><col /><col /><col /><col /></colgroup><thead><tr><th>REST Service URL</th><th>Description</th><th>GET</th><th>PUT</th><th>POST</th><th>DELETE</th></tr></thead><tbody><tr><td> + <p>/api/<ver>/broker</p> + </td><td> + <p>Rest service to manage broker instance</p> + </td><td> + <p>Retrieves the details of broker configuration</p> + </td><td> + <p>Updates broker attributes</p> + </td><td> + <p>Not implemented yet</p> + </td><td> + <p>Not implemented yet</p> + </td></tr><tr><td> + <p>/api/<ver>/authenticationprovider</p> + <p>/api/<ver>/authenticationprovider/<authentication provider + name></p> + </td><td>Rest service to manage authentication providers on the broker</td><td>Retrieves the details about authentication providers</td><td>Creates or updates authentication providers</td><td>Not implemented yet</td><td>Deletes authentication providers</td></tr><tr><td> + <p>/api/<ver>/accesscontrolprovider</p> + </td><td>Rest service to manage access control providers</td><td>Retrieves the details about access control providers</td><td>Creates access control provider</td><td>Not implemented yet</td><td>Deletes access control provider(s)</td></tr><tr><td> + <p>/api/<ver>/user</p> + <p>/api/<ver>/user/<authentication provider name>/<user + name></p> + </td><td>Rest service to manage user account</td><td>Retrieves the details about user account</td><td>Creates user account, updates user password</td><td>Not implemented yet</td><td>Deletes user account</td></tr><tr><td> + <p>/api/<ver>/groupprovider</p> + <p>/api/<ver>/groupprovider/<group provider name></p> + </td><td>Rest service to manage group providers</td><td>Retrieves the details about group provider(s)</td><td>Creates group provider</td><td>Not implemented yet</td><td>Deletes groups providers</td></tr><tr><td> + <p>/api/<ver>/group</p> + <p>/api/<ver>/group/<group provider name>/<group name></p> + </td><td>Rest service to manage user group</td><td>Retrieves the details about user group</td><td>Creates group</td><td>Not implemented yet</td><td>Deletes group</td></tr><tr><td> + <p>/api/<ver>/groupmember</p> + <p>/api/<ver>/groupmember/<group provider name >/<group + name>/<user name></p> + </td><td>Rest service to manage group member(s)</td><td>Retrieves the details about group member(s)</td><td>Add user to group</td><td>Not implemented yet</td><td>Deletes user from group</td></tr><tr><td> + <p>/api/<ver>/port</p> + <p>/api/<ver>/port/<port name></p> + </td><td>Rest service to manage broker ports(s)</td><td>Retrieves the details about the broker port(s)</td><td>Creates or updates port</td><td>Not implemented yet</td><td>Deletes ports</td></tr><tr><td> + <p>/api/<ver>/keystore</p> + </td><td>Rest service to manage KeyStores</td><td>Retrieves the details about KeyStore</td><td>Creates or updates KeyStore</td><td>Not implemented yet</td><td>Deletes KeyStore(s)</td></tr><tr><td> + <p>/api/<ver>/truststore</p> + </td><td>Rest service to manage TrustStore</td><td>Retrieves the details about TrustStore</td><td>Creates or updates TrustStore</td><td>Not implemented yet</td><td>Deletes TrustStore(s)</td></tr><tr><td> + <p>/api/<ver>/plugin</p> + </td><td>Rest service to manage plugins</td><td>Retrieves the details about plugins</td><td>Updates plugin attributes</td><td>Not implemented yet</td><td>Not implemented yet</td></tr><tr><td> + <p>/api/<ver>/virtualhostnode</p> + <p>/api/<ver>/virtualhostnode/<virtualhostnode name></p> + </td><td>Rest service to manage virtualhost node(s)</td><td>Retrieves the details about the virtualhost node(s)</td><td>Creates/Updates virtualhost node</td><td>Not implemented yet</td><td>Deletes virtualhost node</td></tr><tr><td> + <p>/api/<ver>/virtualhost</p> + <p>/api/<ver>/virtualhost/<virtualhostnode name>/<virtualhost + name></p> + </td><td>Rest service to manage virtualhost(s)</td><td>Retrieves the details about the virtualhost(s)</td><td>Creates/Updates virtualhost</td><td>Not implemented yet</td><td>Deletes virtualhost</td></tr><tr><td> + <p>/api/<ver>/queue</p> + <p>/api/<ver>/queue/<virtualhostnode name>/<virtualhost + name>/<queue name></p> + </td><td>Rest service to manage queue(s)</td><td>Retrieves the details about the queue(s)</td><td>Creates queue</td><td>Not implemented yet</td><td>Deletes queue</td></tr><tr><td> + <p>/api/<ver>/exchange</p> + <p>/api/<ver>/exchange/<virtualhostnode name>/<virtualhost + name>/<exchange name></p> + </td><td>Rest service to manage exchange(s)</td><td>Retrieves the details about the exchange(s)</td><td>Creates exchange</td><td>Not implemented yet</td><td>Deletes exchange</td></tr><tr><td> + <p>/api/<ver>/binding</p> + <p>/api/<ver>/binding/<virtualhostnode name>/<virtualhost + name>/<exchange name>/<queue name>/<binding name></p> + </td><td>Rest service to manage binding(s)</td><td>Retrieves the details about the binding(s)</td><td>Binds a queue to an exchange</td><td>Not implemented yet</td><td>Deletes binding</td></tr><tr><td> + <p>/api/<ver>/connection</p> + <p>/api/<ver>/connection/<virtualhostnode name>/<virtualhost + name>/<connection name></p> + </td><td>Rest service to manage connection(s)</td><td>Retrieves the details about the connection(s)</td><td>Not implemented yet</td><td>Not implemented yet</td><td>Not implemented yet</td></tr><tr><td> + <p>/api/<ver>/session</p> + <p>/api/<ver>/session/<virtualhostnode name>/<virtualhost + name>/<connection name>/<session name></p> + </td><td>Rest service to manage session(s)</td><td>Retrieves the details about the session(s)</td><td>Not implemented yet</td><td>Not implemented yet</td><td>Not implemented yet</td></tr><tr><td> + <p>/service/message/<virtualhost name>/<queue name></p> + </td><td>Rest service to manage messages(s)</td><td>Retrieves the details about the messages(s)</td><td>Not implemented yet</td><td>Copies, moves messages</td><td>Deletes messages</td></tr><tr><td> + <p>/service/message-content/<virtualhost name>/<queue name></p> + </td><td>Rest service to retrieve message content</td><td>Retrieves the message content</td><td>Not implemented yet</td><td>Not implemented yet</td><td>Not implemented yet</td></tr><tr><td> + <p>/service/logrecords</p> + </td><td>Rest service to retrieve broker logs</td><td>Retrieves the broker logs</td><td>Not implemented yet</td><td>Not implemented yet</td><td>Not implemented yet</td></tr><tr><td> + <p>/service/sasl</p> + </td><td>Sasl authentication</td><td>Retrieves user current authentication status and broker supported SASL + mechanisms</td><td>Authenticates user using supported SASL mechanisms</td><td>Not implemented yet</td><td>Not implemented yet</td></tr><tr><td> + <p>/service/logout</p> + </td><td>Log outs</td><td>Log outs user</td><td>Not implemented yet</td><td>Not implemented yet</td><td>Not implemented yet</td></tr></tbody></table></div></div><br class="table-break" /><p>The REST URLs are hierarchical. It is permitted to replace rest URL elements with an + "asterisks" in GET requests to denote all object of a particular type. Additionally, trailing + object type in the URL hierarchy can be omitted. In this case GET request will return all of the + object underneath of the current object.</p><p>For example, for binding URL <code class="literal">http://localhost:8080/api/latest/binding/<vhost + node>/<vhost>/<exchange>/<queue>/<binding></code> replacing of + <code class="literal"><exchange></code> with "asterisks" + (<code class="literal">http://localhost:8080/api/<ver>/binding/<vhost + node>/<vhost>/*/<queue>/<binding></code>) will result in the GET + response containing the list of bindings for all of the exchanges in the virtualhost having the + given name and given queue.</p><p>If <code class="literal"><binding></code> and <code class="literal"><queue></code> are omitted in + binding REST URL (<code class="literal">http://localhost:8080/api/<ver>/binding/<vhost + node>/<vhost>/<exchangename></code>) the GET request will result in + returning all bindings for all queues for the given exchange in the virtual host. </p><div class="example"><a id="idp948064"></a><p class="title"><strong>Example 6.1. Examples of queue creation using curl (authenticating as user admin):</strong></p><div class="example-contents"><pre class="programlisting"> +#create a durable queue +curl --user admin -X PUT -d '{"durable":true}' http://localhost:8080/api/latest/queue/<vhostnode name>/<vhostname>/<queuename> +#create a durable priority queue +curl --user admin -X PUT -d '{"durable":true,"type":"priority"}' http://localhost:8080/api/latest/queue/<vhostnode name>/<vhostname>/<queuename> + </pre></div></div><br class="example-break" /><div class="example"><a id="idp949792"></a><p class="title"><strong>Example 6.2. Example of binding a queue to an exchange using curl</strong></p><div class="example-contents"><pre class="programlisting"> +curl --user admin -X PUT -d '{}' http://localhost:8080/api/latest/binding/<vhostnode name>/<vhostname>/<exchangename>/<queue-name>/<binding-name> + </pre></div></div><br class="example-break" /><p> NOTE: These curl examples utilise unsecure HTTP transport. To use the examples it is first + necessary enable Basic authentication for HTTP within the HTTP Management Configuration (it is + off by default). For details see <a class="xref" href="Java-Broker-Management-Managing-Plugin-HTTP.html" title="7.15. HTTP Plugin">Section 7.15, “HTTP Plugin”</a> + </p></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Management-Channel-Web-Console.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Channel.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Channel-JMX.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">6.2. Web Management Console </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 6.4. JMX Management</td></tr></table></div></div> + + <hr/> + + <ul id="-apache-navigation"> + <li><a href="http://www.apache.org/";>Apache</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks!</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/";><img id="-apache-feather" width="48" height="14" src="data:image/png;base64," alt="Apache"/></a></li> + </ul> + + <p id="-legal"> + Apache Qpid, Messaging built on AMQP; Copyright © 2013 + The Apache Software Foundation; Licensed under + the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache + License, Version 2.0</a>; Apache Qpid, Qpid, Qpid Proton, + Proton, Apache, the Apache feather logo, and the Apache Qpid + project logo are trademarks of The Apache Software + Foundation; All other marks mentioned may be trademarks or + registered trademarks of their respective owners + </p> + </div> + </div> + </body> +</html> Added: qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-Web-Console.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-Web-Console.html?rev=1632181&view=auto ============================================================================== --- qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-Web-Console.html (added) +++ qpid/site/docs/releases/qpid-trunk/java-broker/book/Java-Broker-Management-Channel-Web-Console.html Wed Oct 15 21:29:55 2014 @@ -0,0 +1,183 @@ +<!DOCTYPE html> +<!-- + - + - 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. + - +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en"> + <head> + <title>6.2. Web Management Console - Apache Qpid™</title> + <meta http-equiv="X-UA-Compatible" content="IE=edge"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <link rel="stylesheet" href="/site.css" type="text/css" async="async"/> + <link rel="stylesheet" href="/deferred.css" type="text/css" defer="defer"/> + <script type="text/javascript">var _deferredFunctions = [];</script> + <script type="text/javascript" src="/deferred.js" defer="defer"></script> + <!--[if lte IE 8]> + <link rel="stylesheet" href="/ie.css" type="text/css"/> + <script type="text/javascript" src="/html5shiv.js"></script> + <![endif]--> + </head> + <body> + <div id="-content"> + <div id="-top" class="panel"> + <a id="-menu-link"><img width="16" height="16" src="data:image/png;base64," alt="Menu"/></a> + + <a id="-search-link"><img width="22" height="16" src="data:image/png;base64," alt="Search"/></a> + + <ul id="-global-navigation"> + <li><a id="-logotype" href="/index.html">Apache Qpid<sup>™</sup></a></li> + <li><a href="/download.html">Download</a></li> + <li><a href="/documentation.html">Documentation</a></li> + <li><a href="/discussion.html">Discussion</a></li> + <li><a href="/issues.html">Issues</a></li> + <li><a href="/source-code.html">Source Code</a></li> + <li><a href="/resources.html">More Resources</a></li> + </ul> + </div> + + <div id="-menu" class="panel" style="display: none;"> + <section> + <h3>Project</h3> + + <ul> + <li><a href="/overview.html">Overview</a></li> + <li><a href="/proton/index.html">Qpid Proton</a></li> + <li><a href="/contributors.html">Contributors</a></li> + <li><a href="/get-involved.html">Get involved</a></li> + </ul> + </section> + + <section> + <h3>Software</h3> + + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/documentation.html">Documentation</a></li> + <li><a href="/components/index.html">Components</a></li> + <li><a href="/releases/index.html">Releases</a></li> + </ul> + </section> + + <section> + <h3>Resources</h3> + + <ul> + <li><a href="/discussion.html">Discussion</a></li> + <li><a href="/issues.html">Issues</a></li> + <li><a href="/source-code.html">Source code</a></li> + <li><a href="/resources.html">More resources</a></li> + </ul> + </section> + + <section> + <h3>More</h3> + + <ul> + <li><a href="/amqp.html">AMQP</a></li> + <li><a href="/developer.html">Developer central</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/qpid/";>Wiki</a></li> + </ul> + </section> + </div> + + <div id="-search" class="panel" style="display: none;"> + <form action="http://www.google.com/search"; method="get"> + <input type="hidden" name="sitesearch" value="qpid.apache.org"/> + <input type="text" name="q" maxlength="255" autofocus="autofocus" tabindex="1"/> + <button type="submit">Search</button> + <p><a href="/search.html">More ways to search</a></p> + </form> + </div> + + <div id="-middle" class="panel"> + <ul id="-path-navigation"><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-trunk/index.html">Qpid Trunk</a></li><li><a href="/releases/qpid-trunk/java-broker/book/index.html">AMQP Messaging Broker (Java)</a></li><li>6.2. Web Management Console</li></ul> + <div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">6.2. Web Management Console</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Channel.html">Prev</a> </td><th align="center" width="60%">Chapter 6. Management Channels</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Channel-REST-API.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Channel-Web-Console"></a>6.2. Web Management Console</h2></div></div></div><p> The Web Management Console provides a simple and intuitive interface for the Management + and Control of the Broker. From here, all aspects of the Broker can be controlled, + including: </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>add, remove and monitor queues</p></li><li class="listitem"><p>inspect, move, copy or delete messages</p></li><li class="listitem"><p>add, remove and monitor virtualhosts</p></li><li class="listitem"><p>configure and control high availability</p></li></ul></div><p> + </p><p>The remainder of the section provides an introduction to the web management console and + its use.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-Web-Console-Accessing"></a>6.2.1. Accessing the Console</h3></div></div></div><p>The Web Management Console is provided by the HTTP Management Plugin. Providing the + HTTP Management Plugin is in its default configuration, the Web Management Console can + be accessed by pointing a browser at the following URL:</p><p> + <code class="literal">http://myhost.mydomain.com:8080</code> + </p><p>The Console will prompt you to login using a username and password.</p><div class="figure"><a id="idp122448"></a><p class="title"><strong>Figure 6.1. Web Management Console - Authentication</strong></p><div class="figure-contents"><div class="mediaobject"><table border="0" style="cellpadding: 0; cellspacing: 0;" summary="manufactured viewport for HTML img" width="900"><tr><td><img alt="Web Console Authentication" src="images/Management-Web-Auth.png" width="900" /></td></tr></table></div></div></div><br class="figure-break" /></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-Web-Console-Orientation"></a>6.2.2. Orientation</h3></div></div></div><p>After you have logged on you will see a screen similar to the following. The elements + of the screen are now explained.</p><div class="figure"><a id="idp268912"></a><p class="title"><strong>Figure 6.2. Web Management Orientation - Console</strong></p><div class="figure-contents"><div class="mediaobject"><table border="0" style="cellpadding: 0; cellspacing: 0;" summary="manufactured viewport for HTML img" width="900"><tr><td><img alt="The Web Console" src="images/Management-Web-Console.png" width="900" /></td></tr></table></div></div></div><br class="figure-break" /><p> + </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><span class="emphasis"><em>A</em></span> - Hierarchy view. Expandable/collapsible view + showing all entities within the Broker. Double click on an entity name to + cause its tab to be opened. </p></li><li class="listitem"><p><span class="emphasis"><em>B</em></span> - Tab. Shows the details of an entity including its + attributes and its child entities. </p></li><li class="listitem"><p><span class="emphasis"><em>C</em></span> - Occluded tab. Click tab name to bring the tab to + the front.</p></li><li class="listitem"><p><span class="emphasis"><em>D</em></span> - Auto restore check box. Checked tabs will be + automatically restored on subsequent login.</p></li><li class="listitem"><p><span class="emphasis"><em>E</em></span> - Close. Click to close the tab.</p></li><li class="listitem"><p><span class="emphasis"><em>F</em></span> - User Menu. Access to Preferences, Logout and + Help.</p></li></ul></div><p> + </p><div class="figure"><a id="Java-Broker-Management-Channel-Web-Console-Orientation-Tab"></a><p class="title"><strong>Figure 6.3. Web Management Orientation - Tab</strong></p><div class="figure-contents"><div class="mediaobject"><table border="0" style="cellpadding: 0; cellspacing: 0;" summary="manufactured viewport for HTML img" width="900"><tr><td><img alt="A tab within the Web Consle" src="images/Management-Web-Tab.png" width="900" /></td></tr></table></div></div></div><br class="figure-break" /><p>The elements of a tab are now explained: </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><span class="emphasis"><em>1</em></span> - Attribute Panel. Shows the attributes of the + entity. Click the panel title bar opens/closes the panel.</p></li><li class="listitem"><p><span class="emphasis"><em>2</em></span> - Child Panels. Panels containing a table listing + the children of the entity. Click the panel title bar opens/closes the + panel.</p></li><li class="listitem"><p><span class="emphasis"><em>3</em></span> - Child Row. Row summarizing a child entity. Double + click to open the child tab.</p></li><li class="listitem"><p><span class="emphasis"><em>4</em></span> - Child Operations. Buttons to add a new child or + perform operations on existing children.</p></li></ul></div><p> + </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Entities"></a>6.2.3. Managing Entities</h3></div></div></div><p>All the Entities of the Broker of can be managed through the Web Console.</p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Entities-Add"></a>6.2.3.1. Adding Entities</h4></div></div></div><p>To <span class="emphasis"><em>add</em></span> a new entity, click the <code class="literal">Add</code> button + on the Child Panel on the Parent's tab. Clicking the Add button causes an add + dialogue to be displayed.</p><p>Add dialogues allow you to set the attributes of the new child, and set context + variables. Most fields on the add dialogue have field level help that give more + details about the attribute and any default value (which may be expressed in terms + of a context variable) that will take effect if you leave the attribute unset. An + example add dialogue is shown in the figure that follows.</p><div class="figure"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Entities-Add-Dialogue"></a><p class="title"><strong>Figure 6.4. Web Management Orientation - Add Dialogue</strong></p><div class="figure-contents"><div class="mediaobject"><img alt="Example add dialogue showing field level help" src="images/Management-Web-Add-Dialogue.png" /></div></div></div><br class="figure-break" /></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Entities-Edit"></a>6.2.3.2. Editing Entities</h4></div></div></div><p>To <span class="emphasis"><em>edit</em></span> an existing entity, click the <code class="literal">Edit</code> + button on the tab corresponding to the Entity itself. Editing an entity lets you + change some of its attributes and modify its context variables. Most fields on the + edit dialogue have field level help that give more details about the attribute and + any default value. An example edit dialogue is shown in the figure that + follows.</p><div class="figure"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Entities-Edit-Dialogue"></a><p class="title"><strong>Figure 6.5. Web Management Orientation - Edit Dialogue</strong></p><div class="figure-contents"><div class="mediaobject"><img alt="Example edit dialogue" src="images/Management-Web-Edit-Dialogue.png" /></div></div></div><br class="figure-break" /></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Entities-Delete"></a>6.2.3.3. Deleting Entities</h4></div></div></div><p>To <span class="emphasis"><em>remove</em></span> an existing entity, click the + <code class="literal">Delete</code> button on the tab corresponding to the Entity itself. + For some child types, you can select many children from the parent's type and delete + many children at once.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Context-Variables"></a>6.2.3.4. Context Variables</h4></div></div></div><p>All Entities within the Broker have the ability to have <a class="link" href="Java-Broker-Management-Managing-Entities.html#Java-Broker-Management-Managing-Entities-General" title="7.1. General Description">context + variables</a> associated with them.</p><p>Most add and edit dialogues have the ability to make context variable assignments. + To add/change/remove a context variable, click the Context Variable panel to expand + it.</p><div class="figure"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Entities-Context-Variables-Dialogue"></a><p class="title"><strong>Figure 6.6. Web Management Orientation - Context Variables</strong></p><div class="figure-contents"><div class="mediaobject"><img alt="Editting Context Variables" src="images/Management-Web-ContextVar.png" /></div></div></div><br class="figure-break" /><p>You will see any context variables already associated with the object, called + local context variables in bold, and any inherited from above in normal face.</p><p>Since context variables can be defined in terms of other context variables, the + display has two value columns: actual and effective. Actual shows the value truely + associated with the variable, where as effective shows the resulting value, after + variable expansion has taken place.</p><p>The <code class="literal">+</code> button allows new variables to be added. The + <code class="literal">-</code> button removes existing ones.</p><p>You change an existing local variables defintion by clicking on the actual value. + You can also <span class="emphasis"><em>provide a local definition</em></span> for an inherited value + by clicking on the actual value and typing its new value.</p></div></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Management-Channel.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Channel.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Channel-REST-API.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">Chapter 6. Management Channels </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 6.3. REST API</td></tr></table></div></div> + + <hr/> + + <ul id="-apache-navigation"> + <li><a href="http://www.apache.org/";>Apache</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks!</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/";><img id="-apache-feather" width="48" height="14" src="data:image/png;base64," alt="Apache"/></a></li> + </ul> + + <p id="-legal"> + Apache Qpid, Messaging built on AMQP; Copyright © 2013 + The Apache Software Foundation; Licensed under + the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache + License, Version 2.0</a>; Apache Qpid, Qpid, Qpid Proton, + Proton, Apache, the Apache feather logo, and the Apache Qpid + project logo are trademarks of The Apache Software + Foundation; All other marks mentioned may be trademarks or + registered trademarks of their respective owners + </p> + </div> + </div> + </body> +</html> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
