Added: qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Initial-Configuration-Type.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Initial-Configuration-Type.html.in?rev=1739899&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Initial-Configuration-Type.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Initial-Configuration-Type.html.in Tue Apr 19 11:16:16 2016 @@ -0,0 +1,18 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">5.6. Configuration Store Type</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Initial-Configuration-Overwrite-Config-Store.html">Prev</a> </td><th align="center" width="60%">Chapter 5. Initial Configuration</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Initial-Configuration-Configuration-Properties.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-Initial-Configuration-Type"></a>5.6. Configuration Store Type</h2></div></div></div><p> There are currently several implementations of the pluggable Broker Configuration Store: + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term">JSON</span></dt><dd><p>the default one which persists content to disk in a JSON file</p></dd><dt><span class="term">Memory</span></dt><dd><p>operates only in-memory and so does not retain changes across broker + restarts and always relies on the current <a class="link" href="Java-Broker-Initial-Configuration-Initial-Config-Location.html" title="5.3. 'Initial Configuration' Location">'Initial + Configuration'</a> to provide the configuration to start the broker with. + </p></dd><dt><span class="term">DERBY</span></dt><dd><p>stores configuration in embedded derby store</p></dd><dt><span class="term">BDB</span></dt><dd><p>stores configuration in Berkeley DB store</p></dd><dt><span class="term">JDBC</span></dt><dd><p>stores configuration in external RDBMS using JDBC</p></dd></dl></div><p> + </p><p> The command line argument <span class="emphasis"><em>-st</em></span> (or + <span class="emphasis"><em>--store-type</em></span>) can be used to override the default + <span class="emphasis"><em>json</em></span>)configuration store type and allow choosing an alternative, + such as <span class="emphasis"><em>Memory</em></span>) </p><pre class="screen"> +$ ./qpid-server -st memory + </pre><p> This can be useful when running tests, or always wishing to start the broker with the + same <a class="link" href="Java-Broker-Initial-Configuration-Initial-Config-Location.html" title="5.3. 'Initial Configuration' Location">'Initial + Configuration'</a> + </p><p>Another example of broker startup with configuration in DERBY network server</p><pre class="screen"> +$ ./qpid-server -st JDBC \ + -prop "systemConfig.connectionUrl=jdbc:derby://localhost:1527/path/to/store;create=true" \ + -prop "systemConfig.username=test" -prop "systemConfig.password=password" + </pre></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Initial-Configuration-Overwrite-Config-Store.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Initial-Configuration.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Initial-Configuration-Configuration-Properties.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">5.5. Overwriting An Existing Configuration Store </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%"> 5.7. Customising Configuration using Configuration Properties</td></tr></table></div></div> \ No newline at end of file
Added: qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Initial-Configuration.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Initial-Configuration.html.in?rev=1739899&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Initial-Configuration.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Initial-Configuration.html.in Tue Apr 19 11:16:16 2016 @@ -0,0 +1,11 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 5. Initial Configuration</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Concepts-Other-Services.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Initial-Configuration-Location.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="Java-Broker-Initial-Configuration"></a>Chapter 5. Initial Configuration</h1></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="section"><a href="Java-Broker-Initial-Configuration.html#Java-Broker-Initial-Configuration-Introduction">5.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Location.html">5.2. Configuratio n Store Location</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Initial-Config-Location.html">5.3. 'Initial Configuration' Location</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Create-Initial-Config.html">5.4. Creating an 'Initial Configuration' JSON File</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Overwrite-Config-Store.html">5.5. Overwriting An Existing Configuration Store</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Type.html">5.6. Configuration Store Type</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Configuration-Properties.html">5.7. Customising Configuration using Configuration Properties</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Example.html">5.8. Example of JSON 'Initial Configuration'</a></span></dt></dl></div><div class="section"><div class= "titlepage"><div><div><h2 class="title" style="clear: both"><a id="Java-Broker-Initial-Configuration-Introduction"></a>5.1. Introduction</h2></div></div></div><p>This section describes how to perform initial configuration on the command line. Once + the Broker is started, subsequent management is performed using the <a class="link" href="Java-Broker-Management-Channel.html" title="Chapter 6. Management Channels">Management interfaces</a></p><p> The configuration for each component is stored as an entry in the broker + configuration store, currently implemented as a JSON file which persists changes to + disk, BDB or Derby database or an in-memory store which does not. The following + components configuration is stored there: </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Broker</p></li><li class="listitem"><p>Virtual Host Nodes</p></li><li class="listitem"><p>Loggers</p></li><li class="listitem"><p>Ports</p></li><li class="listitem"><p>Authentication Providers (optionally with Users for managing users Authentication Providers)</p></li><li class="listitem"><p>Access Control Providers</p></li><li class="listitem"><p>Group Providers (optionally with Groups and GroupMembers for managing groups Group Providers)</p></li><li class="listitem"><p>Key stores</p></li><li class="listitem"><p>Trust stores</p></li><li class="listitem"><p>Plugins</p></li></ul></div><p> + </p><p> Broker startup involves two configuration related items, the 'Initial Configuration' + and the Configuration Store. When the broker is started, if a Configuration Store does + not exist at the current <a class="link" href="Java-Broker-Initial-Configuration-Location.html" title="5.2. Configuration Store Location">store location</a> then one will be initialised with the current <a class="link" href="Java-Broker-Initial-Configuration-Initial-Config-Location.html" title="5.3. 'Initial Configuration' Location">'Initial + Configuration'</a>. Unless otherwise requested to <a class="link" href="Java-Broker-Initial-Configuration-Location.html" title="5.2. Configuration Store Location">overwrite the configuration + store</a> then subsequent broker restarts will use the existing configuration + store and ignore the contents of the 'Initial Configuration'. </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-Concepts-Other-Services.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Initial-Configuration-Location.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">4.10. Other Services </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%"> 5.2. Configuration Store Location</td></tr></table></div></div> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-Download.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-Download.html.in?rev=1739899&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-Download.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-Download.html.in Tue Apr 19 11:16:16 2016 @@ -0,0 +1,3 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">2.3. Download</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Installation-Prerequistes.html">Prev</a> </td><th align="center" width="60%">Chapter 2. Installation</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Installation-InstallationWindows.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-Installation-Download"></a>2.3. Download</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Installation-Download-Release"></a>2.3.1. Broker Release</h3></div></div></div><p>You can download the latest Java broker package from the <a class="link" href="http://qpid.apache.org/download.html"; target="_top">Download Page</a>. </p><p> It is recommended that you confirm the integrity of the download by verifying the PGP + signature matches that available on the site. Instructions are given on the download page. + </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-Installation-Prerequistes.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Installation.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Installation-InstallationWindows.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">2.2. Prerequisites </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%"> 2.4. Installation on Windows</td></tr></table></div></div> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-InstallationUnix.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-InstallationUnix.html.in?rev=1739899&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-InstallationUnix.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-InstallationUnix.html.in Tue Apr 19 11:16:16 2016 @@ -0,0 +1,25 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">2.5. Installation on UNIX platforms</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Installation-InstallationWindows.html">Prev</a> </td><th align="center" width="60%">Chapter 2. Installation</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Installation-OptionalDependencies.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-Installation-InstallationUnix"></a>2.5. Installation on UNIX platforms</h2></div></div></div><p> Firstly, verify that your JVM is installed properly by following <a class="link" href="Java-Broker-Miscellaneous.html#Java-Broker-Miscellaneous-JVM-Verification-Unix" title="E.1.2. Verify JVM on Unix">these instructions.</a> + </p><p>Now chose a directory for Qpid broker installation. This directory will be used for the + Qpid JARs and configuration files. It need not be the same location as the work directory used + for the persistent message store or the log file (you will choose this location later). For + the remainder this example we will assume that location /usr/local/qpid has been + chosen.</p><p>Next extract the qpid-broker-6.0.3-SNAPSHOT-bin.tgz package into the directory.</p><pre class="programlisting">mkdir /usr/local/qpid +cd /usr/local/qpid +tar xvzf qpid-broker-6.0.3-SNAPSHOT-bin.tgz</pre><p>The extraction of the broker package will have created a directory + qpid-broker/6.0.3-SNAPSHOT within /usr/local/qpid</p><pre class="screen">ls -la qpid-broker/6.0.3-SNAPSHOT/ +total 56 +drwxrwxr-x. 5 alex alex 4096 Nov 25 11:43 . +drwxrwxr-x. 3 alex alex 4096 Nov 25 11:43 .. +drwxr-xr-x. 2 alex alex 4096 Nov 24 23:38 bin +drwxr-xr-x. 2 alex alex 4096 Nov 24 23:38 etc +drwxrwxr-x. 2 alex alex 4096 Nov 25 11:43 lib +-rw-r--r--. 1 alex alex 28143 Nov 24 23:38 LICENSE +-rw-r--r--. 1 alex alex 3409 Nov 24 23:38 NOTICE +-rw-r--r--. 1 alex alex 116 Nov 24 23:38 README.txt + </pre><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Installation-InstallationUnix-SettingQPIDWORK"></a>2.5.1. Setting the working directory</h3></div></div></div><p>Qpid requires a work directory. This directory is used for the default location of the + Qpid log file and is used for the storage of persistent messages. The work directory can be + set on the command-line (for the lifetime of the current shell), but you will normally want + to set the environment variable permanently the user's shell profile file (~/.bash_profile + for Bash etc).</p><pre class="screen">export QPID_WORK=/var/qpidwork + </pre><p>If the directory referred to by <a class="link" href="Java-Broker-Appendix-Environment-Variables.html#Java-Broker-Appendix-Environment-Variables-Qpid-Work">QPID_WORK</a> does not + exist, the Java Broker will attempt to create it on start-up. </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-Installation-InstallationWindows.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Installation.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Installation-OptionalDependencies.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">2.4. Installation on Windows </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%"> 2.6. Optional Dependencies</td></tr></table></div></div> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-InstallationWindows.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-InstallationWindows.html.in?rev=1739899&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-InstallationWindows.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-InstallationWindows.html.in Tue Apr 19 11:16:16 2016 @@ -0,0 +1,26 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">2.4. Installation on Windows</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Installation-Download.html">Prev</a> </td><th align="center" width="60%">Chapter 2. Installation</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Installation-InstallationUnix.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-Installation-InstallationWindows"></a>2.4. Installation on Windows</h2></div></div></div><p> Firstly, verify that your JVM is installed properly by following <a class="link" href="Java-Broker-Miscellaneous.html#Java-Broker-Miscellaneous-JVM-Verification-Windows" title="E.1.1. Verify JVM on Windows">these instructions.</a> + </p><p>Now chose a directory for Qpid broker installation. This directory will be used for the + Qpid JARs and configuration files. It need not be the same location as the work directory used + for the persistent message store or the log file (you will choose this location later). For + the remainder this example we will assume that location c:\qpid has been chosen.</p><p>Next extract the qpid-broker-6.0.3-SNAPSHOT-bin.zip package into the directory, using either + the zip file handling offered by Windows (right click the file and select 'Extract All') or a + third party tool of your choice.</p><p>The extraction of the broker package will have created a directory + qpid-broker\\6.0.3-SNAPSHOT within c:\qpid</p><pre class="screen"> + Directory of c:\qpid\qpid-broker\\6.0.3-SNAPSHOT + +25/11/2015 11:29 <DIR> . +25/11/2015 11:29 <DIR> .. +25/11/2015 10:56 <DIR> bin +03/07/2015 08:06 <DIR> etc +25/11/2015 11:25 <DIR> lib +25/11/2015 10:56 28,143 LICENSE +25/11/2015 10:56 3,409 NOTICE +29/04/2015 09:13 116 README.txt +3 File(s) 31,668 bytes +5 Dir(s) 25,981,767,680 bytes free +</pre><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Installation-InstallationWindows-SettingQPIDWORK"></a>2.4.1. Setting the working directory</h3></div></div></div><p>Qpid requires a work directory. This directory is used for the default location of the + Qpid log file and is used for the storage of persistent messages. The work directory can be + set on the command-line (for the lifetime of the command interpreter), but you will normally + want to set the environment variable permanently via the Advanced System Settings in the + Control Panel.</p><pre class="screen">set QPID_WORK=C:\qpidwork</pre><p>If the directory referred to by <a class="link" href="Java-Broker-Appendix-Environment-Variables.html#Java-Broker-Appendix-Environment-Variables-Qpid-Work">QPID_WORK</a> does not + exist, the Java Broker will attempt to create it on start-up.</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-Installation-Download.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Installation.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Installation-InstallationUnix.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">2.3. Download </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%"> 2.5. Installation on UNIX platforms</td></tr></table></div></div> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-OptionalDependencies.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-OptionalDependencies.html.in?rev=1739899&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-OptionalDependencies.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-OptionalDependencies.html.in Tue Apr 19 11:16:16 2016 @@ -0,0 +1,3 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">2.6. Optional Dependencies</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Installation-InstallationUnix.html">Prev</a> </td><th align="center" width="60%">Chapter 2. Installation</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Getting-Started.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-Installation-OptionalDependencies"></a>2.6. Optional Dependencies</h2></div></div></div><p>If you wish to utilise storage options using Oracle BDB JE or an External Database, see + <a class="xref" href="Java-Broker-Miscellaneous-Installing-Oracle-BDB-JE.html" title="E.3. Installing Oracle BDB JE">Section E.3, “Installing Oracle BDB JE”</a> and <a class="xref" href="Java-Broker-Miscellaneous-Installing-External-JDBC-Driver.html" title="E.2. Installing External JDBC Driver">Section E.2, “Installing External JDBC Driver”</a> for details of + installing their dependencies.</p></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Installation-InstallationUnix.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Installation.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Getting-Started.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">2.5. Installation on UNIX platforms </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 3. Getting Started</td></tr></table></div></div> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-Prerequistes.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-Prerequistes.html.in?rev=1739899&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-Prerequistes.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation-Prerequistes.html.in Tue Apr 19 11:16:16 2016 @@ -0,0 +1,21 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">2.2. Prerequisites</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Installation.html">Prev</a> </td><th align="center" width="60%">Chapter 2. Installation</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Installation-Download.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-Installation-Prerequistes"></a>2.2. Prerequisites</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Installation-Prerequistes-Java"></a>2.2.1. Java Platform</h3></div></div></div><p> The Java Broker is an 100% Java implementation and as such it can be used on any + operating system supporting Java 1.7 or higher<a class="footnote" href="#ftn.d0e103" id="d0e103"><sup class="footnote">[4]</sup></a>. This includes Linux, Solaris, Mac OS X, and + Windows XP/Vista/7/8.</p><p> The broker has been tested with Java implementations from both Oracle and IBM. Whatever + platform you chose, it is recommended that you ensure it is patched with any critical + updates made available from the vendor. </p><p> Verify that your JVM is installed properly by following <a class="link" href="Java-Broker-Miscellaneous.html#Java-Broker-Miscellaneous-JVM-Verification" title="E.1. JVM Installation verification">these instructions.</a> + </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Installation-Prerequistes-Disk"></a>2.2.2. Disk</h3></div></div></div><p>The Java Broker installation requires approximately 20MB of free disk space.</p><p>The Java Broker also requires a working directory. The working directory is used for the + message store, that is, the area of the file-system used to record messages + whilst they are passing through the Broker. The working directory is also used for the + default location of the log file. The size of the working directory will depend on the how + the Broker is used.</p><p>The performance of the file system hosting the work directory is key to the performance + of Broker as a whole. For best performance, choose a device that has low latency and one + that is uncontended by other applications.</p><p>Be aware that there are additional considerations if you are considering hosting the + working directory on NFS.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Installation-Prerequistes-Memory"></a>2.2.3. Memory</h3></div></div></div><p>Qpid caches messages in memory for performance reasons, so in general, the Broker will + benefit from as much memory as possible. However, on a 32bit JVM, the maximum addressable + memory range for a process is 4GB, after leaving space for the JVM's own use this will give + a maximum usable size of approximately ~3.7GB.</p><p>See <a class="xref" href="Java-Broker-Runtime-Memory.html" title="9.10. Memory">Section 9.10, “Memory”</a> for a full description of how memory is + used.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Installation-Prerequistes-OperatingSystemAccount"></a>2.2.4. Operating System Account</h3></div></div></div><p>Installation or operation of Qpid does <span class="emphasis"><em>not</em></span> require a privileged + account (i.e. root on UNIX platforms or Administrator on Windows). However it is suggested + that you use an dedicated account (e.g. qpid) for the installation and operation of the Java + Broker.</p></div><div class="footnotes"><br /><hr style="width:100; text-align:left;margin-left: 0" /><div class="footnote" id="ftn.d0e103"><p><a class="para" href="#d0e103"><sup class="para">[4] </sup></a>Java Cryptography Extension (JCE) + Unlimited Strength policy file are required for some features</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-Installation.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Installation.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Installation-Download.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">Chapter 2. Installation </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%"> 2.3. Download</td></tr></table></div></div> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation.html.in?rev=1739899&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Installation.html.in Tue Apr 19 11:16:16 2016 @@ -0,0 +1,2 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 2. Installation</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Introduction.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Installation-Prerequistes.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="Java-Broker-Installation"></a>Chapter 2. Installation</h1></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="section"><a href="Java-Broker-Installation.html#Java-Broker-Installation-Introduction">2.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Installation-Prerequistes.html">2.2. Prerequisites</a></span></dt><dd><dl><dt><span class="section"><a href="Java-B roker-Installation-Prerequistes.html#Java-Broker-Installation-Prerequistes-Java">2.2.1. Java Platform</a></span></dt><dt><span class="section"><a href="Java-Broker-Installation-Prerequistes.html#Java-Broker-Installation-Prerequistes-Disk">2.2.2. Disk</a></span></dt><dt><span class="section"><a href="Java-Broker-Installation-Prerequistes.html#Java-Broker-Installation-Prerequistes-Memory">2.2.3. Memory</a></span></dt><dt><span class="section"><a href="Java-Broker-Installation-Prerequistes.html#Java-Broker-Installation-Prerequistes-OperatingSystemAccount">2.2.4. Operating System Account</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Installation-Download.html">2.3. Download</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Installation-Download.html#Java-Broker-Installation-Download-Release">2.3.1. Broker Release</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Installation-InstallationWindows.html">2.4. Installation o n Windows</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Installation-InstallationWindows.html#Java-Broker-Installation-InstallationWindows-SettingQPIDWORK">2.4.1. Setting the working directory</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Installation-InstallationUnix.html">2.5. Installation on UNIX platforms</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Installation-InstallationUnix.html#Java-Broker-Installation-InstallationUnix-SettingQPIDWORK">2.5.1. Setting the working directory</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Installation-OptionalDependencies.html">2.6. Optional Dependencies</a></span></dt></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Java-Broker-Installation-Introduction"></a>2.1. Introduction</h2></div></div></div><p>This document describes how to install the Java Broker on both Windows and UNIX + platforms.</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-Introduction.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Installation-Prerequistes.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">Chapter 1. Introduction </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%"> 2.2. Prerequisites</td></tr></table></div></div> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Introduction.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Introduction.html.in?rev=1739899&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Introduction.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Introduction.html.in Tue Apr 19 11:16:16 2016 @@ -0,0 +1,7 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 1. Introduction</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="AMQP-Messaging-Broker-Java-Book.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Installation.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="Java-Broker-Introduction"></a>Chapter 1. Introduction</h1></div></div></div><p>The Java Broker is a powerful open-source message broker that implements all versions of the + <a class="link" href="http://www.amqp.org"; target="_top"> Advanced Message Queuing Protocol (AMQP)</a>. The Java + Broker is actually one of two message brokers provided by the <a class="link" href="http://qpid.apache.org"; target="_top">Apache Qpid project</a>: the Java Broker and the C++ + Broker.</p><p>This document relates to the Java Broker. The <a class="link" href="/releases/qpid-cpp-{{current_cpp_release}}/cpp-broker/book/" target="_top">C++ Broker is + described separately</a>.</p><p><span class="emphasis"><em>Headline features</em></span></p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem" style="list-style-type: circle"><p>100% Java implementation - runs on any platform supporting Java 1.7 or higher</p></li><li class="listitem" style="list-style-type: circle"><p>Messaging clients support in Java, C++, Python.</p></li><li class="listitem" style="list-style-type: circle"><p>JMS 1.1 compliance (Java client).</p></li><li class="listitem" style="list-style-type: circle"><p>Persistent and non-persistent (transient) message support</p></li><li class="listitem" style="list-style-type: circle"><p>Supports for all common messaging patterns (point-to-point, publish/subscribe, fan-out + etc).</p></li><li class="listitem" style="list-style-type: circle"><p>Transaction support including XA<a class="footnote" href="#ftn.d0e44" id="d0e44"><sup class="footnote">[1]</sup></a></p></li><li class="listitem" style="list-style-type: circle"><p>Supports for all versions of the AMQP protocol</p></li><li class="listitem" style="list-style-type: circle"><p>Automatic message translation, allowing clients using different AMQP versions to communicate with each other.</p></li><li class="listitem" style="list-style-type: circle"><p>Pluggable authentication architecture with out-of-the-box support for Kerberos, LDAP, + External, and file-based authentication mechanisms.</p></li><li class="listitem" style="list-style-type: circle"><p>Support for message compression</p></li><li class="listitem" style="list-style-type: circle"><p>Client support for end to end message encryption</p></li><li class="listitem" style="list-style-type: circle"><p>Pluggable storage architecture with implementations including <a class="link" href="http://db.apache.org/derby/"; target="_top">Apache Derby</a>, <a class="link" href="${oracleBdbProductOverviewUrl}" target="_top">Oracle BDB JE</a><a class="footnote" href="#ftn.d0e70" id="d0e70"><sup class="footnote">[2]</sup></a>, and External Database</p></li><li class="listitem" style="list-style-type: circle"><p>Web based management interface and programmatic management interfaces via REST.</p></li><li class="listitem" style="list-style-type: circle"><p>SSL support</p></li><li class="listitem" style="list-style-type: circle"><p>High availability (HA) support.<a class="f ootnote" href="#ftn.d0e83" id="d0e83"><sup class="footnote">[3]</sup></a></p></li></ul></div><div class="footnotes"><br /><hr style="width:100; text-align:left;margin-left: 0" /><div class="footnote" id="ftn.d0e44"><p><a class="para" href="#d0e44"><sup class="para">[1] </sup></a>XA provided when using AMQP 0-10</p></div><div class="footnote" id="ftn.d0e70"><p><a class="para" href="#d0e70"><sup class="para">[2] </sup></a>Oracle BDB JE must be downloaded separately.</p></div><div class="footnote" id="ftn.d0e83"><p><a class="para" href="#d0e83"><sup class="para">[3] </sup></a>HA currently only available to users of the optional BDB JE HA based message store.</p></div></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="AMQP-Messaging-Broker-Java-Book.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Installat ion.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">AMQP Messaging Broker (Java) </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 2. Installation</td></tr></table></div></div> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html.in?rev=1739899&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html.in Tue Apr 19 11:16:16 2016 @@ -0,0 +1,3 @@ +<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-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> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-QMF.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-QMF.html.in?rev=1739899&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-QMF.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-QMF.html.in Tue Apr 19 11:16:16 2016 @@ -0,0 +1 @@ +<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-Ma nagement-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> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-REST-API.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-REST-API.html.in?rev=1739899&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-REST-API.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-REST-API.html.in Tue Apr 19 11:16:16 2016 @@ -0,0 +1,139 @@ +<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>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.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="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-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> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-Web-Console.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-Web-Console.html.in?rev=1739899&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-Web-Console.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel-Web-Console.html.in Tue Apr 19 11:16:16 2016 @@ -0,0 +1,48 @@ +<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" 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="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" 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 + 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="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> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel.html.in?rev=1739899&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Channel.html.in Tue Apr 19 11:16:16 2016 @@ -0,0 +1,13 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 6. Management Channels</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Initial-Configuration-Example.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Channel-Web-Console.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="Java-Broker-Management-Channel"></a>Chapter 6. Management Channels</h1></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="section"><a href="Java-Broker-Management-Channel.html#Java-Broker-Management-Channel-HTTP">6.1. HTTP Management</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Channel.html#Java-Broker-Management-Channel-HTT P-Introduction">6.1.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel.html#Java-Broker-Management-Channel-HTTP-DefaultConfiguration">6.1.2. Default Configuration</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Channel-Web-Console.html">6.2. Web Management Console</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Channel-Web-Console.html#Java-Broker-Management-Channel-Web-Console-Accessing">6.2.1. Accessing the Console</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-Web-Console.html#Java-Broker-Management-Channel-Web-Console-Orientation">6.2.2. Orientation</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-Web-Console.html#Java-Broker-Management-Channel-Web-Console-Managing-Entities">6.2.3. Managing Entities</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html ">6.3. REST API</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Introduction">6.3.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-APIDocs">6.3.2. REST API documentation</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Authentication">6.3.3. Authentication</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Create">6.3.4. Configured Object creation</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Update">6.3.5. Configured Object update</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broke r-Management-Channel-REST-API-Delete">6.3.6. Configured Object deletion</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Get">6.3.7. Retrieving Configured Object details</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Operations">6.3.8. Configured Object operations</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Status-Codes">6.3.9. HTTP status codes returned by REST interfaces</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Examples">6.3.10. Examples of REST requests with curl</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Channel-AMQP-Intrinstic.html">6.4. AMQP Intrinstic Management</a></span></dt><dt><sp an class="section"><a href="Java-Broker-Management-Channel-QMF.html">6.5. QMF</a></span></dt></dl></div><p>The Broker can be managed over a number of different channels.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>HTTP - The primary channel for management. The HTTP interface comprises a Web + Console and a REST API.</p></li><li class="listitem"><p>AMQP - The AMQP protocols 0-8..0-10 allow for some management of Exchanges, Queue and + Bindings. This will be superseded by AMQP 1.0 Management. It is suggested that new users + favour the Management facilities provided by the Web Console/REST API.</p></li></ul></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Java-Broker-Management-Channel-HTTP"></a>6.1. HTTP Management</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-HTTP-Introduction"></a>6.1.1. Introduction</h3></div></div></div><p>The HTTP Management plugin provides a HTTP based API for monitoring and control of the + Broker. The plugin actually provides two interfaces:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a class="link" href="Java-Broker-Management-Channel-Web-Console.html" title="6.2. Web Management Console">Web Management + Console</a> - rich web based interface for the management of the + Broker.</p></li><li class="listitem"><p><a class="link" href="Java-Broker-Management-Channel-REST-API.html" title="6.3. REST API">REST API</a> - + REST API providing complete programmatic management of the Broker.</p></li></ul></div><p>The Web Management Console itself uses the REST API, so every function you can perform + through the Web Management Console can be also be scripted and integrated into other + systems. This provides a simple integration point allowing the Broker to monitored and + controlled from systems such as Naoios or BMC Control-M.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-HTTP-DefaultConfiguration"></a>6.1.2. Default Configuration</h3></div></div></div><p>By default, the Broker is shipped with HTTP enabled running port 8080. The HTTP plugin + is configured to require SASL authentication. The port is not SSL protected.</p><p>The settings can be changed by configuring the HTTP plugin and/or the port configured + to serve HTTP.</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-Initial-Configuration-Example.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Channel-Web-Console.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">5.8. Example of JSON 'Initial Configuration' </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.2. Web Management Console</td></tr></table></div></div> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Managing-Access-Control-Providers.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Managing-Access-Control-Providers.html.in?rev=1739899&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Managing-Access-Control-Providers.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.2/java-broker/book/Java-Broker-Management-Managing-Access-Control-Providers.html.in Tue Apr 19 11:16:16 2016 @@ -0,0 +1,3 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">7.15. Access Control Providers</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Managing-Group-Providers.html">Prev</a> </td><th align="center" width="60%">Chapter 7. Managing Entities</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Managing-Plugin-HTTP.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-Managing-Access-Control-Providers"></a>7.15. Access Control Providers</h2></div></div></div><p>An <a class="link" href="Java-Broker-Concepts-Other-Services.html#Java-Broker-Concepts-Access-Control-Providers" title="4.10.1. Access Control Providers">Access Control + Provider</a> governs who may do what within the Broker. It governs both messaging and + management.</p><p>See <a class="xref" href="Java-Broker-Security-ACLs.html" title="8.3. Access Control Lists">Section 8.3, “Access Control Lists”</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-Managing-Group-Providers.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Managing-Entities.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Managing-Plugin-HTTP.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">7.14. Group Providers </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%"> 7.16. HTTP Plugin</td></tr></table></div></div> \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
