http://git-wip-us.apache.org/repos/asf/qpid-site/blob/89f345d6/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Example.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Example.html.in b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Example.html.in new file mode 100644 index 0000000..09c78a6 --- /dev/null +++ b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Example.html.in @@ -0,0 +1,100 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">5.7. Example of JSON 'Initial Configuration'</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Initial-Configuration-Configuration-Properties.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-Management-Channel.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-Example"></a>5.7. Example of JSON 'Initial Configuration'</h2></div></div></div><p> An example of the default 'Initial Configuration' JSON file the broker uses is + provided below:</p><div class="example"><a id="d0e1675"></a><p class="title"><strong>Example 5.1. JSON 'Initial configuration' File</strong></p><div class="example-contents"><pre class="programlisting"> +{ + "name": "${broker.name}", + "modelVersion": "7.0", + "authenticationproviders" : [ { + "name" : "passwordFile", + "type" : "PlainPasswordFile", + "path" : "${qpid.home_dir}${file.separator}etc${file.separator}passwd" + } ], + "brokerloggers" : [ { + "name" : "logfile", + "type" : "File", + "fileName" : "${qpid.work_dir}${file.separator}log${file.separator}qpid.log", + "brokerloginclusionrules" : [ { + "name" : "Root", + "type" : "NameAndLevel", + "level" : "WARN", + "loggerName" : "ROOT" + }, { + "name" : "Qpid", + "type" : "NameAndLevel", + "level" : "INFO", + "loggerName" : "org.apache.qpid.*" + }, { + "name" : "Operational", + "type" : "NameAndLevel", + "level" : "INFO", + "loggerName" : "qpid.message.*" + }, { + "name" : "Statistics", + "type" : "NameAndLevel", + "level" : "INFO", + "loggerName" : "qpid.statistics.*" + } ] + }, { + "name" : "memory", + "type" : "Memory", + "brokerloginclusionrules" : [ { + "name" : "Root", + "type" : "NameAndLevel", + "level" : "WARN", + "loggerName" : "ROOT" + }, { + "name" : "Qpid", + "type" : "NameAndLevel", + "level" : "INFO", + "loggerName" : "org.apache.qpid.*" + }, { + "name" : "Operational", + "type" : "NameAndLevel", + "level" : "INFO", + "loggerName" : "qpid.message.*" + }, { + "name" : "Statistics", + "type" : "NameAndLevel", + "level" : "INFO", + "loggerName" : "qpid.statistics.*" + } ] + } ], + "ports" : [ { + "name" : "AMQP", + "port" : "${qpid.amqp_port}", + "authenticationProvider" : "passwordFile", + "virtualhostaliases" : [ { + "name" : "nameAlias", + "type" : "nameAlias" + }, { + "name" : "defaultAlias", + "type" : "defaultAlias" + }, { + "name" : "hostnameAlias", + "type" : "hostnameAlias" + } ] + }, { + "name" : "HTTP", + "port" : "${qpid.http_port}", + "authenticationProvider" : "passwordFile", + "protocols" : [ "HTTP" ] + }], + "virtualhostnodes" : [ { + "name" : "default", + "type" : "JSON", + "defaultVirtualHostNode" : "true", + "virtualHostInitialConfiguration" : "\\${qpid.initial_config_virtualhost_config}" + } ], + "plugins" : [ { + "type" : "MANAGEMENT-HTTP", + "name" : "httpManagement" + } ] +} +</pre><p>In the configuration above the following entries are stored: </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> Authentication Provider of type + <span class="emphasis"><em>PlainPasswordFile</em></span> with name "passwordFile". + </p></li><li class="listitem"><p> Two Port entries: "AMQP", "HTTP" + </p></li><li class="listitem"><p> Virtualhost Node called default. On initial startup, it + virtualHostInitialConfiguration will cause a virtualhost to be created + with the same name. The configuration will be stored in a + <span class="emphasis"><em>JSON</em></span> configuration store, the message data will + be stored in a <span class="emphasis"><em>DERBY</em></span> message store.</p></li><li class="listitem"><p>One management plugin: "httpManagement" of type "MANAGEMENT-HTTP".</p></li><li class="listitem"><p>Broker attributes are stored as a root entry.</p></li></ul></div><p> + </p></div></div><br class="example-break" /></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-Configuration-Properties.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-Management-Channel.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">5.6. Customising Configuration using Configuration Properties </td><td align="center" width="20%"><a accesskey="h" href="Apache-Qpid-Broker-J-Book.html">Home</a></td><td align="right" valign="top" width="40%"> Chapter 6. Management Channels</td></tr></table></div></div> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/89f345d6/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Initial-Config-Location.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Initial-Config-Location.html.in b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Initial-Config-Location.html.in new file mode 100644 index 0000000..12be244 --- /dev/null +++ b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Initial-Config-Location.html.in @@ -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" style="clear: both"><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="Apache-Qpid-Broker-J-Book.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 http://git-wip-us.apache.org/repos/asf/qpid-site/blob/89f345d6/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Location.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Location.html.in b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Location.html.in new file mode 100644 index 0000000..30d57cd --- /dev/null +++ b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Location.html.in @@ -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" style="clear: both"><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.6. Customising Configuration using Configuration Properties">${qpid.work_dir}</a>/config.json as the path for its configur ation 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="Apache-Qpid-Broker-J-Book.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 http://git-wip-us.apache.org/repos/asf/qpid-site/blob/89f345d6/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Type.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Type.html.in b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Type.html.in new file mode 100644 index 0000000..d810c26 --- /dev/null +++ b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration-Type.html.in @@ -0,0 +1,18 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">5.5. Configuration Store Type</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-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.5. 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-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-Configuration-Properties.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="Apache-Qpid-Broker-J-Book.html">Home</a></td><td align="right" valign="top" width="40%"> 5.6. Customising Configuration using Configuration Properties</td></tr></table></div></div> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/89f345d6/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration.html.in b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration.html.in new file mode 100644 index 0000000..7ef32d4 --- /dev/null +++ b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Initial-Configuration.html.in @@ -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-Type.html">5.5. Configuration Store Type</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Configuration-Properties.html">5.6. Customising Configuration using Configuration Properties</a></span></dt><dt><span class="section"><a href="Java-Broker-Initial-Configuration-Example.html">5.7. 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></di v><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="Apache-Qpid-Broker-J-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 http://git-wip-us.apache.org/repos/asf/qpid-site/blob/89f345d6/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-Download.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-Download.html.in b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-Download.html.in new file mode 100644 index 0000000..ebe4e60 --- /dev/null +++ b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-Download.html.in @@ -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 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="Apache-Qpid-Broker-J-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 http://git-wip-us.apache.org/repos/asf/qpid-site/blob/89f345d6/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-InstallationUnix.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-InstallationUnix.html.in b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-InstallationUnix.html.in new file mode 100644 index 0000000..290ca88 --- /dev/null +++ b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-InstallationUnix.html.in @@ -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="F.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-7.0.6-bin.tgz package into the directory.</p><pre class="programlisting">mkdir /usr/local/qpid +cd /usr/local/qpid +tar xvzf qpid-broker-7.0.6-bin.tgz</pre><p>The extraction of the broker package will have created a directory + qpid-broker/7.0.6 within /usr/local/qpid</p><pre class="screen">ls -la qpid-broker/7.0.6/ +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 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="Apache-Qpid-Broker-J-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 http://git-wip-us.apache.org/repos/asf/qpid-site/blob/89f345d6/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-InstallationWindows.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-InstallationWindows.html.in b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-InstallationWindows.html.in new file mode 100644 index 0000000..8a2d266 --- /dev/null +++ b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-InstallationWindows.html.in @@ -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="F.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-7.0.6-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\\7.0.6 within c:\qpid</p><pre class="screen"> + Directory of c:\qpid\qpid-broker\\7.0.6 + +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 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="Apache-Qpid-Broker-J-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 http://git-wip-us.apache.org/repos/asf/qpid-site/blob/89f345d6/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-OptionalDependencies.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-OptionalDependencies.html.in b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-OptionalDependencies.html.in new file mode 100644 index 0000000..2c87060 --- /dev/null +++ b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-OptionalDependencies.html.in @@ -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 a storage option using an External Database, see + <a class="xref" href="Java-Broker-Miscellaneous-Installing-External-JDBC-Driver.html" title="F.2. Installing External JDBC Driver">Section F.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="Apache-Qpid-Broker-J-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 http://git-wip-us.apache.org/repos/asf/qpid-site/blob/89f345d6/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-Prerequistes.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-Prerequistes.html.in b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-Prerequistes.html.in new file mode 100644 index 0000000..a979070 --- /dev/null +++ b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation-Prerequistes.html.in @@ -0,0 +1,20 @@ +<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 Apache Qpid Broker-J is an 100% Java implementation and as such it can be used on any + operating system supporting Java 1.8 or higher<a class="footnote" href="#ftn.d0e97" id="d0e97"><sup class="footnote">[3]</sup></a>. This includes Linux, + Solaris, Mac OS X, and Windows 7/8/10 etc.</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="F.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 Broker installation requires approximately 20MB of free disk space.</p><p>The 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.11. Memory">Section 9.11, “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 Broker.</p></div><div class="footnotes"><br /><hr style="width:100; text-align:left;margin-left: 0" /><div class="footnote" id="ftn.d0e97"><p><a class="para" href="#d0e97"><sup class="para">[3] </sup></a>Java Cryptography Extension (JCE) + Unlimited Strength extension must be installed or enabled 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="Apache-Qpid-Broker-J-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 http://git-wip-us.apache.org/repos/asf/qpid-site/blob/89f345d6/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation.html.in b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation.html.in new file mode 100644 index 0000000..65f80eb --- /dev/null +++ b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Installation.html.in @@ -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 Apache Qpid Broker-J 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="Apache-Qpid-Broker-J-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 http://git-wip-us.apache.org/repos/asf/qpid-site/blob/89f345d6/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Introduction.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Introduction.html.in b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Introduction.html.in new file mode 100644 index 0000000..c77e201 --- /dev/null +++ b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Introduction.html.in @@ -0,0 +1,10 @@ +<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="Apache-Qpid-Broker-J-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 Apache Qpid Broker-J 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 Apache Qpid Broker-J + is actually one of two message brokers provided by the <a class="link" href="http://qpid.apache.org"; target="_top">Apache Qpid project</a>: Qpid Broker-J and the C++ + Broker.</p><p>This document relates to the Apache Qpid Broker-J. 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.8 or higher</p></li><li class="listitem" style="list-style-type: circle"><p>Messaging clients support in Java (JMS 1.1 and 2.0 compliance), C++, Python and more.</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.d0e41" id="d0e41"><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 (0-8, 0-9, 0-9-1, 0-10 and 1.0).</p></li><li class="listitem" style="list-style-type: circle"><p>Supports for AMQP over websockets.</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, OAuth2, 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>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>, and External Databases. + </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="footnote" href="#ftn.d0e77" id="d0e77"><sup class="footnote">[2]</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.d0e41"><p><a class="para" href="#d0e41"><sup class="para">[1] </sup></a>XA provided when using AMQP 0-10</p></div><div class="footnote" id="ftn.d0e77"><p><a class="para" href="#d0e77"><sup class="para">[2] </sup></a>HA currently only available with the Oracle BDB JE message store option.</p></div></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Apache-Qpid-B roker-J-Book.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%">Apache Qpid Broker-J </td><td align="center" width="20%"><a accesskey="h" href="Apache-Qpid-Broker-J-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 http://git-wip-us.apache.org/repos/asf/qpid-site/blob/89f345d6/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html.in b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html.in new file mode 100644 index 0000000..857f88b --- /dev/null +++ b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Management-Channel-AMQP-Intrinstic.html.in @@ -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-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-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-Managing-Entities.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="Apache-Qpid-Broker-J-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 http://git-wip-us.apache.org/repos/asf/qpid-site/blob/89f345d6/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Management-Channel-REST-API.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Management-Channel-REST-API.html.in b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Management-Channel-REST-API.html.in new file mode 100644 index 0000000..a6f8ef8 --- /dev/null +++ b/input/releases/qpid-broker-j-7.0.6/book/Java-Broker-Management-Channel-REST-API.html.in @@ -0,0 +1,251 @@ +<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 Apache Qpid Broker-J. The REST API is intended + for use by developers who wish to automate the management or monitoring of the 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 within the URI. The general form + of the URI is <code class="literal">/api/<version></code> where <version> is a dot separated + major and minor model version prefixed with "v", for example, "v6.1" (without the quotation marks). + 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 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="d0e2073"></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="d0e2093"></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="d0e2118"></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 an object's attributes values and statistics.</p><p>To retrieve a single object, use its full URI. For instance, to retrieve a single queue:</p><pre class="screen">GET /api/latest/queue/vhn/vh/my-queue</pre><p>To retrieve all objects beneath a parent, pass the parent's URI. For instance, to retrieve + all queues beneath the virtualhost called <code class="literal">vh</code>. A collection will be returned. + </p><pre class="screen">GET /api/latest/queue/vhn/vh</pre><p>Request parameters (with the same name as an attribute) are used to filter the returned collection. + For instance, to filter those queues of type <code class="literal">standard</code>:</p><pre class="screen">GET /api/latest/queue/vhn/vh?type=standard</pre><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">excludeInheritedContext</span></dt><dd><p>If set to "false" the inherited context is included from the object's ancestors. Default is true.</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="d0e2190"></a><p class="title"><strong>Example 6.4. Example REST call invoking the operation clear queue</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/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="d0e2200"></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="d0e2302"></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" /><p> NOTE: These curl examples utilise an unsecured HTTP transport. To use the examples it is + first necessary enable Basic authentication for HTTP within the HTTP Management Configuration + (it is off by default). For details see <a class="xref" href="Java-Broker-Management-Managing-Plugin-HTTP.html" title="7.15. HTTP Plugin">Section 7.15, “HTTP Plugin”</a> + </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-Query-API"></a>6.3.11. Query API</h3></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-REST-Query-API-Introduction"></a>6.3.11.1. Introduction</h4></div></div></div><p>The <span class="emphasis"><em>Qpid Broker-J</em></span> provides a powerful feature called + the <span class="emphasis"><em>Query API</em></span>. This allows the retrieval of the existing configured objects attributes + satisfying user-provided queries.</p><p>Developers and operators can use this feature to monitor the Broker. + For example, using <span class="emphasis"><em>Query API</em></span> one can find all queues with queue depth + exceeding some limit or existing connections made from a particular location(s).</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-REST-Query-API-Overview"></a>6.3.11.2. Query API Overview</h4></div></div></div><p> + When using the <span class="emphasis"><em>Query API</em></span> one specifies the category of the object + to query, a list of attributes to return in the result set, an optional where clause, + expressed as a predicate, that determines the filtering criteria, ordering, and + limit/offset. The features should be readily recognisable to anyone who has has familiarity + with SQL. + </p><p>Queries associate with either the <span class="emphasis"><em>broker</em></span> as a whole, or an + individual <span class="emphasis"><em>virtualhost</em></span>. Queries associated with the Broker + can query any object within the Broker. Queries associated with a virtualhost are limited + to the objects of the virtualhost itself. For instance a queue query associated + with a virtualhost queries only the queues belonging to that virtualhost. On the other + hand, a queue query associated with the Broker sees all the queues belonging on the entire + Broker. + </p><p> + </p><div class="table"><a id="d0e2349"></a><p class="title"><strong>Table 6.2. Query API URLs</strong></p><div class="table-contents"><table border="1" summary="Query API URLs"><colgroup><col /><col /></colgroup><thead><tr><th>Query API URL</th><th>Description</th></tr></thead><tbody><tr><td> + <p>/api/latest/querybroker/<configured object category name></p> + <p>/api/<version>/querybroker/<configured object category name></p> + </td><td> + <p>Query API URL fragment to query the specified object type across the entire broker</p> + </td></tr><tr><td> + <p>/api/latest/queryvhost/<virtual host node name>/<virtual host name>/<configured object category name></p> + <p>/api/<version>/queryvhost/<virtual host node name>/<virtual host name>/<configured object category name></p> + </td><td> + <p>Query API URL fragment to query the specified object type for a specific virtualhost</p> + </td></tr></tbody></table></div></div><p><br class="table-break" /> + </p><p> + The QueryAPI accepts <code class="literal">select</code>, <code class="literal">where</code>, <code class="literal">orderBy</code>, + <code class="literal">limit</code> and <code class="literal">offset</code> request parameters. + </p><div class="table"><a id="d0e2406"></a><p class="title"><strong>Table 6.3. Query API request parameters</strong></p><div class="table-contents"><table border="1" summary="Query API request parameters"><colgroup><col /><col /></colgroup><thead><tr><th>Parameter Name</th><th>Parameter Description</th></tr></thead><tbody><tr><td> + <p><code class="literal">select</code></p> + </td><td> + <p>The <code class="literal">select</code> defines the columns of the result set. It is a + comma-separated list of expressions. At its most simple, an expression can be + the name of the attribute (e.g. <code class="literal">queueDepthBytes</code>), but more complex + <a class="link" href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-Query-API-Expressions" title="Query API expressions">expressions</a> are also supported.</p> + <p>Columns within the result set are named. For expressions that are simple attribute + names, the column names will follow the attributes themselves. By default, other + expressions will have a no name.</p> + <p>Column names can be overridden with an <code class="literal">AS</code> + clause e.g. <code class="literal">now() AS currentDate</code> + </p> + </td></tr><tr><td> + <p><code class="literal">where</code></p> + </td><td> + <p>The <code class="literal">where</code> provides a boolean expression defining the result set filtering.</p> + <p>The syntax of the <a class="link" href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-Query-API-Expressions" title="Query API expressions">expression</a> + is based on a subset of the SQL92 conditional expression syntax and is similar to selector expressions in JMS e.g. + <code class="literal">queueDepthBytes > 16384 AND name like '%flow_queue'</code>. + </p> + </td></tr><tr><td> + <p><code class="literal">orderBy</code></p> + </td><td> + <p>Ordering conditions; the syntax of the + <a class="link" href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-Query-API-Expressions" title="Query API expressions"> + expression + </a> + is based on a subset of + the SQL92 ordering expression syntax. Similar to ordering expressions in SQL, + one can specify in ordering expression attributes names, sub-expressions + or indexes (starting from 1) of attributes or expressions specified in select. + </p> + </td></tr><tr><td> + <p><code class="literal">limit</code></p> + </td><td> + <p>The maximum number of results to provide starting from given offset.</p> + </td></tr><tr><td> + <p><code class="literal">offset</code></p> + </td><td> + <p>An offset in results (default is 0) to provide results from.</p> + </td></tr></tbody></table></div></div><p><br class="table-break" /> + </p><div class="example"><a id="d0e2514"></a><p class="title"><strong>Example 6.6. Example of a Query API request to retrieve queue names and depths.</strong></p><div class="example-contents"><pre class="screen">GET api/latest/querybroker/queue?select=name,queueDepthBytes,queueDepthMessages&where=queueDepthBytes>0&orderBy=1 desc,2 desc&offset=0&limit=100 HTTP/1.1</pre></div></div><br class="example-break" /></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-REST-Query-API-Results"></a>6.3.11.3. Query API Results</h4></div></div></div><p>The <span class="emphasis"><em>Query API</em></span> returns a JSON response. The response contains the following: + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">headers</code></span></dt><dd><p>ordered list of result set column names derived from the <code class="literal">select</code> + clause. Note that anonymous expressions (that is, those expressed without an + <code class="literal">AS</code>) will have empty column name.</p></dd><dt><span class="term"><code class="literal">results</code></span></dt><dd><p>two dimensional array containing the result-set</p></dd><dt><span class="term"><code class="literal">total</code></span></dt><dd><p>The <span class="emphasis"><em>total</em></span> number of results matching the where criteria.</p></dd></dl></div><p> + </p><div class="example"><a id="d0e2559"></a><p class="title"><strong>Example 6.7. Example of Query API call for queue names and depths.</strong></p><div class="example-contents"><pre class="screen">GET api/latest/querybroker/queue?select=name,queueDepthBytes,queueDepthMessages&where=queueDepthBytes>0&orderBy=1 desc,2 desc&offset=0&limit=100 HTTP/1.1</pre><pre class="programlisting"> +{ + "headers" : [ "name", "queueDepthBytes", "queueDepthMessages" ], + "results" : [ [ "foo", 312, 26], [ "bar", 300, 24 ] ], + "total" : 2 +} + </pre></div></div><br class="example-break" /><div class="section"><div class="titlepage"><div><div><h5 class="title"><a id="Java-Broker-Management-Channel-REST-Query-API-Expressions"></a>Query API expressions</h5></div></div></div><p>Expressions within the <code class="literal">select</code>, <code class="literal">where</code> and <code class="literal">orderBy</code> + clauses can be comprised in the following manner. Expressions can be nested to arbitary depth. Parentheses + allow for precedence to be explicitly denoted. + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>variable name which can be an attribute name e.g <code class="literal">queueDepthBytes</code> or + a reference to a parent attribute <code class="literal">$parent.name</code></p></li><li class="listitem"><p>literal e.g. <code class="literal">3</code> or <code class="literal">'foo'</code></p></li><li class="listitem"><p>functions - see below e.g. <code class="literal">now()</code> or <code class="literal">to_string(createdDate, '%tm/%td/%ty', 'EST')</code></p></li><li class="listitem"><p>arithmetic operations e.g. <code class="literal">3 * 4</code> or <code class="literal">to_string(now()) + name</code></p></li></ul></div><p>The following functions are supported: + </p><div class="table"><a id="d0e2615"></a><p class="title"><strong>Table 6.4. Query API functions</strong></p><div class="table-contents"><table border="1" summary="Query API functions"><colgroup><col /><col /></colgroup><thead><tr><th>Function Name</th><th>Function Description</th></tr></thead><tbody><tr><td> + <p><code class="literal">concat(obj[,obj..])</code></p> + </td><td> + <p>concatenates the given objects into a string</p> + </td></tr><tr><td> + <p><code class="literal">now()</code></p> + </td><td> + <p>returns current date and time</p> + </td></tr><tr><td> + <p><code class="literal">to_date(object)</code></p> + </td><td> + <p>converts the first parameter, which must be a string. into a date. The + string must be in ISO-8601 format e.g. <code class="literal">1970-01-01T10:00:00Z</code>.</p> + </td></tr><tr><td> + <p><code class="literal">date_add(object, duration)</code></p> + </td><td> + <p>adds the given ISO-8601 duration <code class="literal">duration</code> e.g. + <code class="literal">P1D</code> or <code class="literal">-PT10H</code> to the date provided by the + first parameter.</p> + </td></tr><tr><td> + <p><code class="literal">to_string(object[, format[, timezone]])</code></p> + </td><td> + <p>Converts given object into a string.</p> + <p>If the format argument is present, it must be a Java + <a class="link" href="http://docs.oracle.com/javase/7/docs/api/java/util/Formatter.html"; target="_top">Formatter</a> + compliant string e.g. <code class="literal">%f</code> or <code class="literal">%tY-%tm-%td</code>. + </p> + <p>The timezone argument is significant if the object is a Date. If the timezone + argument is specified it must be a valid Java timezone name. The date is converted + to the specified timezone before being formatted by the<code class="literal">format</code>. + If the timezone is omitted <code class="literal">UTC</code> is assumed. + </p> + </td></tr></tbody></table></div></div><p><br class="table-break" /> + </p></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-CORS"></a>6.3.12. Cross Origin Resource Sharing (CORS)</h3></div></div></div><p> The Broker supports Cross Origin Resource Sharing (CORS) + to allow web management consoles other than the one embedded in the + broker to use the REST API. This feature must be enabled by configuring + the CORS Allow Origins and related attributes on the + <a class="xref" href="Java-Broker-Management-Managing-Plugin-HTTP.html" title="7.15. HTTP Plugin">Section 7.15, “HTTP Plugin”</a> + </p></div></div><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="Apache-Qpid-Broker-J-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 --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
