Added: qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Initial-Config-Location.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Initial-Config-Location.html.in?rev=1718924&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Initial-Config-Location.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Initial-Config-Location.html.in Wed Dec 9 17:41:59 2015 @@ -0,0 +1,11 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">5.3. 'Initial Configuration' Location</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Initial-Configuration-Location.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-Create-Initial-Config.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Initial-Configuration-Initial-Config-Location"></a>5.3. 'Initial Configuration' Location</h2></div></div></div><p> The 'Initial Configuration' JSON file is used when initialising new broker + configuration stores. The broker will default to using an internal file within its jar + unless otherwise instructed. </p><p> The command line argument <span class="emphasis"><em>-icp </em></span> (or + <span class="emphasis"><em>--initial-config-path</em></span>) can be used to override the brokers + internal file and supply a <a class="link" href="Java-Broker-Initial-Configuration-Create-Initial-Config.html" title="5.4. Creating an 'Initial Configuration' JSON File">user-created + one</a>:</p><pre class="screen"> +$ ./qpid-server -icp ./my-initial-configuration.json + </pre><p> If a Configuration Store already exists at the current <a class="link" href="Java-Broker-Initial-Configuration-Location.html" title="5.2. Configuration Store Location">store location</a> then the + current 'Initial Configuration' will be ignored 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> + </p></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-Location.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-Create-Initial-Config.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">5.2. Configuration Store Location </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 5.4. Creating an 'Initial Configuration' JSON File</td></tr></table></div></div> \ No newline at end of file
Added: qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Location.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Location.html.in?rev=1718924&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Location.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Location.html.in Wed Dec 9 17:41:59 2015 @@ -0,0 +1,8 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">5.2. Configuration Store Location</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Initial-Configuration.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-Initial-Config-Location.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Initial-Configuration-Location"></a>5.2. Configuration Store Location</h2></div></div></div><p> The broker will default to using <a class="link" href="Java-Broker-Initial-Configuration-Configuration-Properties.html" title="5.7. Customising Configuration using Configuration Properties">${qpid.work_dir}</a>/config.json as the path for its configuration store unless + otherwise instructed. </p><p> The command line argument <span class="emphasis"><em>-sp</em></span> (or + <span class="emphasis"><em>--store-path</em></span>) can optionally be used to specify a different + relative or absolute path to use for the broker configuration store: </p><pre class="screen"> +$ ./qpid-server -sp ./my-broker-configuration.json + </pre><p> If no configuration store exists at the specified/defaulted location when the broker + starts then one will be initialised using the current <a class="link" href="Java-Broker-Initial-Configuration-Initial-Config-Location.html" title="5.3. 'Initial Configuration' Location">'Initial + Configuration'</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-Initial-Configuration.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-Initial-Config-Location.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">Chapter 5. Initial Configuration </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 5.3. 'Initial Configuration' Location</td></tr></table></div></div> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Overwrite-Config-Store.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Overwrite-Config-Store.html.in?rev=1718924&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Overwrite-Config-Store.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Overwrite-Config-Store.html.in Wed Dec 9 17:41:59 2015 @@ -0,0 +1,11 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">5.5. Overwriting An Existing Configuration Store</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Initial-Configuration-Create-Initial-Config.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-Type.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Initial-Configuration-Overwrite-Config-Store"></a>5.5. Overwriting An Existing Configuration Store</h2></div></div></div><p> If a configuration store already exists at the configured <a class="link" href="Java-Broker-Initial-Configuration-Location.html" title="5.2. Configuration Store Location">store location</a> then it + is used and the current <a class="link" href="Java-Broker-Initial-Configuration-Initial-Config-Location.html" title="5.3. 'Initial Configuration' Location">'Initial + Configuration'</a> is ignored. </p><p> The command line argument <span class="emphasis"><em>-os</em></span> (or + <span class="emphasis"><em>--overwrite-store</em></span>) can be used to force a new broker + configuration store to be initialised from the current 'Initial Configuration' even if + one exists: </p><pre class="screen"> +$ ./qpid-server -os -icp ./my-initial-configuration.json + </pre><p> This can be useful to effectively play configuration into one or more broker to + pre-configure them to a particular state, or alternatively to ensure a broker is always + started with a fixed configuration. In the latter case, use of the Memory <a class="link" href="Java-Broker-Initial-Configuration-Type.html" title="5.6. Configuration Store Type">Configuration Store Type</a> may + also be useful. </p></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-Create-Initial-Config.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-Type.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">5.4. Creating an 'Initial Configuration' JSON File </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 5.6. Configuration Store Type</td></tr></table></div></div> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Type.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Type.html.in?rev=1718924&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Type.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration-Type.html.in Wed Dec 9 17:41:59 2015 @@ -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"><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="index.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.0/java-broker/book/Java-Broker-Initial-Configuration.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration.html.in?rev=1718924&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Initial-Configuration.html.in Wed Dec 9 17:41:59 2015 @@ -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"><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" 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="index.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.0/java-broker/book/Java-Broker-Installation-Download.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation-Download.html.in?rev=1718924&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation-Download.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation-Download.html.in Wed Dec 9 17:41:59 2015 @@ -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"><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="ulink" href="http://qpid.apache.org/download.html"; target="_top">Download Page</a>. </p><p> It is reco mmended 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="index.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.0/java-broker/book/Java-Broker-Installation-InstallationUnix.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation-InstallationUnix.html.in?rev=1718924&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation-InstallationUnix.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation-InstallationUnix.html.in Wed Dec 9 17:41:59 2015 @@ -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"><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.0-bin.tar.gz package into the directory.</p><pre class="programlisting">mkdir /usr/local/qpid +cd /usr/local/qpid +tar xvzf qpid-broker-6.0.0-bin.tar.gz</pre><p>The extraction of the broker package will have created a directory + qpid-broker/6.0.0 within /usr/local/qpid</p><pre class="screen">ls -la qpid-broker/6.0.0/ +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="index.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.0/java-broker/book/Java-Broker-Installation-InstallationWindows.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation-InstallationWindows.html.in?rev=1718924&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation-InstallationWindows.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation-InstallationWindows.html.in Wed Dec 9 17:41:59 2015 @@ -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"><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.0-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.0 within c:\qpid</p><pre class="screen"> + Directory of c:\qpid\qpid-broker\6.0.0 + +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="index.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.0/java-broker/book/Java-Broker-Installation-OptionalDependencies.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation-OptionalDependencies.html.in?rev=1718924&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation-OptionalDependencies.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation-OptionalDependencies.html.in Wed Dec 9 17:41:59 2015 @@ -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"><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="index.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.0/java-broker/book/Java-Broker-Installation-Prerequistes.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation-Prerequistes.html.in?rev=1718924&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation-Prerequistes.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation-Prerequistes.html.in Wed Dec 9 17:41:59 2015 @@ -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"><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.idm140683147674128" id="idm140683147674128"><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 align="left" width="100" /><div class="footnote" id="ftn.idm140683147674128"><p><a class="para" href="#idm140683147674128"><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="index.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.0/java-broker/book/Java-Broker-Installation.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation.html.in?rev=1718924&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Installation.html.in Wed Dec 9 17:41:59 2015 @@ -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"><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="index.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.0/java-broker/book/Java-Broker-Introduction.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Introduction.html.in?rev=1718924&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Introduction.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Introduction.html.in Wed Dec 9 17:41:59 2015 @@ -0,0 +1,8 @@ +<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="index.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="ulink" 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="ulink" 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="ulink" href="../../../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" type="circle"><li class="listitem"><p>100% Java implementation - runs on any platform supporting Java 1.7 or higher</p></li><li class="listitem"><p>Messaging clients support in Java, C++, Python.</p></li><li class="listitem"><p>JMS 1.1 compliance (Java client).</p></li><li class="listitem"><p>Persistent and non-persistent (transient) message support</p></li><li class="listitem"><p>Supports for all common messaging patterns (point-to-point, publish/subscribe, fan-out + etc).</p></li><li class="listitem"><p>Transaction support including XA<a class="footnote" href="#ftn.idm140683147832592" id="idm140683147832592"><sup class="footnote">[1]</sup></a></p></li><li class="listitem"><p>Supports for all versions of the AMQP protocol</p></li><li class="listitem"><p>Automatic message translation, allowing clients using different AMQP versions to communicate with each other.</p></li><li class="listitem"><p>Pluggable authentication architecture with out-of-the-box support for Kerberos, LDAP, + External, and file-based authentication mechanisms.</p></li><li class="listitem"><p>Support for message compression</p></li><li class="listitem"><p>Client support for end to end message encryption</p></li><li class="listitem"><p>Pluggable storage architecture with implementations including <a class="ulink" href="http://db.apache.org/derby/"; target="_top">Apache Derby</a>, <a class="ulink" href="http://www.oracle.com/technetwork/products/berkeleydb/overview/index-093405.html"; target="_top">Oracle BDB JE</a><a class="footnote" href="#ftn.idm140683147825488" id="idm140683147825488"><sup class="footnote">[2]</sup></a>, and External Database</p></li><li class="listitem"><p>Web based management interface and programmatic management interfaces via REST and JMX + APIs.</p></li><li class="listitem"><p>SSL support</p></li><li class="listitem"><p>High availability (HA) support.<a class="footnote" href="#ftn.idm140683147822192" id="idm140683147822192"><sup class="footnote">[3]</sup></a></p></li></ul></div><div class="footnotes"><br /><hr align="left" width="100" /><div class="footnote" id="ftn.idm140683147832592"><p><a class="para" href="#idm140683147832592"><sup class="para">[1] </sup></a>XA provided when using AMQP 0-10</p></div><div class="footnote" id="ftn.idm140683147825488"><p><a class="para" href="#idm140683147825488"><sup class="para">[2] </sup></a>Oracle BDB JE must be downloaded separately.</p></div><div class="footnote" id="ftn.idm140683147822192"><p><a class="para" href="#idm140683147822192"><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" wid th="40%"><a accesskey="p" href="index.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Installation.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="index.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.0/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.0/java-broker/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html.in?rev=1718924&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html.in Wed Dec 9 17:41:59 2015 @@ -0,0 +1,3 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">6.5. AMQP Intrinstic Management</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Channel-JMX.html">Prev</a> </td><th align="center" width="60%">Chapter 6. Management Channels</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Channel-QMF.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Channel-AMQP-Intrinstic"></a>6.5. AMQP Intrinstic Management</h2></div></div></div><p>The AMQP protocols 0-8..0-10 allow for creation, deletion and query of Exchanges, Queue + and Bindings.</p><p>The exact details of how to utilise this commands depends of the client. See the + documentation accompanying the client for details.</p></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Management-Channel-JMX.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Channel.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Channel-QMF.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">6.4. JMX Management </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 6.6. QMF</td></tr></table></div></div> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-JMX.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-JMX.html.in?rev=1718924&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-JMX.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-JMX.html.in Wed Dec 9 17:41:59 2015 @@ -0,0 +1,136 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">6.4. JMX Management</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Channel-REST-API.html">Prev</a> </td><th align="center" width="60%">Chapter 6. Management Channels</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Channel-AMQP-Intrinstic.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Channel-JMX"></a>6.4. JMX Management</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-JMX-Introduction"></a>6.4.1. Introduction</h3></div></div></div><p>The JMX management plugin provides a series of managed beans (MBeans) allowing you to + control and monitor the Broker via an industry compliant interface. This provides a + convenient integration point for a variety of Infrastructure Monitoring Solutions, + tools such as Jconsole and VisualVM, as well as custom Java programs and scripts.</p><p>The following sections describe how to connect to JMX, the configuration of the JMX + plugin covering topis including securing with SSL, programmatically interacting with + Qpid MBeans and finally a summary of all the MBeans made available from by the + plugin.</p><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Important</h3><p>For new development work, the reader is directed towards the strategic <a class="link" href="Java-Broker-Management-Channel-Web-Console.html" title="6.2. Web Management Console">Web Management + Console</a> and the <a class="link" href="Java-Broker-Management-Channel-REST-API.html" title="6.3. REST API">REST API</a>. Use the + Web/REST interfaces in preference to JMX whenever possible. The JMX interface will be + withdrawn in a future release.</p></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-JMX-Plugin-DefaultConfiguration"></a>6.4.2. Default Configuration</h3></div></div></div><p>By default, the Broker is shipped with JMX <span class="emphasis"><em>disabled</em></span>. + To enable it, it necessary to add two ports: one serving the protocol JMX_RMI and one for + the RMI registry. This can be done using the Web Management Console. + </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-JMX-Plugin-ConnectingToJMX"></a>6.4.3. Connecting to JMX</h3></div></div></div><p>The following example uses Jconsole to illustrates how to connect to JMX using jconsole. + Jconsole is a management tool that comes with the JDK. It provides a very simple view of the MBeans, + but requires no special configuration to be used with Qpid.</p><p>For full details of Jconsole itself refer to Oracle's <a class="ulink" href="http://docs.oracle.com/javase/7/docs/technotes/guides/management/jconsole.html"; target="_top">JConsole Guide</a>.</p><p>Jconsole can be used to connect to local or remote Java processes. On startup, it + presents a list of all the Java processes running on the local host and also allows you + to specify a service url to connect to a Java process running on a remote host.</p><p>To start Jconsole on the command line, type:</p><pre class="programlisting">jconsole</pre><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-JMX-Plugin-ConnectingToJMX-Local"></a>6.4.3.1. Local</h4></div></div></div><p>To connect to a Broker running locally, simply select the process from the list. + You can identify the Broker by looking for its classname + <code class="literal">org.apache.qpid.server.Main</code>.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-JMX-Plugin-ConnectingToJMX-Remote"></a>6.4.3.2. Remote</h4></div></div></div><p>To connect to a broker running remotely, provide the hostname and port number of + the <span class="emphasis"><em>RMI registry port</em></span> (e.g. <code class="literal">hostname:8999</code>) + and a valid username and password.</p><p>You can also provide a service url in the form + <code class="literal">service:jmx:rmi:///jndi/rmi://hostname:8999/jmxrmi</code></p><div class="figure"><a id="idm140683146789488"></a><p class="title"><strong>Figure 6.7. Making a remote JMX connection to a Broker using jconsole</strong></p><div class="figure-contents"><div><img alt="Making a remote JMX connection to a Broker using jconsole" src="images/JMX-Connect-Remote.png" /></div></div></div><br class="figure-break" /></div><p>Once you are connected expand the tree of nodes marked + <code class="literal">org.apache.qpid</code> to begin to interact with the Qpid MBeans.</p><div class="figure"><a id="idm140683146786832"></a><p class="title"><strong>Figure 6.8. Qpid MBean hierarchy</strong></p><div class="figure-contents"><div><img alt="Qpid MBean hierarchy" src="images/JMX-Connect-MBeans.png" /></div></div></div><br class="figure-break" /><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-JMX-Plugin-ConnectingToJMX-SSL"></a>6.4.3.3. Connecting to a remote Broker protected by SSL</h4></div></div></div><p>If you are connecting to a remote Broker whose JMX connector port has been secured + with SSL certificate signed by a private CA (or a self-signed certificate), you will + need to pass a trust store and trust store password to Jconsole. If this is + required, start jconsole with the following options:</p><pre class="programlisting">jconsole -J-Djavax.net.ssl.trustStore=jmxtruststore.jks -J-Djavax.net.ssl.trustStorePassword=password</pre></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-JMX-Example-Client"></a>6.4.4. Example JMX Client</h3></div></div></div><p>The following java snippet illustrates a JMX client that connects to Qpid over JMX + passing a userid and password, looks up the <a class="ulink" href="http://svn.apache.org/viewvc/qpid/java/trunk/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedBroker.java?view=co"; target="_top">ManagedBroker</a> object corresponding to the <code class="literal">myvhost</code> + virtualhost, then invokes a method on the virtualhost to create a new queue.</p><p>A full introduction to custom JMX clients is beyond the scope of this book. For this + the reader is directed toward Oracle's <a class="ulink" href="http://docs.oracle.com/javase/tutorial/jmx/"; target="_top">JMX + tutorial.</a></p><div class="example"><a id="Java-Broker-Management-JMX-Example-Client-Code"></a><p class="title"><strong>Example 6.7. JMX Client illustrating the creation of a new queue</strong></p><div class="example-contents"><pre class="programlisting"> +Map<String, Object< environment = new HashMap<String, Object>(); +environment.put(JMXConnector.CREDENTIALS, new String[] {"admin","password"}); +// Connect to service +JMXServiceURL url = new JMXServiceURL("service:jmx:rmi:///jndi/rmi://localhost:8999/jmxrmi"); +JMXConnector jmxConnector = JMXConnectorFactory.connect(url, environment); +MBeanServerConnection mbsc = jmxConnector.getMBeanServerConnection(); +// Object name for ManagedBroker mbean for virtualhost myvhost +ObjectName objectName = new ObjectName("org.apache.qpid:type=VirtualHost.VirtualHostManager,VirtualHost=\"myvhost\""); +// Get the ManagedBroker object +ManagedBroker managedBroker = JMX.newMBeanProxy(mbsc, objectName, ManagedBroker.class);; + +// Create the queue named "myqueue" +managedBroker.createNewQueue("myqueue", null, true);</pre></div></div><br class="example-break" /><p>The Qpid classes required for a custom JMX client are included in the + <code class="literal">qpid-management-common</code> artefact.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-JMX-MBeans"></a>6.4.5. The MBeans</h3></div></div></div><p>The following table summarises the available MBeans. The MBeans are self-describing: + each attribute and operation carry a description describing their purpose. This + description is visible when using tools such Jconsole. They are also available on + Management interfaces themselves (linked below).</p><div class="table"><a id="idm140683146772784"></a><p class="title"><strong>Table 6.2. Qpid Broker MBeans</strong></p><div class="table-contents"><table border="1" summary="Qpid Broker MBeans"><colgroup><col /><col /></colgroup><thead><tr><th>Management Interface</th><th>Object Name</th></tr></thead><tbody><tr><td rowspan="2"> + <p> + <a class="ulink" href="http://svn.apache.org/viewvc/qpid/java/trunk/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedBroker.java?view=co"; target="_top">ManagedBroker</a> + </p> + </td><td> + <p> + <code class="literal">org.apache.qpid:type=VirtualHost.VirtualHostManager,VirtualHost="<em class="replaceable"><code>virtualhostname</code></em>"</code> + </p> + </td></tr><tr><td> + <p>MBean corresponding to the named virtualhost. Allows operations + such as the creation/deletion of queues and exchanges on that + virtualhost and virtualhost level statistics.</p> + </td></tr><tr><td rowspan="2"> + <p> + <a class="ulink" href="http://svn.apache.org/viewvc/qpid/java/trunk/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedQueue.java?view=co"; target="_top">ManagedQueue</a> + </p> + </td><td> + <p> + <code class="literal">org.apache.qpid:type=VirtualHost.Queue,VirtualHost="<em class="replaceable"><code>virtualhostname</code></em>",name="<em class="replaceable"><code>queuename</code></em>"</code> + </p> + </td></tr><tr><td> + <p>MBean corresponding to the named queue on the given virtualhost. + Allows queue management operations such as view message, move + message and clear queue. Exposes attributes such as queue depth and + durability.</p> + </td></tr><tr><td rowspan="2"> + <p> + <a class="ulink" href="http://svn.apache.org/viewvc/qpid/java/trunk/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedExchange.java?view=co"; target="_top">ManagedExchange</a> + </p> + </td><td> + <p> + <code class="literal">org.apache.qpid:type=VirtualHost.Exchange,VirtualHost="<em class="replaceable"><code>virtualhostname</code></em>",name="<em class="replaceable"><code>amq.direct</code></em>",ExchangeType=<em class="replaceable"><code>type</code></em></code> + </p> + </td></tr><tr><td> + <p>MBean corresponding to the named exchange on the given + virtualhost. Allows exchange management operations such as the + creation and removal of bindings. The supported exchange types are + exposed by the <code class="literal">exchangeTypes</code> attribute of the + virtualhost.</p> + </td></tr><tr><td rowspan="2"> + <p> + <a class="ulink" href="http://svn.apache.org/viewvc/qpid/java/trunk/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedConnection.java?view=co"; target="_top">ManagedConnection</a> + </p> + </td><td> + <p> + <code class="literal">org.apache.qpid:type=VirtualHost.Connection,VirtualHost="<em class="replaceable"><code>virtualhostname</code></em>",name="<em class="replaceable"><code>/peerid:ephemeralport</code></em>"</code> + </p> + </td></tr><tr><td> + <p>MBean representing a active AMQP connection to the named virtual + host. Name is formed from the IP and ephemeral port of the peer. + Attributes include the client version and connection level + statistics.</p> + </td></tr><tr><td rowspan="2"> + <p> + <a class="ulink" href="http://svn.apache.org/viewvc/qpid/java/trunk/management/common/src/main/java/org/apache/qpid/management/common/mbeans/UserManagement.java?view=co"; target="_top">UserManagement</a> + </p> + </td><td> + <p> + <code class="literal">org.apache.qpid:type=UserManagement,name="UserManagement-<em class="replaceable"><code>authentication + manager name</code></em>"</code> + </p> + </td></tr><tr><td> + <p>When using <a class="link" href="Java-Broker-Security.html#Java-Broker-Security-PlainPasswordFile-Provider" title="8.1.7. Plain Password File (Deprecated)">Plain + password provider</a> or <a class="link" href="Java-Broker-Security.html#Java-Broker-Security-Base64MD5PasswordFile-Provider" title="8.1.9. Base64MD5 Password File (Deprecated)">Base 64 MD5 password provider</a>, permits user operations + such creation and deletion of users. and password changes.</p> + </td></tr><tr><td rowspan="2"> + <p> + <a class="ulink" href="http://svn.apache.org/viewvc/qpid/java/trunk/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ServerInformation.java?view=co"; target="_top">ServerInformation</a> + </p> + </td><td> + <p> + <code class="literal">org.apache.qpid:type=ServerInformation,name=ServerInformation</code> + </p> + </td></tr><tr><td> + <p>Exposes broker wide statistics, product version number and JMX + management API version number.</p> + </td></tr><tr><td rowspan="2"> + <p> + <a class="ulink" href="http://svn.apache.org/viewvc/qpid/java/trunk/management/common/src/main/java/org/apache/qpid/management/common/mbeans/LoggingManagement.java?view=co"; target="_top">LoggingManagement</a> + </p> + </td><td> + <p> + <code class="literal">org.apache.qpid:type=LoggingManagement,name=LoggingManagement</code> + </p> + </td></tr><tr><td> + <p>MBean permitting basic control of first configured Broker FileLogger only. If + no FileLoggers are associated with the Broker, this Mbean will be absent. It is + recommended that new applications use the Web Management or REST API to control + logging. See <a class="xref" href="Java-Broker-Runtime.html#Java-Broker-Runtime-Logging" title="9.1. Logging">Section 9.1, “Logging”</a>.</p> + </td></tr></tbody></table></div></div><br class="table-break" /></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Management-Channel-REST-API.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Channel.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Channel-AMQP-Intrinstic.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">6.3. REST API </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 6.5. AMQP Intrinstic Management</td></tr></table></div></div> \ No newline at end of file Added: qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-QMF.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-QMF.html.in?rev=1718924&view=auto ============================================================================== --- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-QMF.html.in (added) +++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-QMF.html.in Wed Dec 9 17:41:59 2015 @@ -0,0 +1 @@ +<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-Channel.htm l">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> \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
