diff options
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 | 53 |
1 files changed, 53 insertions, 0 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 new file mode 100644 index 0000000000..1c6a7c4d20 --- /dev/null +++ b/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Web-Management.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +--> + +<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> + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Configuring-And-Managing-Web-Console.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Configuring-And-Managing-REST-API.xml"/> + +</section> |