From 3dfe835be7ad47747ebc2154b882fc2a0d7b0c9e Mon Sep 17 00:00:00 2001 From: Robert Gemmell Date: Mon, 20 May 2013 00:57:24 +0000 Subject: 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 --- ...ker-Configuring-And-Managing-Web-Management.xml | 63 +++++++++++++--------- 1 file changed, 37 insertions(+), 26 deletions(-) (limited to 'qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Web-Management.xml') 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 @@ --> -
- Web Management - - 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. - - - Web Management itself can be configured through REST management interfaces and Web Management Console. - The following attributes can be set on Web Management Plugin: - - Basic Authentication for HTTP is flag to enable/disable - Basic Authentication on HTTP ports. It is set to false by default. - Basic Authentication for HTTPS is flag to enable/disable - Basic Authentication on HTTPS ports. It is set to true by default. - SASL Authentication for HTTP is flag to enable/disable - SASL Authentication on HTTP ports. It is set to true by default. - SASL Authentication for HTTPS is flag to enable/disable - SASL Authentication on HTTPS ports. It is set to true by default. - Session timeout is the timeout in seconds to close the HTTP session. - It is set to 10 minutes by default. - - 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. - +
+ HTTP Management +
+ Introduction + + The brokers HTTP Management Plugin provides the Web Management Console + to enable fully configuring the Broker, via an underlying REST management interface. + + + It is included into the brokers Initial Configuration by default, and is responsible for servicing the HTTP ports configured on the broker. + +
+ + + +
+ HTTP Management Plugin Configuration + + + The HTTP Management Plugin itself can be configured through the Web Management Console + 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: + + Basic Authentication for HTTP. It is set to false (disabled) by default. + Basic Authentication for HTTPS. It is set to true (enabled) by default. + SASL Authentication for HTTP. It is set to true (enabled) by default. + SASL Authentication for HTTPS. It is set to true (enabled) by default. + Session timeout is the timeout in seconds to close the HTTP session. + It is set to 10 minutes by default. + + NOTE: Changes to the Session Timeout attribute only take effect at broker restart. + +
+ +
-- cgit v1.2.1