Modified: qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html?rev=1722689&r1=1722688&r2=1722689&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html (original) +++ qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html Sat Jan 2 23:59:48 2016 @@ -21,7 +21,7 @@ --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en"> <head> - <title>6.5. AMQP Intrinstic Management - Apache Qpid™</title> + <title>6.4. 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"/> @@ -111,12 +111,12 @@ https://github.com/apache/qpid-proton/bl </div> <div id="-middle" class="panel"> - <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-java-trunk/index.html">Qpid Java Trunk</a></li><li><a href="/releases/qpid-java-trunk/java-broker/book/index.html">AMQP Messaging Broker (Java)</a></li><li>6.5. AMQP Intrinstic Management</li></ul> + <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-java-trunk/index.html">Qpid Java Trunk</a></li><li><a href="/releases/qpid-java-trunk/java-broker/book/index.html">AMQP Messaging Broker (Java)</a></li><li>6.4. AMQP Intrinstic Management</li></ul> <div id="-middle-content"> - <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 + <div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">6.4. AMQP Intrinstic 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-QMF.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Java-Broker-Management-Channel-AMQP-Intrinstic"></a>6.4. 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> + 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-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-QMF.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="AMQP-Messaging-Broker-Java-Book.html">Home</a></td><td align="right" valign="top" width="40%"> 6.5. QMF</td></tr></table></div></div> <hr/>
Modified: qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-QMF.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-QMF.html?rev=1722689&r1=1722688&r2=1722689&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-QMF.html (original) +++ qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-QMF.html Sat Jan 2 23:59:48 2016 @@ -21,7 +21,7 @@ --> <html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en"> <head> - <title>6.6. QMF - Apache Qpid™</title> + <title>6.5. 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"/> @@ -111,10 +111,10 @@ https://github.com/apache/qpid-proton/bl </div> <div id="-middle" class="panel"> - <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-java-trunk/index.html">Qpid Java Trunk</a></li><li><a href="/releases/qpid-java-trunk/java-broker/book/index.html">AMQP Messaging Broker (Java)</a></li><li>6.6. QMF</li></ul> + <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-java-trunk/index.html">Qpid Java Trunk</a></li><li><a href="/releases/qpid-java-trunk/java-broker/book/index.html">AMQP Messaging Broker (Java)</a></li><li>6.5. QMF</li></ul> <div id="-middle-content"> - <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-C hannel.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> + <div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">6.5. 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" style="clear: both"><a id="Java-Broker-Management-Channel-QMF"></a>6.5. 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-Channel.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.4. AMQP Intrinstic Management </td><td align="center" width="20%"><a accesskey="h" href="AMQP-Messaging-Broker-Java-Book.html">Home</a></td><td align="right" valign="top" width="40%"> Chapter 7. Managing Entities</td></tr></table></div></div> <hr/> Modified: qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-REST-API.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-REST-API.html?rev=1722689&r1=1722688&r2=1722689&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-REST-API.html (original) +++ qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-REST-API.html Sat Jan 2 23:59:48 2016 @@ -114,191 +114,145 @@ https://github.com/apache/qpid-proton/bl <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-java-trunk/index.html">Qpid Java Trunk</a></li><li><a href="/releases/qpid-java-trunk/java-broker/book/index.html">AMQP Messaging Broker (Java)</a></li><li>6.3. REST API</li></ul> <div id="-middle-content"> - <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 interfaces, which can be used directly to - monitor and manage the Broker instance.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Introduction"></a>6.3.1. Introduction</h3></div></div></div><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 and creation.</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> where <version> is a major model version prefixed with "v", for example, v3. - For convenience the alias <code class="literal">latest</code> (<code class="literal">/api/latest</code>) signifies the latest supported version. - There are also some ancillary services under URI <code class="literal">/service</code>.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-URI"></a>6.3.2. REST interfaces</h3></div></div></div><p>The following REST interfaces are implemented on Qpid Broker</p><div class="table"><a id="idm140601093192528"></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 /></colgroup><thead><tr><th>REST Service URI</th><th>Description</th></tr></thead><tbody><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/broker</p></li><li class="listitem"><p>/api/<version>/broker</p></li></ul></div> - </td><td> - <p>Manages broker instance attributes and provides current values of Broker attributes and children</p> - </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/virtualhostnode</p></li><li class="listitem"><p>/api/<version>/virtualhostnode</p></li><li class="listitem"><p>/api/latest/virtualhostnode/<virtual host node name></p></li><li class="listitem"><p>/api/<version>/virtualhostnode/<virtual host node name></p></li></ul></div> - </td><td> - <p>Manages(creates/deletes/updates) Virtual Host Node(s) on Broker and provides current values of Virtual Host Node attributes and its children</p> - </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/virtualhost</p></li><li class="listitem"><p>/api/<version>/virtualhost</p></li><li class="listitem"><p>/api/latest/virtualhost/<virtual host node name></p></li><li class="listitem"><p>/api/<version>/virtualhost/<virtual host node name></p></li><li class="listitem"><p>/api/latest/virtualhost/<virtual host node name>/<virtual host name></p></li><li class="listitem"><p>/api/<version>/virtualhost/<virtual host node name>/<virtual host name></p></li></ul></div> - </td><td> - <p>Manages(creates/deletes/updates) Virtual Host on Virtual Host Node and provides current values of Virtual Host attributes and its children</p> - </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/queue</p></li><li class="listitem"><p>/api/<version>/queue</p></li><li class="listitem"><p>/api/latest/queue/<virtual host node name></p></li><li class="listitem"><p>/api/<version>/queue/<virtual host node name></p></li><li class="listitem"><p>/api/latest/queue/<virtual host node name>/<virtual host name></p></li><li class="listitem"><p>/api/<version>/queue/<virtual host node name>/<virtual host name></p></li><li class="listitem"><p>/api/latest/queue/<virtual host node name>/<virtual host name>/<queue name></p></li><li class="listitem"><p>/api/<version>/queue/<virtual host node name>/<virtual host name>/<queue name></p></li></ul></div> - </td><td> - <p>Manages(creates/deletes/updates) Queue(s) on Virtual Host and provides current values of Queue attributes and its children</p> - </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/exchange</p></li><li class="listitem"><p>/api/<version>/exchange</p></li><li class="listitem"><p>/api/latest/exchange/<virtual host node name></p></li><li class="listitem"><p>/api/<version>/exchange/<virtual host node name></p></li><li class="listitem"><p>/api/latest/exchange/<virtual host node name>/<virtual host name></p></li><li class="listitem"><p>/api/<version>/exchange/<virtual host node name>/<virtual host name></p></li><li class="listitem"><p>/api/latest/exchange/<virtual host node name>/<virtual host name>/<exchange name></p></li><li class="listitem"><p>/api/<version>/exchange/<virtual host node name>/<virtual host name>/<exchange name></p></li></ul></div> - </td><td> - <p>Manages(creates/deletes/updates) Exchanges(s) on Virtual Host and provides current values of Exchange attributes and its children</p> - </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/binding</p></li><li class="listitem"><p>/api/<version>/binding</p></li><li class="listitem"><p>/api/latest/binding/<virtual host node name></p></li><li class="listitem"><p>/api/<version>/binding/<virtual host node name></p></li><li class="listitem"><p>/api/latest/binding/<virtual host node name>/<virtual host name></p></li><li class="listitem"><p>/api/<version>/binding/<virtual host node name>/<virtual host name></p></li><li class="listitem"><p>/api/latest/binding/<virtual host node name>/<virtual host name>/<exchange name></p></li><li class="listitem"><p>/api/<version>/binding/<virtual host node name>/<virtual host name>/<exchange name></p></li><li class="listitem"><p>/api/latest/binding/<virtual host node name>/<virtual host name>/<exchange name>/<queue n ame>/<binding name></p></li><li class="listitem"><p>/api/<version>/binding/<virtual host node name>/<virtual host name>/<exchange name>/<queue name>/<binding name></p></li></ul></div> - </td><td> - <p>Manages(creates/deletes) Binding(s) of Queue to Exchange and provides current values of Binding attributes</p> - </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/connection</p></li><li class="listitem"><p>/api/<version>/connection</p></li><li class="listitem"><p>/api/latest/connection/<virtual host node name></p></li><li class="listitem"><p>/api/<version>/connection/<virtual host node name></p></li><li class="listitem"><p>/api/latest/connection/<virtual host node name>/<virtual host name></p></li><li class="listitem"><p>/api/<version>/connection/<virtual host node name>/<virtual host node name></p></li><li class="listitem"><p>/api/latest/connection/<virtual host node name>/<virtual host name>/<connection name></p></li><li class="listitem"><p>/api/<version>/connection/<virtual host node name>/<virtual host node name>/<connection name></p></li></ul></div> - </td><td> - <p>Manages (deletes) Connection(s) on VirtualHost and provides current values of Connection attributes and its Sessions</p> - </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/session</p></li><li class="listitem"><p>/api/<version>/session</p></li><li class="listitem"><p>/api/latest/session/<virtual host node name></p></li><li class="listitem"><p>/api/<version>/session/<virtual host node name></p></li><li class="listitem"><p>/api/latest/session/<virtual host node name>/<virtual host name></p></li><li class="listitem"><p>/api/<version>/session/<virtual host node name>/<virtual host node name></p></li><li class="listitem"><p>/api/latest/session/<virtual host node name>/<virtual host name>/<connection name></p></li><li class="listitem"><p>/api/<version>/session/<virtual host node name>/<virtual host node name>/<connection name</p></li><li class="listitem"><p>/api/latest/session/<virtual host node name>/<virtual host name>/<connection name> /<session name></p></li><li class="listitem"><p>/api/<version>/session/<virtual host node name>/<virtual host node name>/<connection name>/<session name></p></li></ul></div> - </td><td> - <p>Manages (deletes) Session(s) on Connection and provides values of Session attributes and its Consumers</p> - </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/port</p></li><li class="listitem"><p>/api/<version>/port</p></li><li class="listitem"><p>/api/latest/port/<port name></p></li><li class="listitem"><p>/api/<version>/port/<port name></p></li></ul></div> - </td><td> - <p>Manages(creates/deletes/updates) Port(s) on Broker and provides the information about current values of Port attributes and its children</p> - </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/authenticationprovider</p></li><li class="listitem"><p>/api/<version>/authenticationprovider</p></li><li class="listitem"><p>/api/latest/authenticationprovider/<authentication provider name></p></li><li class="listitem"><p>/api/<version>/authenticationprovider/<authentication provider name></p></li></ul></div> - </td><td> - <p>Manages(creates/deletes/updates) AuthenticationProvider(s) on Broker and provides the information about current values of AuthenticationProvider attributes and its children</p> - </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/user</p></li><li class="listitem"><p>/api/<version>/user</p></li><li class="listitem"><p>/api/latest/user/<authentication provider name>/<user name></p></li><li class="listitem"><p>/api/<version>/user/<authentication provider name>/<user name></p></li><li class="listitem"><p>/api/latest/user/<authentication provider name>/<user name></p></li><li class="listitem"><p>/api/<version>/user/<authentication provider name>/<user name></p></li></ul></div> - </td><td> - <p>Manages(creates/deletes/updates) User(s) on AuthenticationProvider and provides the information about current values of User attributes</p> - </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/accesscontrolprovider</p></li><li class="listitem"><p>/api/<version>/accesscontrolprovider</p></li><li class="listitem"><p>/api/latest/accesscontrolprovider/<access control provider name></p></li><li class="listitem"><p>/api/<version>/accesscontrolprovider/<access control provider name></p></li></ul></div> - </td><td> - <p>Manages(creates/deletes/updates) AccessControlProvider on Broker and provides the information about current values of AccessControlProvider attributes</p> - </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/groupprovider</p></li><li class="listitem"><p>/api/<version>/groupprovider</p></li><li class="listitem"><p>/api/latest/groupprovider/<group provider name></p></li><li class="listitem"><p>/api/<version>/groupprovider/<group provider name></p></li></ul></div> + <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-AMQP-Intrinstic.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Java-Broker-Management-Channel-REST-API"></a>6.3. REST API</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Introduction"></a>6.3.1. Introduction</h3></div></div></div><p>This section describes the REST API provided by the Java Broker. The REST API is intended + for use by developers who wish to automate the management or monitoring of the Qpid Broker. It + is also very useful for adhoc monitoring on the command line using tools such as + <code class="literal">curl</code>.</p><p>The REST API provides access to all of the Broker's entities using hierarchical paths + expressed by the URI. Responses are returned in JSON format.</p><p>The <code class="literal">GET</code> method request retrieves information about an object, the + <code class="literal">DELETE</code> method requests the removal of one, and the <code class="literal">PUT</code> + or <code class="literal">POST</code> methods perform updates or create new objects. The + <code class="literal">POST</code> method is also used to invoke operations.</p><p>The REST API is versioned with the version number embedded withinthe URI. The general form + of the URI is <code class="literal">/api/<version></code> where <version> is a major model + version prefixed with "v", for example, v3. For convenience the alias + <code class="literal">latest</code> (<code class="literal">/api/latest</code>) signifies the latest supported + version.</p><p>There are also some ancillary services under URI <code class="literal">/service</code> used for + authentication and logout.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-APIDocs"></a>6.3.2. REST API documentation</h3></div></div></div><p>REST API documentation is available on-line from any Java Broker at location + <code class="literal">/apidocs</code>. It is also linked from the menu of the Web Management Console. + </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Authentication"></a>6.3.3. Authentication</h3></div></div></div><p>Before you can use the REST API, you must authenticate. Authentication decisions are made + by the <a class="link" href="Java-Broker-Concepts-Authentication-Providers.html" title="4.9. Authentication Providers">authentication + provider</a> associated with HTTP <a class="link" href="Java-Broker-Concepts-Ports.html" title="4.8. Ports">port</a> + on which you connect.</p><p>You may authenticate using <a class="link" href="https://www.ietf.org/rfc/rfc4422.txt"; target="_top">SASL</a> + (<code class="literal">/service/sasl</code>) or <a class="link" href="https://tools.ietf.org/html/rfc2617"; target="_top">HTTP + Basic Authentication</a>. The latter is convienent when using tools such as + <code class="literal">curl</code> on the command line. This is illustrated in the examples + below.</p><p>For SASL authentication use a <code class="literal">GET</code> request to + <code class="literal">/service/sasl</code> to get a list of supported SASL mechanisms, and use + <code class="literal">PUT</code> to the same URL to perform the SASL negotiation.</p><p>It is possible to end an authenticated session using + <code class="literal">/service/logout</code>.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Create"></a>6.3.4. Configured Object creation</h3></div></div></div><p>Methods PUT or POST can be used to create ConfiguredObject.</p><p> ConfiguredObject can be created by submitting PUT request against ConfiguredObject full + URI (the one ending with configured object name) or by submitting PUT/POST request against + parent URI. The request encoding should be json (application/json) and request body should + contain attributes values in json format. On successful completion of operation a response + should be returned having response status code set to 201 and response header "Location" set + to ConfiguredObject full URI. If object with a such name/id already exist and POST/PUT + requests is made against parent URI, an error response should be returned having response code + 409 (conflict) and body containing the json with the reason of operation failure. If object + with a such name/id already exist and and PUT request is made against ConfiguredObject full + URI, then ConfiguredObject update should be performed and http status code 200 should be + returned. If ConfiguredObject cannot be created because of validation failure(s) the response + should have http status code set 422 (Unprocessible Entity) and body should contain json with + the reason of operation failure. On any other failure to create ConfiguredObject the response + should have status code set to 400 (Bad Request) and payload should contain a json with error + explaining the exact reason of failure. </p><div class="example"><a id="d0e2064"></a><p class="title"><strong>Example 6.1. Examples of REST calls for Queue creation</strong></p><div class="example-contents"><p> To create Queue with name "my-queue" on a virtual host with name "vh" (which is + contained within virtual host node with name "vhn") either of the following requests should + be made: </p><pre class="screen">PUT /api/latest/queue/vhn/vh HTTP/1.1</pre><pre class="screen">POST /api/latest/queue/vhn/vh HTTP/1.1</pre><pre class="screen">PUT /api/latest/queue/vhn/vh/my-queue HTTP/1.1</pre><p> Response code 201 should be returned on successful queue creation. Response header + "Location" should be set to "/api/latest/queue/test/my-queue". If queue with name "my-queue" + already exists and either of 2 first requests above were used, an error response with + response code 409 (conflict) and body containing json with message that queue exists should + be returned. If queue with name "my-queue" exists and last request is used, then Queue + update should occur. </p></div></div><br class="example-break" /></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Update"></a>6.3.5. Configured Object update</h3></div></div></div><p>Methods PUT or POST can be used to update ConfiguredObject.</p><p> ConfiguredObject can be updated by submitting PUT or POST request against + ConfiguredObject full URI (the one ending with configured object name). The request encoding + should be json (application/json) and request body should contain a ConfiguredObject json + (with all or only modified attributes). On successful completion of operation a response code + 200 should be returned. If ConfiguredObject does not exists and PUT method is used, such + object should be created (201 response will be returned in this case). If ConfiguredObject + does not exists and POST method is used, an error response should be returned having response + status code 404 and payload with json explaining the problem. If any error occur on update, a + response with response code 400 or 422 or 404 should be sent back to the client containing + json body with error details. </p><div class="example"><a id="d0e2084"></a><p class="title"><strong>Example 6.2. Examples of REST calls for Queue update</strong></p><div class="example-contents"><p>To update Queue with name "my-queue" on a virtual host with name "vh" (contained in + virtual host node with name "vhn") either of the following requests can be made:</p><pre class="screen">POST /api/latest/queue/vhn/vh/my-queue HTTP/1.1</pre><pre class="screen">POST /api/latest/queue/vhn/vh/my-queue HTTP/1.1</pre></div></div><br class="example-break" /></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Delete"></a>6.3.6. Configured Object deletion</h3></div></div></div><p>Method DELETE can be used to delete ConfiguredObject. Alternatively, ConfiguredObject can + be deleted with update request having desiredState attribute set to value "DELETED". POST or + PUT methods can be used in this case.</p><p>On successful completion of operation a response code 200 should be returned.</p><p>With DELETE method object ConfiguredObject in following ways:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>by submitting DELETE request using ConfiguredObject full URI (the one ending with + configured object name)</p></li><li class="listitem"><p>by submitting DELETE request using parent URI and providing parameters having the same + names as children attributes, for example, id, name, etc. Multiple children can be deleted + in a such way. Many "id" parameters can be specified in such requests. Only children with + matching attribute values will be deleted.</p></li></ul></div><div class="example"><a id="d0e2109"></a><p class="title"><strong>Example 6.3. Examples of REST calls for Queue deletion</strong></p><div class="example-contents"><p>To delete Queue with name "my-queue" on a virtual host with name "vh" (contained in + virtual host node with name "vhn") either of the following requests can be made:</p><pre class="screen">DELETE /api/latest/queue/vhn/vh/my-queue HTTP/1.1</pre><pre class="screen">DELETE /api/latest/queue/vhn/vh?name=my-queue HTTP/1.1</pre><pre class="screen">DELETE /api/latest/queue/vhn/vh?id=real-queue-id HTTP/1.1</pre></div></div><br class="example-break" /></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Get"></a>6.3.7. Retrieving Configured Object details</h3></div></div></div><p>Method GET is used to retrieve ConfiguredObject attributes values and children + hierarchy.</p><p>A particular ConfiguredObject details can be retrieved using full ConfiguredObject URI + (the one ending with configured object name)</p><p>A collection of ConfiguredObjects can be retrieved using parent URI. Request parameters + (having the same name as attributes) can be used to filter the returned configured + objects.</p><p>The REST URI (/api/latest/>category</*) are hierarchical. It is permitted to replace + REST URI 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><p>Additional parameters supported in GET requests:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">depth</span></dt><dd><p>To restrict the depth of hierarchy of configured objects to return in + response</p></dd><dt><span class="term">actuals</span></dt><dd><p>If set to "true" attribute actual values are returned instead of effective</p></dd><dt><span class="term">includeSysContext</span></dt><dd><p>If set to "true" all system context variables are returned</p></dd><dt><span class="term">inheritedActuals</span></dt><dd><p>If set to "true" actual values for all inherited context is returned.</p></dd><dt><span class="term">oversize</span></dt><dd><p>Sets the maximum length for values of over-sized attributes to trim</p></dd><dt><span class="term">extractInitialConfig</span></dt><dd><p>If set to "true", the returned json can be used as initial configuration.</p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Operations"></a>6.3.8. Configured Object operations</h3></div></div></div><p>Method POST is used to invoke Configured Objects operations. Some operations support + parameters. Pass parameters using a JSON request body containing a map with a map entry for + each parameter. </p><div class="example"><a id="d0e2197"></a><p class="title"><strong>Example 6.4. Example of REST call to invoke the Queue clear queue operation</strong></p><div class="example-contents"><p>To clear the queue with name "my-queue" on a virtual host with name "vh".</p><pre class="screen">POST api/latest/queue/default/vhn/vh/my-queue/clearQueue HTTP/1.1</pre></div></div><br class="example-break" /></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Status-Codes"></a>6.3.9. HTTP status codes returned by REST interfaces</h3></div></div></div><div class="table"><a id="d0e2207"></a><p class="title"><strong>Table 6.1. HTTP status codes returned by REST interfaces</strong></p><div class="table-contents"><table border="1" summary="HTTP status codes returned by REST interfaces"><colgroup><col /><col /></colgroup><thead><tr><th>Status code</th><th>Description</th></tr></thead ><tbody><tr><td> + <p>200</p> </td><td> - <p>Manages(creates/deletes/updates) GroupProvider on Broker and provides the information about current values of GroupProvider attributes and its children</p> + <p>REST request is successfully completed. This status code can be returned by + update, delete and get requests.</p> </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/group</p></li><li class="listitem"><p>/api/<version>/group</p></li><li class="listitem"><p>/api/latest/group/<group provider name></p></li><li class="listitem"><p>/api/<version>/group/<group provider name></p></li><li class="listitem"><p>/api/latest/group/<group provider name>/<group name></p></li><li class="listitem"><p>/api/<version>/group/<group provider name>/<group name></p></li></ul></div> + <p>201</p> </td><td> - <p>Manages(creates/deletes/updates) Group on GroupProvider and provides the information about current values of Group attributes and its children</p> + <p>New configured object is created. It is returned by REST PUT and POST requests + for creation of configured objects.</p> </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/groupmember</p></li><li class="listitem"><p>/api/<version>/groupmember</p></li><li class="listitem"><p>/api/latest/groupmember/<group provider name></p></li><li class="listitem"><p>/api/<version>/groupmember/<group provider name></p></li><li class="listitem"><p>/api/latest/groupmember/<group provider name>/<group name></p></li><li class="listitem"><p>/api/<version>/groupmember/<group provider name>/<group name></p></li><li class="listitem"><p>/api/latest/groupmember/<group provider name>/<group name>/<user name></p></li><li class="listitem"><p>/api/<version>/groupmember/<group provider name>/<group name>/<user name></p></li></ul></div> + <p>400</p> </td><td> - <p>Manages(creates/deletes) GroupMember(s) on Group and provides the information about current values of GroupMember attributes</p> + <p>REST request cannot be performed due to errors in request. It can be returned + from create, update and delete requests. The details of a problem are provided in + the response payload in json format.</p> </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/keystore</p></li><li class="listitem"><p>/api/<version>/keystore</p></li><li class="listitem"><p>/api/latest/keystore/<key store name></p></li><li class="listitem"><p>/api/<version>/keystore/<key store name></p></li></ul></div> + <p>401</p> </td><td> - <p>Manages(creates/deletes/updates) KeyStore(s) on Broker and provides the information about current values of KeyStore attributes</p> + <p>The request requires user authentication</p> </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/truststore</p></li><li class="listitem"><p>/api/<version>/truststore</p></li><li class="listitem"><p>/api/latest/truststore/<trust store name></p></li><li class="listitem"><p>/api/<version>/truststore/<trust store name></p></li></ul></div> + <p>403</p> </td><td> - <p>Manages(creates/deletes/updates) TrustStore(s) on Broker and provides the information about current values of TrustStore attributes</p> + <p>Execution of request is not allowed due to failure to authorize user + operation.</p> </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/preferencesprovider</p></li><li class="listitem"><p>/api/<version>/preferencesprovider</p></li><li class="listitem"><p>/api/latest/preferencesprovider/<authentication provider name></p></li><li class="listitem"><p>/api/<version>/preferencesprovider/<authentication provider name></p></li><li class="listitem"><p>/api/latest/preferencesprovider/<authentication provider name>/<preferences provider name></p></li><li class="listitem"><p>/api/<version>/preferencesprovider/<authentication provider name>/<preferences provider name></p></li></ul></div> + <p>404</p> </td><td> - <p>Manages(creates/deletes/updates) PreferencesProvider on AuthenticationProvider and provides the information about current values of PreferencesProvider attributes</p> + <p> The requested configured object cannot be found. This status code can be + returned from POST update requests if configured object does not exist. The reason + for the status code is provided in the response payload in json format. </p> </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/plugin</p></li><li class="listitem"><p>/api/<version>/plugin</p></li><li class="listitem"><p>/api/latest/plugin/<plugin name></p></li><li class="listitem"><p>/api/<version>/plugin/<plugin name></p></li></ul></div> + <p>409</p> </td><td> - <p>Manages(creates/deletes/updates) Plugin(s) on Broker and provides the information about current values of Plugin attributes</p> + <p>The request can not be performed because its execution can create conflicts in + the broker. This status code can be returned from POST/PUT create requests against + parent URI if configured object with requested name or id already exists. The status + code 409 can also be returned if removal or update of configured object can violate + system integrity. The reason for the status code is provided in the response payload + in json format. </p> </td></tr><tr><td> - <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>/api/latest/remotereplicationnode</p></li><li class="listitem"><p>/api/<version>/remotereplicationnode</p></li><li class="listitem"><p>/api/latest/remotereplicationnode/<virtual host node name></p></li><li class="listitem"><p>/api/<version>/remotereplicationnode/<virtual host node name></p></li><li class="listitem"><p>/api/latest/remotereplicationnode/<virtual host node name>/<replication node name></p></li><li class="listitem"><p>/api/<version>/remotereplicationnode/<virtual host node name>/<replication node name></p></li></ul></div> + <p>422</p> </td><td> - <p>Manages(creates/deletes/updates) RemoteReplicationNode(s) on VirtualHostNode and provides the information about current values of RemoteReplicationNode attributes</p> - </td></tr><tr><td> - <p>/service/sasl</p> - </td><td>Sasl authentication. Retrieves user current authentication status and broker supported SASL mechanisms (GET). Authenticates user using supported SASL mechanisms (PUT requests)</td></tr><tr><td> - <p>/service/logout</p> - </td><td>Log outs user (GET only)</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Create"></a>6.3.3. Configured Object creation</h3></div></div></div><p>Methods PUT or POST can be used to create ConfiguredObject.</p><p> - ConfiguredObject can be created by submitting PUT request against ConfiguredObject full URI (the one ending with configured object name) - or by submitting PUT/POST request against parent URI. - The request encoding should be json (application/json) and request body should contain attributes values in json format. - On successful completion of operation a response should be returned having response status code set to 201 and response header "Location" set to ConfiguredObject full URI. - If object with a such name/id already exist and POST/PUT requests is made against parent URI, - an error response should be returned having response code 409 (conflict) and body containing the json with the reason of operation failure. - If object with a such name/id already exist and and PUT request is made against ConfiguredObject full URI, - then ConfiguredObject update should be performed and http status code 200 should be returned. - If ConfiguredObject cannot be created because of validation failure(s) the response should have http status code set 422 (Unprocessible Entity) - and body should contain json with the reason of operation failure. On any other failure to create ConfiguredObject the response should have status code set to 400 (Bad Request) - and payload should contain a json with error explaining the exact reason of failure. - </p><div class="example"><a id="idm140601092829280"></a><p class="title"><strong>Example 6.1. Examples of REST calls for Queue creation</strong></p><div class="example-contents"><p> - To create Queue with name "my-queue" on a virtual host with name "vh" (which is contained within virtual host node with name "vhn") either of the following requests should be made: - </p><pre class="screen">PUT /api/latest/queue/vhn/vh HTTP/1.1</pre><pre class="screen">POST /api/latest/queue/vhn/vh HTTP/1.1</pre><pre class="screen">PUT /api/latest/queue/vhn/vh/my-queue HTTP/1.1</pre><p> - Response code 201 should be returned on successful queue creation. Response header "Location" should be set to "/api/latest/queue/test/my-queue". - If queue with name "my-queue" already exists and either of 2 first requests above were used, an error response with response code 409 (conflict) and body containing json with message - that queue exists should be returned. If queue with name "my-queue" exists and last request is used, then Queue update should occur. - </p></div></div><br class="example-break" /></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Update"></a>6.3.4. Configured Object update</h3></div></div></div><p>Methods PUT or POST can be used to update ConfiguredObject.</p><p> - ConfiguredObject can be updated by submitting PUT or POST request against ConfiguredObject full URI (the one ending with configured object name). - The request encoding should be json (application/json) and request body should contain a ConfiguredObject json (with all or only modified attributes). - On successful completion of operation a response code 200 should be returned. - If ConfiguredObject does not exists and PUT method is used, such object should be created (201 response will be returned in this case). - If ConfiguredObject does not exists and POST method is used, an error response should be returned having response status code 404 and payload with json explaining the problem. - If any error occur on update, a response with response code 400 or 422 or 404 should be sent back to the client containing json body with error details. - </p><div class="example"><a id="idm140601092822384"></a><p class="title"><strong>Example 6.2. Examples of REST calls for Queue update</strong></p><div class="example-contents"><p>To update Queue with name "my-queue" on a virtual host with name "vh" (contained in virtual host node with name "vhn") either of the following requests can be made:</p><pre class="screen">POST /api/latest/queue/vhn/vh/my-queue HTTP/1.1</pre><pre class="screen">POST /api/latest/queue/vhn/vh/my-queue HTTP/1.1</pre></div></div><br class="example-break" /></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Delete"></a>6.3.5. Configured Object deletion</h3></div></div></div><p>Method DELETE can be used to delete ConfiguredObject. Alternatively, ConfiguredObject can be deleted with update request having desiredState attribute set to value "DELETED". - POST or PUT methods can be used in this case.</p><p>On successful completion of operation a response code 200 should be returned.</p><p>With DELETE method object ConfiguredObject in following ways:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>by submitting DELETE request using ConfiguredObject full URI (the one ending with configured object name)</p></li><li class="listitem"><p>by submitting DELETE request using parent URI and providing parameters having the same names as children attributes, for example, id, name, etc. - Multiple children can be deleted in a such way. Many "id" parameters can be specified in such requests. Only children with matching attribute values will be deleted.</p></li></ul></div><div class="example"><a id="idm140601092814400"></a><p class="title"><strong>Example 6.3. Examples of REST calls for Queue deletion</strong></p><div class="example-contents"><p>To delete Queue with name "my-queue" on a virtual host with name "vh" (contained in virtual host node with name "vhn") either of the following requests can be made:</p><pre class="screen">DELETE /api/latest/queue/vhn/vh/my-queue HTTP/1.1</pre><pre class="screen">DELETE /api/latest/queue/vhn/vh?name=my-queue HTTP/1.1</pre><pre class="screen">DELETE /api/latest/queue/vhn/vh?id=real-queue-id HTTP/1.1</pre></div></div><br class="example-break" /></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Get"></a>6.3.6. Retrieving Configured Object details</h3></div></div></div><p>Method GET is used to retrieve ConfiguredObject attributes values and children hierarchy.</p><p>A particular ConfiguredObject details can be retrieved using full ConfiguredObject URI (the one ending with configured object name)</p><p>A collection of ConfiguredObjects can be retrieved using parent URI. Request parameters - (having the same name as attributes) can be used to filter the returned configured objects.</p><p>The REST URI (/api/latest/>category</*) are hierarchical. It is permitted to replace REST URI 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><p>Additional parameters supported in GET requests:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">depth</span></dt><dd><p>To restrict the depth of hierarchy of configured objects to return in response</p></dd><dt><span class="term">actuals</span></dt><dd><p>If set to "true" attribute actual values are returned instead of effective</p></dd><dt><span class="term">includeSysContext</span></dt><dd><p>If set to "true" all system context variables are returned</p></dd><dt><span class="term">inheritedActuals</span></dt><dd><p>If set to "true" actual values for all inherited context is returned.</p></dd><dt><span class="term">oversize</span></dt><dd><p>Sets the maximum length for values of over-sized attributes to trim</p></dd><dt><span class="term">extractInitialConfig</span></dt><dd><p>If set to "true", the returned json can be used as initial configuration.</p></dd>< /dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Status-Codes"></a>6.3.7. HTTP status codes returned by REST interfaces</h3></div></div></div><div class="table"><a id="idm140601092793200"></a><p class="title"><strong>Table 6.2. HTTP status codes returned by REST interfaces</strong></p><div class="table-contents"><table border="1" summary="HTTP status codes returned by REST interfaces"><colgroup><col /><col /></colgroup><thead><tr><th>Status code</th><th>Description</th></tr></thead><tbody><tr><td> - <p>200</p> - </td><td> - <p>REST request is successfully completed. This status code can be returned by update, delete and get requests.</p> - </td></tr><tr><td> - <p>201</p> - </td><td> - <p>New configured object is created. It is returned by REST PUT and POST requests for creation of configured objects.</p> - </td></tr><tr><td> - <p>400</p> - </td><td> - <p>REST request cannot be performed due to errors in request. - It can be returned from create, update and delete requests. - The details of a problem are provided in the response payload in json format.</p> - </td></tr><tr><td> - <p>401</p> - </td><td> - <p>The request requires user authentication</p> - </td></tr><tr><td> - <p>403</p> - </td><td> - <p>Execution of request is not allowed due to failure to authorize user operation.</p> - </td></tr><tr><td> - <p>404</p> - </td><td> - <p> - The requested configured object cannot be found. This status code can be returned from POST update requests if configured object does not exist. - The reason for the status code is provided in the response payload in json format. - </p> - </td></tr><tr><td> - <p>409</p> - </td><td> - <p>The request can not be performed because its execution can create conflicts in the broker. - This status code can be returned from POST/PUT create requests against parent URI if configured object with requested name or id already exists. - The status code 409 can also be returned if removal or update of configured object can violate system integrity. - The reason for the status code is provided in the response payload in json format. - </p> - </td></tr><tr><td> - <p>422</p> - </td><td> - <p>The request can not be performed because provided information either incomplete or invalid. - This status code can be returned from create or update requests. - The reason for the status code is provided in the response payload in json format.</p> - </td></tr></tbody></table></div></div><br class="table-break" /></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Examples"></a>6.3.8. Examples of REST requests with curl</h3></div></div></div><div class="example"><a id="idm140601092768736"></a><p class="title"><strong>Example 6.4. Examples of queue creation using curl (authenticating as user admin):</strong></p><div class="example-contents"><pre class="programlisting"> + <p>The request can not be performed because provided information either incomplete + or invalid. This status code can be returned from create or update requests. The + reason for the status code is provided in the response payload in json + format.</p> + </td></tr></tbody></table></div></div><br class="table-break" /></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Examples"></a>6.3.10. Examples of REST requests with curl</h3></div></div></div><div class="example"><a id="d0e2309"></a><p class="title"><strong>Example 6.5. 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="idm140601092767008"></a><p class="title"><strong>Example 6.5. Example of binding a queue to an exchange using curl</strong></p><div class="example-contents"><pre class="programlisting"> + </pre></div></div><br class="example-break" /><div class="example"><a id="d0e2314"></a><p class="title"><strong>Example 6.6. 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.16. HTTP Plugin">Section 7.16, “HTTP Plugin”</a> - </p></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-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> + </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.16. HTTP Plugin">Section 7.16, “HTTP Plugin”</a> + </p></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-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-AMQP-Intrinstic.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="AMQP-Messaging-Broker-Java-Book.html">Home</a></td><td align="right" valign="top" width="40%"> 6.4. AMQP Intrinstic Management</td></tr></table></div></div> <hr/> Modified: qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-Web-Console.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-Web-Console.html?rev=1722689&r1=1722688&r2=1722689&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-Web-Console.html (original) +++ qpid/site/docs/releases/qpid-java-trunk/java-broker/book/Java-Broker-Management-Channel-Web-Console.html Sat Jan 2 23:59:48 2016 @@ -114,24 +114,24 @@ https://github.com/apache/qpid-proton/bl <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-java-trunk/index.html">Qpid Java Trunk</a></li><li><a href="/releases/qpid-java-trunk/java-broker/book/index.html">AMQP Messaging Broker (Java)</a></li><li>6.2. Web Management Console</li></ul> <div id="-middle-content"> - <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 + <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" style="clear: both"><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> + including: </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-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="idm140601093137344"></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="idm140601093915472"></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 + </p><p>The Console will prompt you to login using a username and password.</p><div class="figure"><a id="d0e1777"></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="d0e1791"></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" style="list-style-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 + </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" style="list-style-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 @@ -161,7 +161,7 @@ https://github.com/apache/qpid-proton/bl 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> + 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="AMQP-Messaging-Broker-Java-Book.html">Home</a></td><td align="right" valign="top" width="40%"> 6.3. REST API</td></tr></table></div></div> <hr/> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
