You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by or...@apache.org on 2015/12/09 18:42:03 UTC
svn commit: r1718924 [30/39] - in /qpid/site: docs/
docs/components/java-broker/ docs/components/jms/ docs/components/qpid-jca/
docs/releases/ docs/releases/qpid-java-6.0.0/
docs/releases/qpid-java-6.0.0/java-broker/
docs/releases/qpid-java-6.0.0/java-...
Added: qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-REST-API.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-REST-API.html.in?rev=1718924&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-REST-API.html.in (added)
+++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-REST-API.html.in Wed Dec 9 17:41:59 2015
@@ -0,0 +1,139 @@
+<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">6.3. REST API</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Channel-Web-Console.html">Prev</a> </td><th align="center" width="60%">Chapter 6. Management Channels</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Channel-JMX.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Channel-REST-API"></a>6.3. REST API</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Introduction"></a>6.3.1. Introduction</h3></div></div></div><p>This section describes the REST API provided by the Java Broker. The REST API is intended
+ for use by developers who wish to automate the management or monitoring of the Qpid Broker. It
+ is also very useful for adhoc monitoring on the command line using tools such as
+ <code class="literal">curl</code>.</p><p>The REST API provides access to all of the Broker's entities using hierarchical paths
+ expressed by the URI. Responses are returned in JSON format.</p><p>The <code class="literal">GET</code> method request retrieves information about an object, the
+ <code class="literal">DELETE</code> method requests the removal of one, and the <code class="literal">PUT</code>
+ or <code class="literal">POST</code> methods perform updates or create new objects. The
+ <code class="literal">POST</code> method is also used to invoke operations.</p><p>The REST API is versioned with the version number embedded withinthe URI. The general form
+ of the URI is <code class="literal">/api/<version></code> where <version> is a major model
+ version prefixed with "v", for example, v3. For convenience the alias
+ <code class="literal">latest</code> (<code class="literal">/api/latest</code>) signifies the latest supported
+ version.</p><p>There are also some ancillary services under URI <code class="literal">/service</code> used for
+ authentication and logout.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-APIDocs"></a>6.3.2. REST API documentation</h3></div></div></div><p>REST API documentation is available on-line from any Java Broker at location
+ <code class="literal">/apidocs</code>. It is also linked from the menu of the Web Management Console.
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Authentication"></a>6.3.3. Authentication</h3></div></div></div><p>Before you can use the REST API, you must authenticate. Authentication decisions are made
+ by the <a class="link" href="Java-Broker-Concepts-Authentication-Providers.html" title="4.9. Authentication Providers">authentication
+ provider</a> associated with HTTP <a class="link" href="Java-Broker-Concepts-Ports.html" title="4.8. Ports">port</a>
+ on which you connect.</p><p>You may authenticate using <a class="ulink" href="https://www.ietf.org/rfc/rfc4422.txt" target="_top">SASL</a>
+ (<code class="literal">/service/sasl</code>) or <a class="ulink" 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="idm140683146882368"></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="idm140683146875440"></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" 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="idm140683146867408"></a><p class="title"><strong>Example 6.3. Examples of REST calls for Queue deletion</strong></p><div class="example-contents"><p>To delete Queue with name "my-queue" on a virtual host with name "vh" (contained in
+ virtual host node with name "vhn") either of the following requests can be made:</p><pre class="screen">DELETE /api/latest/queue/vhn/vh/my-queue HTTP/1.1</pre><pre class="screen">DELETE /api/latest/queue/vhn/vh?name=my-queue HTTP/1.1</pre><pre class="screen">DELETE /api/latest/queue/vhn/vh?id=real-queue-id HTTP/1.1</pre></div></div><br class="example-break" /></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Get"></a>6.3.7. Retrieving Configured Object details</h3></div></div></div><p>Method GET is used to retrieve ConfiguredObject attributes values and children
+ hierarchy.</p><p>A particular ConfiguredObject details can be retrieved using full ConfiguredObject URI
+ (the one ending with configured object name)</p><p>A collection of ConfiguredObjects can be retrieved using parent URI. Request parameters
+ (having the same name as attributes) can be used to filter the returned configured
+ objects.</p><p>The REST URI (/api/latest/>category</*) are hierarchical. It is permitted to replace
+ REST URI elements with an "asterisks" in GET requests to denote all object of a particular
+ type. Additionally, trailing object type in the URL hierarchy can be omitted. In this case GET
+ request will return all of the object underneath of the current object.</p><p>For example, for binding URL <code class="literal">http://localhost:8080/api/latest/binding/<vhost
+ node>/<vhost>/<exchange>/<queue>/<binding></code> replacing of
+ <code class="literal"><exchange></code> with "asterisks"
+ (<code class="literal">http://localhost:8080/api/<ver>/binding/<vhost
+ node>/<vhost>/*/<queue>/<binding></code>) will result in the GET
+ response containing the list of bindings for all of the exchanges in the virtualhost having
+ the given name and given queue.</p><p>If <code class="literal"><binding></code> and <code class="literal"><queue></code> are omitted in
+ binding REST URL (<code class="literal">http://localhost:8080/api/<ver>/binding/<vhost
+ node>/<vhost>/<exchangename></code>) the GET request will result in
+ returning all bindings for all queues for the given exchange in the virtual host. </p><p>Additional parameters supported in GET requests:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">depth</span></dt><dd><p>To restrict the depth of hierarchy of configured objects to return in
+ response</p></dd><dt><span class="term">actuals</span></dt><dd><p>If set to "true" attribute actual values are returned instead of effective</p></dd><dt><span class="term">includeSysContext</span></dt><dd><p>If set to "true" all system context variables are returned</p></dd><dt><span class="term">inheritedActuals</span></dt><dd><p>If set to "true" actual values for all inherited context is returned.</p></dd><dt><span class="term">oversize</span></dt><dd><p>Sets the maximum length for values of over-sized attributes to trim</p></dd><dt><span class="term">extractInitialConfig</span></dt><dd><p>If set to "true", the returned json can be used as initial configuration.</p></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Operations"></a>6.3.8. Configured Object operations</h3></div></div></div><p>Method POST is used to invoke Configured Objects operations. Some operations support
+ parameters. Pass parameters using a JSON request body containing a map with a map entry for
+ each parameter. </p><div class="example"><a id="idm140683146842656"></a><p class="title"><strong>Example 6.4. Example of REST call to invoke the Queue clear queue operation</strong></p><div class="example-contents"><p>To clear the queue with name "my-queue" on a virtual host with name "vh".</p><pre class="screen">POST api/latest/queue/default/vhn/vh/my-queue/clearQueue HTTP/1.1</pre></div></div><br class="example-break" /></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-REST-API-Status-Codes"></a>6.3.9. HTTP status codes returned by REST interfaces</h3></div></div></div><div class="table"><a id="idm140683146839472"></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>Descri
ption</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="idm140683146814896"></a><p class="title"><strong>Example 6.5. Examples of queue creation using curl (authenticating as user admin):</strong></p><div class="example-contents"><pre class="programlisting">
+#create a durable queue
+curl --user admin -X PUT -d '{"durable":true}' http://localhost:8080/api/latest/queue/<vhostnode name>/<vhostname>/<queuename>
+#create a durable priority queue
+curl --user admin -X PUT -d '{"durable":true,"type":"priority"}' http://localhost:8080/api/latest/queue/<vhostnode name>/<vhostname>/<queuename>
+ </pre></div></div><br class="example-break" /><div class="example"><a id="idm140683146813168"></a><p class="title"><strong>Example 6.6. Example of binding a queue to an exchange using curl</strong></p><div class="example-contents"><pre class="programlisting">
+curl --user admin -X PUT -d '{}' http://localhost:8080/api/latest/binding/<vhostnode name>/<vhostname>/<exchangename>/<queue-name>/<binding-name>
+ </pre></div></div><br class="example-break" /><p> NOTE: These curl examples utilise unsecure HTTP transport. To use the examples it is
+ first necessary enable Basic authentication for HTTP within the HTTP Management Configuration
+ (it is off by default). For details see <a class="xref" href="Java-Broker-Management-Managing-Plugin-HTTP.html" title="7.16. HTTP Plugin">Section 7.16, “HTTP Plugin”</a>
+ </p></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Management-Channel-Web-Console.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Channel.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Channel-JMX.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">6.2. Web Management Console </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 6.4. JMX Management</td></tr></table></div></div>
\ No newline at end of file
Added: qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-Web-Console.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-Web-Console.html.in?rev=1718924&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-Web-Console.html.in (added)
+++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel-Web-Console.html.in Wed Dec 9 17:41:59 2015
@@ -0,0 +1,48 @@
+<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">6.2. Web Management Console</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Channel.html">Prev</a> </td><th align="center" width="60%">Chapter 6. Management Channels</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Channel-REST-API.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Channel-Web-Console"></a>6.2. Web Management Console</h2></div></div></div><p> The Web Management Console provides a simple and intuitive interface for the Management
+ and Control of the Broker. From here, all aspects of the Broker can be controlled,
+ including: </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>add, remove and monitor queues</p></li><li class="listitem"><p>inspect, move, copy or delete messages</p></li><li class="listitem"><p>add, remove and monitor virtualhosts</p></li><li class="listitem"><p>configure and control high availability</p></li></ul></div><p>
+ </p><p>The remainder of the section provides an introduction to the web management console and
+ its use.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-Web-Console-Accessing"></a>6.2.1. Accessing the Console</h3></div></div></div><p>The Web Management Console is provided by the HTTP Management Plugin. Providing the
+ HTTP Management Plugin is in its default configuration, the Web Management Console can
+ be accessed by pointing a browser at the following URL:</p><p>
+ <code class="literal">http://myhost.mydomain.com:8080</code>
+ </p><p>The Console will prompt you to login using a username and password.</p><div class="figure"><a id="idm140683147578400"></a><p class="title"><strong>Figure 6.1. Web Management Console - Authentication</strong></p><div class="figure-contents"><div class="mediaobject"><table border="0" style="cellpadding: 0; cellspacing: 0;" summary="manufactured viewport for HTML img" width="900"><tr><td><img alt="Web Console Authentication" src="images/Management-Web-Auth.png" width="900" /></td></tr></table></div></div></div><br class="figure-break" /></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-Web-Console-Orientation"></a>6.2.2. Orientation</h3></div></div></div><p>After you have logged on you will see a screen similar to the following. The elements
+ of the screen are now explained.</p><div class="figure"><a id="idm140683147835408"></a><p class="title"><strong>Figure 6.2. Web Management Orientation - Console</strong></p><div class="figure-contents"><div class="mediaobject"><table border="0" style="cellpadding: 0; cellspacing: 0;" summary="manufactured viewport for HTML img" width="900"><tr><td><img alt="The Web Console" src="images/Management-Web-Console.png" width="900" /></td></tr></table></div></div></div><br class="figure-break" /><p>
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><span class="emphasis"><em>A</em></span> - Hierarchy view. Expandable/collapsible view
+ showing all entities within the Broker. Double click on an entity name to
+ cause its tab to be opened. </p></li><li class="listitem"><p><span class="emphasis"><em>B</em></span> - Tab. Shows the details of an entity including its
+ attributes and its child entities. </p></li><li class="listitem"><p><span class="emphasis"><em>C</em></span> - Occluded tab. Click tab name to bring the tab to
+ the front.</p></li><li class="listitem"><p><span class="emphasis"><em>D</em></span> - Auto restore check box. Checked tabs will be
+ automatically restored on subsequent login.</p></li><li class="listitem"><p><span class="emphasis"><em>E</em></span> - Close. Click to close the tab.</p></li><li class="listitem"><p><span class="emphasis"><em>F</em></span> - User Menu. Access to Preferences, Logout and
+ Help.</p></li></ul></div><p>
+ </p><div class="figure"><a id="Java-Broker-Management-Channel-Web-Console-Orientation-Tab"></a><p class="title"><strong>Figure 6.3. Web Management Orientation - Tab</strong></p><div class="figure-contents"><div class="mediaobject"><table border="0" style="cellpadding: 0; cellspacing: 0;" summary="manufactured viewport for HTML img" width="900"><tr><td><img alt="A tab within the Web Consle" src="images/Management-Web-Tab.png" width="900" /></td></tr></table></div></div></div><br class="figure-break" /><p>The elements of a tab are now explained: </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><span class="emphasis"><em>1</em></span> - Attribute Panel. Shows the attributes of the
+ entity. Click the panel title bar opens/closes the panel.</p></li><li class="listitem"><p><span class="emphasis"><em>2</em></span> - Child Panels. Panels containing a table listing
+ the children of the entity. Click the panel title bar opens/closes the
+ panel.</p></li><li class="listitem"><p><span class="emphasis"><em>3</em></span> - Child Row. Row summarizing a child entity. Double
+ click to open the child tab.</p></li><li class="listitem"><p><span class="emphasis"><em>4</em></span> - Child Operations. Buttons to add a new child or
+ perform operations on existing children.</p></li></ul></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Entities"></a>6.2.3. Managing Entities</h3></div></div></div><p>All the Entities of the Broker of can be managed through the Web Console.</p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Entities-Add"></a>6.2.3.1. Adding Entities</h4></div></div></div><p>To <span class="emphasis"><em>add</em></span> a new entity, click the <code class="literal">Add</code> button
+ on the Child Panel on the Parent's tab. Clicking the Add button causes an add
+ dialogue to be displayed.</p><p>Add dialogues allow you to set the attributes of the new child, and set context
+ variables. Most fields on the add dialogue have field level help that give more
+ details about the attribute and any default value (which may be expressed in terms
+ of a context variable) that will take effect if you leave the attribute unset. An
+ example add dialogue is shown in the figure that follows.</p><div class="figure"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Entities-Add-Dialogue"></a><p class="title"><strong>Figure 6.4. Web Management Orientation - Add Dialogue</strong></p><div class="figure-contents"><div class="mediaobject"><img alt="Example add dialogue showing field level help" src="images/Management-Web-Add-Dialogue.png" /></div></div></div><br class="figure-break" /></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Entities-Edit"></a>6.2.3.2. Editing Entities</h4></div></div></div><p>To <span class="emphasis"><em>edit</em></span> an existing entity, click the <code class="literal">Edit</code>
+ button on the tab corresponding to the Entity itself. Editing an entity lets you
+ change some of its attributes and modify its context variables. Most fields on the
+ edit dialogue have field level help that give more details about the attribute and
+ any default value. An example edit dialogue is shown in the figure that
+ follows.</p><div class="figure"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Entities-Edit-Dialogue"></a><p class="title"><strong>Figure 6.5. Web Management Orientation - Edit Dialogue</strong></p><div class="figure-contents"><div class="mediaobject"><img alt="Example edit dialogue" src="images/Management-Web-Edit-Dialogue.png" /></div></div></div><br class="figure-break" /></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Entities-Delete"></a>6.2.3.3. Deleting Entities</h4></div></div></div><p>To <span class="emphasis"><em>remove</em></span> an existing entity, click the
+ <code class="literal">Delete</code> button on the tab corresponding to the Entity itself.
+ For some child types, you can select many children from the parent's type and delete
+ many children at once.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Context-Variables"></a>6.2.3.4. Context Variables</h4></div></div></div><p>All Entities within the Broker have the ability to have <a class="link" href="Java-Broker-Management-Managing-Entities.html#Java-Broker-Management-Managing-Entities-General" title="7.1. General Description">context
+ variables</a> associated with them.</p><p>Most add and edit dialogues have the ability to make context variable assignments.
+ To add/change/remove a context variable, click the Context Variable panel to expand
+ it.</p><div class="figure"><a id="Java-Broker-Management-Channel-Web-Console-Managing-Entities-Context-Variables-Dialogue"></a><p class="title"><strong>Figure 6.6. Web Management Orientation - Context Variables</strong></p><div class="figure-contents"><div class="mediaobject"><img alt="Editting Context Variables" src="images/Management-Web-ContextVar.png" /></div></div></div><br class="figure-break" /><p>You will see any context variables already associated with the object, called
+ local context variables in bold, and any inherited from above in normal face.</p><p>Since context variables can be defined in terms of other context variables, the
+ display has two value columns: actual and effective. Actual shows the value truely
+ associated with the variable, where as effective shows the resulting value, after
+ variable expansion has taken place.</p><p>The <code class="literal">+</code> button allows new variables to be added. The
+ <code class="literal">-</code> button removes existing ones.</p><p>You change an existing local variables defintion by clicking on the actual value.
+ You can also <span class="emphasis"><em>provide a local definition</em></span> for an inherited value
+ by clicking on the actual value and typing its new value.</p></div></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Management-Channel.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Channel.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Channel-REST-API.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">Chapter 6. Management Channels </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 6.3. REST API</td></tr></table></div></div>
\ No newline at end of file
Added: qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel.html.in?rev=1718924&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel.html.in (added)
+++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Channel.html.in Wed Dec 9 17:41:59 2015
@@ -0,0 +1,15 @@
+<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 6. Management Channels</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Initial-Configuration-Example.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Channel-Web-Console.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="Java-Broker-Management-Channel"></a>Chapter 6. Management Channels</h1></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="section"><a href="Java-Broker-Management-Channel.html#Java-Broker-Management-Channel-HTTP">6.1. HTTP Management</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Channel.html#Java-Broker-Management-Channel-HTT
P-Introduction">6.1.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel.html#Java-Broker-Management-Channel-HTTP-DefaultConfiguration">6.1.2. Default Configuration</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Channel-Web-Console.html">6.2. Web Management Console</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Channel-Web-Console.html#Java-Broker-Management-Channel-Web-Console-Accessing">6.2.1. Accessing the Console</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-Web-Console.html#Java-Broker-Management-Channel-Web-Console-Orientation">6.2.2. Orientation</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-Web-Console.html#Java-Broker-Management-Channel-Web-Console-Managing-Entities">6.2.3. Managing Entities</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html
">6.3. REST API</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Introduction">6.3.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-APIDocs">6.3.2. REST API documentation</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Authentication">6.3.3. Authentication</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Create">6.3.4. Configured Object creation</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Update">6.3.5. Configured Object update</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broke
r-Management-Channel-REST-API-Delete">6.3.6. Configured Object deletion</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Get">6.3.7. Retrieving Configured Object details</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Operations">6.3.8. Configured Object operations</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Status-Codes">6.3.9. HTTP status codes returned by REST interfaces</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-REST-API.html#Java-Broker-Management-Channel-REST-API-Examples">6.3.10. Examples of REST requests with curl</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Channel-JMX.html">6.4. JMX Management</a></span></dt><dd><dl><dt><span class="sectio
n"><a href="Java-Broker-Management-Channel-JMX.html#Java-Broker-Management-Channel-JMX-Introduction">6.4.1. Introduction</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-JMX.html#Java-Broker-Management-Channel-JMX-Plugin-DefaultConfiguration">6.4.2. Default Configuration</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-JMX.html#Java-Broker-Management-Channel-JMX-Plugin-ConnectingToJMX">6.4.3. Connecting to JMX</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-JMX.html#Java-Broker-Management-JMX-Example-Client">6.4.4. Example JMX Client</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Channel-JMX.html#Java-Broker-Management-Channel-JMX-MBeans">6.4.5. The MBeans</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Channel-AMQP-Intrinstic.html">6.5. AMQP Intrinstic Management</a></span></dt><dt><span class="section"><a href="Java-Broker-Ma
nagement-Channel-QMF.html">6.6. QMF</a></span></dt></dl></div><p>The Broker can be managed over a number of different channels.</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>HTTP - The primary channel for management. The HTTP interface comprises a Web
+ Console and a REST API.</p></li><li class="listitem"><p>JMX - The Broker provides a JMX compliant management interface. This is not currently
+ undergoing further development and is retained largely for backward compatibility. It is
+ suggested the new users favour the Web Console/REST API.</p></li><li class="listitem"><p>AMQP - The AMQP protocols 0-8..0-10 allow for some management of Exchanges, Queue and
+ Bindings. This will be superseded by AMQP 1.0 Management. It is suggested that new users
+ favour the Management facilities provided by the Web Console/REST API.</p></li></ul></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Channel-HTTP"></a>6.1. HTTP Management</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-HTTP-Introduction"></a>6.1.1. Introduction</h3></div></div></div><p>The HTTP Management plugin provides a HTTP based API for monitoring and control of the
+ Broker. The plugin actually provides two interfaces:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><a class="link" href="Java-Broker-Management-Channel-Web-Console.html" title="6.2. Web Management Console">Web Management
+ Console</a> - rich web based interface for the management of the
+ Broker.</p></li><li class="listitem"><p><a class="link" href="Java-Broker-Management-Channel-REST-API.html" title="6.3. REST API">REST API</a> -
+ REST API providing complete programmatic management of the Broker.</p></li></ul></div><p>The Web Management Console itself uses the REST API, so every function you can perform
+ through the Web Management Console can be also be scripted and integrated into other
+ systems. This provides a simple integration point allowing the Broker to monitored and
+ controlled from systems such as Naoios or BMC Control-M.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Channel-HTTP-DefaultConfiguration"></a>6.1.2. Default Configuration</h3></div></div></div><p>By default, the Broker is shipped with HTTP enabled running port 8080. The HTTP plugin
+ is configured to require SASL authentication. The port is not SSL protected.</p><p>The settings can be changed by configuring the HTTP plugin and/or the port configured
+ to serve HTTP.</p></div></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Initial-Configuration-Example.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Channel-Web-Console.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">5.8. Example of JSON 'Initial Configuration' </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 6.2. Web Management Console</td></tr></table></div></div>
\ No newline at end of file
Added: qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Access-Control-Providers.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Access-Control-Providers.html.in?rev=1718924&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Access-Control-Providers.html.in (added)
+++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Access-Control-Providers.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">7.15. Access Control Providers</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Managing-Group-Providers.html">Prev</a> </td><th align="center" width="60%">Chapter 7. Managing Entities</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Managing-Plugin-HTTP.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Managing-Access-Control-Providers"></a>7.15. Access Control Providers</h2></div></div></div><p>An <a class="link" href="Java-Broker-Concepts-Other-Services.html#Java-Broker-Concepts-Access-Control-Providers" title="4.10.1. Access Control Providers">Access Control
+ Provider</a> governs who may do what within the Broker. It governs both messaging and
+ management.</p><p>See <a class="xref" href="Java-Broker-Security-ACLs.html" title="8.3. Access Control Lists">Section 8.3, “Access Control Lists”</a></p></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Management-Managing-Group-Providers.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Managing-Entities.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Managing-Plugin-HTTP.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">7.14. Group Providers </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 7.16. HTTP Plugin</td></tr></table></div></div>
\ No newline at end of file
Added: qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Authentication-Providers.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Authentication-Providers.html.in?rev=1718924&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Authentication-Providers.html.in (added)
+++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Authentication-Providers.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">7.11. Authentication Providers</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Managing-Ports.html">Prev</a> </td><th align="center" width="60%">Chapter 7. Managing Entities</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Managing-Keystores.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Managing-Authentication-Providers"></a>7.11. Authentication Providers</h2></div></div></div><p>
+ <a class="link" href="Java-Broker-Concepts-Authentication-Providers.html" title="4.9. Authentication Providers">Authentication
+ Providers</a> are used by <a class="link" href="Java-Broker-Concepts-Ports.html" title="4.8. Ports">Ports</a> to
+ authenticate connections.</p><p>See <a class="xref" href="Java-Broker-Security.html#Java-Broker-Security-Authentication-Providers" title="8.1. Authentication Providers">Section 8.1, “Authentication Providers”</a></p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Authentication-Providers-Types"></a>7.11.1. Types</h3></div></div></div><p> The following authentication providers are supported: </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><a class="link" href="Java-Broker-Security.html#Java-Broker-Security-Anonymous-Provider" title="8.1.4. Anonymous">Anonymous</a>: allows anonymous connections to the
+ Broker</p></li><li class="listitem"><p><a class="link" href="Java-Broker-Security.html#Java-Broker-Security-External-Provider" title="8.1.3. External (SSL Client Certificates)">External</a>: delegates to external mechanisms such as SSL Client
+ Certificate Authentication</p></li><li class="listitem"><p><a class="link" href="Java-Broker-Security.html#Java-Broker-Security-Kerberos-Provider" title="8.1.2. Kerberos">Kerberos</a>: uses Kerberos to authenticate connections via
+ GSS-API.</p></li><li class="listitem"><p><a class="link" href="Java-Broker-Security.html#Java-Broker-Security-LDAP-Provider" title="8.1.1. Simple LDAP">SimpleLDAP</a>: authenticate users against an LDAP
+ server.</p></li><li class="listitem"><p><a class="link" href="Java-Broker-Security.html#Java-Broker-Security-ScramSha-Providers" title="8.1.5. SCRAM SHA">ScramSha</a>: authenticate users against credentials stored in a
+ local database</p></li><li class="listitem"><p><a class="link" href="Java-Broker-Security.html#Java-Broker-Security-Plain-Provider" title="8.1.6. Plain">Plain</a>: authenticate users against credentials stored in a local
+ database.</p></li><li class="listitem"><p><a class="link" href="Java-Broker-Security.html#Java-Broker-Security-PlainPasswordFile-Provider" title="8.1.7. Plain Password File (Deprecated)">PlainPasswordFile</a>: authenticate users against credentials stored
+ in plain text in a local file.</p></li><li class="listitem"><p><a class="link" href="Java-Broker-Security.html#Java-Broker-Security-MD5-Provider" title="8.1.8. MD5 Provider">MD5</a>: authenticate users against credentials
+ stored in a local database.</p></li><li class="listitem"><p><a class="link" href="Java-Broker-Security.html#Java-Broker-Security-Base64MD5PasswordFile-Provider" title="8.1.9. Base64MD5 Password File (Deprecated)">Base64MD5PasswordFile</a>: authenticate users against credentials
+ stored encoded in a local file.</p></li></ul></div><p>
+ </p><p>The last five providers offer user management facilities too, that is, users can
+ be created, deleted and passwords reset.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Authentication-Providers-Attributes"></a>7.11.2. Attributes</h3></div></div></div><p>
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><span class="emphasis"><em>Name the authentication provider</em></span>.</p></li></ul></div><p>
+ </p><p>Other attributes are provider specific.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Authentication-Providers-Children"></a>7.11.3. Children</h3></div></div></div><p>None</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Authentication-Providers-Lifecycle"></a>7.11.4. Lifecycle</h3></div></div></div><p>Not supported</p><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Important</h3><p>When updating an existing authentication provider, changes become effective until
+ the Broker is restarted.</p></div></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Management-Managing-Ports.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Managing-Entities.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Managing-Keystores.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">7.10. Ports </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 7.12. Keystores</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-Managing-Broker.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Broker.html.in?rev=1718924&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Broker.html.in (added)
+++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Broker.html.in Wed Dec 9 17:41:59 2015
@@ -0,0 +1,27 @@
+<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">7.3. Broker</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Managing-Entities-Matrix.html">Prev</a> </td><th align="center" width="60%">Chapter 7. Managing Entities</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Managing-Virtualhost-Nodes.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Managing-Broker"></a>7.3. Broker</h2></div></div></div><p>The <a class="link" href="Java-Broker-Concepts-Broker.html" title="4.2. Broker">Broker</a> is the principal entity. It is
+ composed of a number of other entities that collaborate to provide message broker
+ facilities.</p><p>The Broker can only be managed via the HTTP management channel.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Broker-Attributes"></a>7.3.1. Attributes</h3></div></div></div><p>
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><span class="emphasis"><em>Name the Broker</em></span>. This helps distinguish between Brokers in
+ environments that have many.</p></li><li class="listitem"><p><span class="emphasis"><em>Heartbeating</em></span>. Enables heartbeats between Broker and Clients.
+ Heartbeats help discover severed TCP/IP connections in a timely manner.</p></li><li class="listitem"><p><span class="emphasis"><em>Confidential configuration encryption provider</em></span>. The name of the
+ provider used to encrypt passwords and other secrets within the configuration. See <a class="xref" href="Java-Broker-Security-Configuration-Encryption.html" title="8.4. Configuration Encryption">Section 8.4, “Configuration Encryption”</a>.</p></li></ul></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Broker-Context"></a>7.3.2. Context</h3></div></div></div><p>
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><span class="emphasis"><em>broker.flowToDiskThreshold</em></span> Controls the <a class="link" href="Java-Broker-Runtime-Flow-To-Disk.html" title="9.6. Flow to Disk">flow to disk</a> feature.</p></li><li class="listitem"><p><span class="emphasis"><em>broker.messageCompressionEnabled</em></span> Controls the <a class="link" href="Java-Broker-Runtime-Message-Compression.html" title="9.8. Message Compression">message compression</a> .</p></li><li class="listitem"><p><a id="Java-Broker-Management-Managing-Broker-Context-StoreFilesystemMaxUsagePercent"></a><span class="emphasis"><em>store.filesystem.maxUsagePercent</em></span> Maximum percentage of space
+ that may be utilised on a filesystem hosting a virtualhost's message store before
+ producer flow control is automatically imposed.</p><p>This defaults to 90%.</p></li><li class="listitem"><p><a id="Java-Broker-Management-Managing-Broker-Context-BrokerDefaultSupportedProtocolVersionReply"></a><span class="emphasis"><em>qpid.broker_default_supported_protocol_version_reply</em></span> Used
+ during protocol negotiation. If set, the Broker will offer this AMQP version to a client
+ requesting an AMQP protocol that is not supported by the Broker. If not set, the Broker
+ offers the highest protocol version it supports. </p></li><li class="listitem"><p>
+ <span class="emphasis"><em>qpid.broker_msg_auth</em></span> If set true, the Broker ensures that the user
+ id of each received message matches the user id of the producing connection. If this
+ check fails, the message is returned to the producer's connection with a 403 (Access
+ Refused) error code.</p><p>This is check is currently not enforced when using AMQP 0-10 and 1-0
+ protocols.</p><p>Defaults to false.</p></li></ul></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Broker-Children"></a>7.3.3. Children</h3></div></div></div><p>
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
+ <a class="link" href="Java-Broker-Management-Managing-Virtualhost-Nodes.html" title="7.4. Virtualhost Nodes">Virtualhost
+ nodes</a>
+ </p></li><li class="listitem"><p>
+ <a class="link" href="Java-Broker-Management-Managing-Ports.html" title="7.10. Ports">Ports</a>
+ </p></li><li class="listitem"><p>Authentication Providers</p></li><li class="listitem"><p>Key Stores / Trust Stores</p></li><li class="listitem"><p>Group Providers</p></li><li class="listitem"><p>Access Control Providers</p></li></ul></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Broker-Lifecycle"></a>7.3.4. Lifecycle</h3></div></div></div><p>Not supported</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-Managing-Entities-Matrix.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Managing-Entities.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Managing-Virtualhost-Nodes.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">7.2. Entity/Management Channel Support Matrix </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 7.4. Virtualhost Nodes</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-Managing-Consumers.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Consumers.html.in?rev=1718924&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Consumers.html.in (added)
+++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Consumers.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">7.9. Consumers</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Managing-Queues.html">Prev</a> </td><th align="center" width="60%">Chapter 7. Managing Entities</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Managing-Ports.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Managing-Consumers"></a>7.9. Consumers</h2></div></div></div><p>A Consumer represents an application's live <span class="emphasis"><em>subcription</em></span> to a queue. Its presence
+ in the model indicates that an application is currently connected to the queue <span class="emphasis"><em>at this moment</em></span>.
+ </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Consumers-Context"></a>7.9.1. Context</h3></div></div></div><p>
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><span class="emphasis"><em>consumer.suspendNotificationPeriod</em></span> Governs the length of
+ time that a consumer may remain suspended before the the Broker begins to
+ produce <a class="link" href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-SUB-1003">SUB-1003</a>
+ operational log messages.</p></li></ul></div><p>
+ </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-Managing-Queues.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Managing-Entities.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Managing-Ports.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">7.8. Queues </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 7.10. Ports</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-Managing-Entities-Matrix.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Entities-Matrix.html.in?rev=1718924&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Entities-Matrix.html.in (added)
+++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Entities-Matrix.html.in Wed Dec 9 17:41:59 2015
@@ -0,0 +1,4 @@
+<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">7.2. Entity/Management Channel Support Matrix</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Managing-Entities.html">Prev</a> </td><th align="center" width="60%">Chapter 7. Managing Entities</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Managing-Broker.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Managing-Entities-Matrix"></a>7.2. Entity/Management Channel Support Matrix</h2></div></div></div><p>This tables indicates which management channels support the creation (C), update (U), or
+ deletion (D) of different entities within the Broker.</p><div class="table"><a id="idm140683139810976"></a><p class="title"><strong>Table 7.1. Entity/Management Matrix</strong></p><div class="table-contents"><table border="1" summary="Entity/Management Matrix"><colgroup><col align="left" class="entity" /><col align="left" class="http" /><col align="left" class="jmx" /><col align="left" class="amqp" /></colgroup><thead><tr><th align="left">Entity</th><th align="left">HTTP</th><th align="left">JMX</th><th align="left">AMQP</th></tr></thead><tbody><tr><td align="left">Broker</td><td align="left">U</td><td align="left">No</td><td align="left">No</td></tr><tr><td align="left">Virtualhost Node</td><td align="left">C/U/D</td><td align="left">No</td><td align="left">No</td></tr><tr><td align="left">Virtualhost</td><td align="left">C/U/D</td><td align="left">No</td><td align="left">No</td></tr><tr><td align="left">Remote Replication Node</td><td align="left">U/D</td><td align="
left">No</td><td align="left">No</td></tr><tr><td align="left">Exchange</td><td align="left">C/D</td><td align="left">C/D</td><td align="left">C/D</td></tr><tr><td align="left">Queue</td><td align="left">C/D</td><td align="left">C/U/D</td><td align="left">C/D</td></tr><tr><td align="left">Binding</td><td align="left">C/D</td><td align="left">C/D</td><td align="left">C/D</td></tr><tr><td align="left">Port</td><td align="left">C/U/D</td><td align="left">No</td><td align="left">No</td></tr><tr><td align="left">Authentication Providers</td><td align="left">C/U/D</td><td align="left">No</td><td align="left">No</td></tr><tr><td align="left">Group Providers</td><td align="left">C//D</td><td align="left">No</td><td align="left">No</td></tr><tr><td align="left">Access Control Provider</td><td align="left">C//D</td><td align="left">No</td><td align="left">No</td></tr><tr><td align="left">Keystores</td><td align="left">C//D</td><td align="left">No</td><td align="left">No</td></tr><tr><td align
="left">Truststores</td><td align="left">C//D</td><td align="left">No</td><td align="left">No</td></tr><tr><td align="left">Users</td><td align="left">C//D</td><td align="left">C/D</td><td align="left">No</td></tr><tr><td align="left">Groups</td><td align="left">C//D</td><td align="left">No</td><td align="left">No</td></tr><tr><td align="left">Loggers</td><td align="left">C/U/D</td><td align="left">Limited</td><td align="left">No</td></tr></tbody></table></div></div><br class="table-break" /><div class="important" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>It is currently only possible to modify a entity's context using the HTTP channel.
+ Furthermore, when using the JMX channel, it is not possible to assign non-String type
+ attributes in terms of context variables.</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-Managing-Entities.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Managing-Entities.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Managing-Broker.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">Chapter 7. Managing Entities </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 7.3. Broker</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-Managing-Entities.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Entities.html.in?rev=1718924&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Entities.html.in (added)
+++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Entities.html.in Wed Dec 9 17:41:59 2015
@@ -0,0 +1,22 @@
+<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Chapter 7. Managing Entities</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Channel-QMF.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Managing-Entities-Matrix.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="Java-Broker-Management-Managing-Entities"></a>Chapter 7. Managing Entities</h1></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="section"><a href="Java-Broker-Management-Managing-Entities.html#Java-Broker-Management-Managing-Entities-General">7.1. General Description</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Entities-Matrix
.html">7.2. Entity/Management Channel Support Matrix</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Broker.html">7.3. Broker</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Broker.html#Java-Broker-Management-Managing-Broker-Attributes">7.3.1. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Broker.html#Java-Broker-Management-Managing-Broker-Context">7.3.2. Context</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Broker.html#Java-Broker-Management-Managing-Broker-Children">7.3.3. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Broker.html#Java-Broker-Management-Managing-Broker-Lifecycle">7.3.4. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhost-Nodes.html">7.4. Virtualhost Nodes</a></span></dt><dd><dl><dt><span class="section"><
a href="Java-Broker-Management-Managing-Virtualhost-Nodes.html#Java-Broker-Management-Managing-Virtualhost-Nodes-Types">7.4.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhost-Nodes.html#Java-Broker-Management-Managing-Virtualhost-Nodes-Attributes">7.4.2. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhost-Nodes.html#Java-Broker-Management-Managing-Virtualhost-Node-Children">7.4.3. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhost-Nodes.html#Java-Broker-Management-Managing-Virtualhost-Node-Lifecycle">7.4.4. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhosts.html">7.5. VirtualHosts</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhosts.html#Java-Broker-Management-Managing-Virtualhosts-Types">7.5.1. Types</a></span></dt>
<dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhosts.html#Java-Broker-Management-Managing-Virtualhost-Context">7.5.2. Context</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhosts.html#Java-Broker-Management-Managing-Virtualhost-Attributes">7.5.3. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhosts.html#Java-Broker-Management-Managing-Virtualhost-Children">7.5.4. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Virtualhosts.html#Java-Broker-Management-Managing-Virtualhost-Lifecycle">7.5.5. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-RemoteReplicationNodes.html">7.6. Remote Replication Nodes</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-RemoteReplicationNodes.html#Java-Broker-Management-Managing-RemoteReplicationNodes-Attr
ibutes">7.6.1. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-RemoteReplicationNodes.html#Java-Broker-Management-Managing-RemoteReplicationNodes-Children">7.6.2. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-RemoteReplicationNodes.html#Java-Broker-Management-Managing-RemoteReplicationNodes-Lifecycle">7.6.3. Lifecycle</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-RemoteReplicationNodes.html#Java-Broker-Management-Managing-RemoteReplication-Nodes-Operations">7.6.4. Operations</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Exchanges.html">7.7. Exchanges</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Exchanges.html#Java-Broker-Management-Managing-Exchanges-Types">7.7.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Exchanges.html#Java
-Broker-Management-Managing-Exchanges-Attributes">7.7.2. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Exchanges.html#Java-Broker-Management-Managing-Exchanges-Children">7.7.3. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Exchanges.html#Java-Broker-Management-Managing-Exchanges-Lifecycle">7.7.4. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Queues.html">7.8. Queues</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Queues.html#Java-Broker-Management-Managing-Queues-Types">7.8.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Queues.html#Java-Broker-Management-Managing-Queues-Attributes">7.8.2. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Queues.html#Java-Broker-Management-Managing-Queue-Children">7.8.3. Childre
n</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Queues.html#Java-Broker-Management-Managing-Queue-Lifecycle">7.8.4. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Consumers.html">7.9. Consumers</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Consumers.html#Java-Broker-Management-Managing-Consumers-Context">7.9.1. Context</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Ports.html">7.10. Ports</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Ports.html#Java-Broker-Management-Managing-Ports-Context">7.10.1. Context</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Ports.html#Java-Broker-Management-Managing-Ports-Attributes">7.10.2. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Ports.html#Java-B
roker-Management-Managing-Ports-Children">7.10.3. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Ports.html#Java-Broker-Management-Managing-Ports-Lifecycle">7.10.4. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Authentication-Providers.html">7.11. Authentication Providers</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Authentication-Providers.html#Java-Broker-Management-Managing-Authentication-Providers-Types">7.11.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Authentication-Providers.html#Java-Broker-Management-Managing-Authentication-Providers-Attributes">7.11.2. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Authentication-Providers.html#Java-Broker-Management-Managing-Authentication-Providers-Children">7.11.3. Children</a></span></dt><dt><span class
="section"><a href="Java-Broker-Management-Managing-Authentication-Providers.html#Java-Broker-Management-Managing-Authentication-Providers-Lifecycle">7.11.4. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Keystores.html">7.12. Keystores</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Keystores.html#Java-Broker-Management-Managing-Keystores-Types">7.12.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Keystores.html#Java-Broker-Management-Managing-Keystores-Attributes">7.12.2. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Keystores.html#Java-Broker-Management-Managing-Keystores-Children">7.12.3. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Keystores.html#Java-Broker-Management-Managing-Keystores-Lifecycle">7.12.4. Lifecycle</a></span></dt></dl></dd><dt><spa
n class="section"><a href="Java-Broker-Management-Managing-Truststores.html">7.13. Truststores</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Truststores.html#Java-Broker-Management-Managing-Truststores-Types">7.13.1. Types</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Truststores.html#Java-Broker-Management-Managing-Truststores-Attributes">7.13.2. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Truststores.html#Java-Broker-Management-Managing-Truststores-Children">7.13.3. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Truststores.html#Java-Broker-Management-Managing-Truststores-Lifecycle">7.13.4. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Group-Providers.html">7.14. Group Providers</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Manag
ing-Access-Control-Providers.html">7.15. Access Control Providers</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Plugin-HTTP.html">7.16. HTTP Plugin</a></span></dt><dd><dl><dt><span class="section"><a href="Java-Broker-Management-Managing-Plugin-HTTP.html#Java-Broker-Management-Managing-Plugin-HTTP-Attributes">7.16.1. Attributes</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Plugin-HTTP.html#Java-Broker-Management-Managing-Plugin-HTTP-Children">7.16.2. Children</a></span></dt><dt><span class="section"><a href="Java-Broker-Management-Managing-Plugin-HTTP.html#Java-Broker-Management-Managing-Plugin-HTTP-Lifecycle">7.16.3. Lifecycle</a></span></dt></dl></dd><dt><span class="section"><a href="Java-Broker-Management-Managing-Plugins-JMX.html">7.17. JMX Plugin</a></span></dt></dl></div><p>This section describes how to manage entities within the Broker. The principles underlying
+ entity management are the same regardless of entity type. For this reason, this section begins
+ with a general description that applies to all.</p><p>Since not all channels support the management of all entity type, this section commences
+ with a table showing which entity type is supported by each channel.</p><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Managing-Entities-General"></a>7.1. General Description</h2></div></div></div><p>The following description applies to all entities within the Broker regardless of their
+ type.</p><p>
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>All entities have a parent, and may have children. The parent of the Broker is
+ called the System Context. It has no parent.</p></li><li class="listitem"><p>Entities have one or more attributes. For example a <code class="literal">name</code>, an
+ <code class="literal">id</code> or a <code class="literal">maximumQueueDepth</code></p></li><li class="listitem"><p>Entities can be durable or non-durable. Durable entities survive a restart.
+ Non-durable entities will not.</p></li><li class="listitem"><p>Attributes may have a default value. If an attribute value is not specified the
+ default value is used.</p></li><li class="listitem"><p>Attributes values can be expressed as a simple value (e.g. <code class="literal">myName</code>
+ or <code class="literal">1234</code>), in terms of context variables
+ (e.g.<code class="literal">${foo}</code> or <code class="literal">/data/${foo}/</code>).</p></li><li class="listitem"><p>Each entity has zero or more context variables.</p></li><li class="listitem"><p>The System Context entity (the ultimate ancestor of all object) has a context too.
+ It is read only and is populated with all Java System Properties. Thus it can be
+ influenced from the Broker's external environment. See <a class="link" href="Java-Broker-Appendix-Environment-Variables.html#Java-Broker-Appendix-Environment-Variables-Qpid-Opts">QPID_OPTS </a>
+ environment variable.</p></li><li class="listitem"><p>When resolving an attribute's value, if the value contains a variable
+ (e.g.<code class="literal">${foo}</code>), the variable is first resolved using the entity's own
+ context variables. If the entity has no definition for the context variable, the
+ entity's parent is tried, then its grandparent and so forth, all the way until the
+ SystemContext is reached.</p></li><li class="listitem"><p>Some entities support state and have a lifecycle.</p></li></ul></div><p>
+ </p><p>What follows now is a section dedicated to each entity type. For each entity type key
+ features are described along with the entities key attributes, key context variables, details
+ of the entities lifecycle and any other operations.</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-QMF.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Managing-Entities-Matrix.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">6.6. QMF </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 7.2. Entity/Management Channel Support Matrix</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-Managing-Exchanges.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Exchanges.html.in?rev=1718924&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Exchanges.html.in (added)
+++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Exchanges.html.in Wed Dec 9 17:41:59 2015
@@ -0,0 +1,6 @@
+<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">7.7. Exchanges</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Managing-RemoteReplicationNodes.html">Prev</a> </td><th align="center" width="60%">Chapter 7. Managing Entities</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Managing-Queues.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Managing-Exchanges"></a>7.7. Exchanges</h2></div></div></div><p><a class="link" href="Java-Broker-Concepts-Exchanges.html" title="4.6. Exchanges">Exchanges</a> can be managed using the
+ HTTP, JMX or AMQP channels.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Exchanges-Types"></a>7.7.1. Types</h3></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Direct</p></li><li class="listitem"><p>Topic</p></li><li class="listitem"><p>Fanout</p></li><li class="listitem"><p>Headers</p></li></ul></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Exchanges-Attributes"></a>7.7.2. Attributes</h3></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><span class="emphasis"><em>Name of the exchange</em></span>. Message producers refer to this name when
+ producing messages.</p></li><li class="listitem"><p><span class="emphasis"><em>Type of the exchange</em></span>. Can be either <a class="link" href="Java-Broker-Concepts-Exchanges.html#Java-Broker-Concepts-Exchanges-Types-Direct" title="4.6.2.1. Direct">direct</a>, <a class="link" href="Java-Broker-Concepts-Exchanges.html#Java-Broker-Concepts-Exchanges-Types-Topic" title="4.6.2.2. Topic">topic</a>, <a class="link" href="Java-Broker-Concepts-Exchanges.html#Java-Broker-Concepts-Exchanges-Types-Fanout" title="4.6.2.3. Fanout">fanout</a>, or <a class="link" href="Java-Broker-Concepts-Exchanges.html#Java-Broker-Concepts-Exchanges-Types-Headers" title="4.6.2.4. Headers">headers</a>.</p></li><li class="listitem"><p><span class="emphasis"><em>Durable</em></span>. Whether the exchange survives a restart.</p></li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Exchanges-Children"></
a>7.7.3. Children</h3></div></div></div><p>
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Binding</p></li></ul></div><p>
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Management-Managing-Exchanges-Lifecycle"></a>7.7.4. Lifecycle</h3></div></div></div><p>Not supported</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-Managing-RemoteReplicationNodes.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Managing-Entities.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Managing-Queues.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">7.6. Remote Replication Nodes </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 7.8. Queues</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-Managing-Group-Providers.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Group-Providers.html.in?rev=1718924&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Group-Providers.html.in (added)
+++ qpid/site/input/releases/qpid-java-6.0.0/java-broker/book/Java-Broker-Management-Managing-Group-Providers.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">7.14. Group Providers</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Management-Managing-Truststores.html">Prev</a> </td><th align="center" width="60%">Chapter 7. Managing Entities</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Management-Managing-Access-Control-Providers.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="Java-Broker-Management-Managing-Group-Providers"></a>7.14. Group Providers</h2></div></div></div><p>See <a class="xref" href="Java-Broker-Security-Group-Providers.html" title="8.2. Group Providers">Section 8.2, “Group Providers”</a></p></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p"
href="Java-Broker-Management-Managing-Truststores.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Management-Managing-Entities.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Management-Managing-Access-Control-Providers.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">7.13. Truststores </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td align="right" valign="top" width="40%"> 7.15. Access Control Providers</td></tr></table></div></div>
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org