doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Web-Management.xml

<?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-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>