diff options
| author | Robert Gemmell <robbie@apache.org> | 2013-05-20 00:57:24 +0000 |
|---|---|---|
| committer | Robert Gemmell <robbie@apache.org> | 2013-05-20 00:57:24 +0000 |
| commit | 3dfe835be7ad47747ebc2154b882fc2a0d7b0c9e (patch) | |
| tree | 5f12f5ca49277a9f7163818819499ea915e60b59 /qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Web-Management.xml | |
| parent | aa0f5623dce650a8e34b73caa129f47b42f76645 (diff) | |
| download | qpid-python-3dfe835be7ad47747ebc2154b882fc2a0d7b0c9e.tar.gz | |
QPID-4685: additional documentation updates following broker configuration model changes
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1484370 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Web-Management.xml')
| -rw-r--r-- | qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Web-Management.xml | 63 |
1 files changed, 37 insertions, 26 deletions
diff --git a/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Web-Management.xml b/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Web-Management.xml index 1c6a7c4d20..76d29093ad 100644 --- a/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Web-Management.xml +++ b/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Web-Management.xml @@ -20,34 +20,45 @@ --> -<section id="Java-Broker-Configuring-And-Managing-Web-Management"> - <title>Web Management</title> - - <para>Web Management Plugin exposes REST management interfaces and provides the Web Management Console to configure the Broker. - It is included into initial configuration by default and starts the servlet container on pre-configured HTTP ports. - If no HTTP Port is configured but Web Management Plugin entry is present in the Broker configuration the Broker fails to start. - Only one Web Management Plugin can be configured on the Broker. - </para> - - <para>Web Management itself can be configured through REST management interfaces and Web Management Console. - The following attributes can be set on Web Management Plugin: - <itemizedlist> - <listitem><para><emphasis>Basic Authentication for HTTP</emphasis> is flag to enable/disable - Basic Authentication on HTTP ports. It is set to false by default.</para></listitem> - <listitem><para><emphasis>Basic Authentication for HTTPS</emphasis> is flag to enable/disable - Basic Authentication on HTTPS ports. It is set to true by default.</para></listitem> - <listitem><para><emphasis>SASL Authentication for HTTP</emphasis> is flag to enable/disable - SASL Authentication on HTTP ports. It is set to true by default.</para></listitem> - <listitem><para><emphasis>SASL Authentication for HTTPS</emphasis> is flag to enable/disable - SASL Authentication on HTTPS ports. It is set to true by default.</para></listitem> - <listitem><para><emphasis>Session timeout</emphasis> is the timeout in seconds to close the HTTP session. - It is set to 10 minutes by default.</para></listitem> - </itemizedlist> - On clicking on Web Management Plugin name in Broker object tree the tab for Web Management Plugin is displayed with current plugin settings. - The plugin attributes can be changed by clicking on "Edit" button in Plugin tab. The changes will take effect only after Broker is restarted. - </para> +<section id="Java-Broker-Configuring-And-Managing-HTTP-Management"> + <title>HTTP Management</title> + <section id="Java-Broker-Configuring-And-Managing-HTTP-Management-Introduction"> + <title>Introduction</title> + <para> + The brokers HTTP Management Plugin provides the <link linkend="Java-Broker-Configuring-And-Managing-Web-Console">Web Management Console</link> + to enable fully configuring the Broker, via an underlying <link linkend="Java-Broker-Configuring-And-Managing-REST-API">REST management interface</link>. + </para> + <para> + It is included into the brokers Initial Configuration by default, and is responsible for servicing the HTTP ports configured on the broker. + </para> + </section> + + <!-- INCLUDE --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Configuring-And-Managing-Web-Console.xml"/> + + <section id="Java-Broker-Configuring-And-Managing-HTTP-Management-Plugin-Configuration"> + <title>HTTP Management Plugin Configuration</title> + + <para> + The HTTP Management Plugin itself can be configured through the <link linkend="Java-Broker-Configuring-And-Managing-Web-Console">Web Management Console</link> + and underlying REST management interface. By double-clicking on the Http Management Plugin name in the object tree a tab for the plugin + is displayed with its current settings, which can be changed by clicking on the "Edit" button. + + The following attributes can be set on the HTTP Management Plugin: + <itemizedlist> + <listitem><para><emphasis>Basic Authentication for HTTP</emphasis>. It is set to false (disabled) by default.</para></listitem> + <listitem><para><emphasis>Basic Authentication for HTTPS</emphasis>. It is set to true (enabled) by default.</para></listitem> + <listitem><para><emphasis>SASL Authentication for HTTP</emphasis>. It is set to true (enabled) by default.</para></listitem> + <listitem><para><emphasis>SASL Authentication for HTTPS</emphasis>. It is set to true (enabled) by default.</para></listitem> + <listitem><para><emphasis>Session timeout</emphasis> is the timeout in seconds to close the HTTP session. + It is set to 10 minutes by default.</para></listitem> + </itemizedlist> + NOTE: Changes to the Session Timeout attribute only take effect at broker restart. + </para> + </section> + + <!-- INCLUDE --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Configuring-And-Managing-REST-API.xml"/> </section> |
