doc/book/src/java-broker/Java-Broker-Virtual-Hosts.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.

-->

<chapter id="Java-Broker-Virtual-Hosts">
  <title>Virtual Hosts</title>

  <section id="Java-Broker-Virtual-Hosts-Configuring-Managing">
      <title>Configuring And Managing</title>
      <para>
        One or more Virtual Hosts can be configured on the Broker. The
        <link linkend="Java-Broker-Configuring-And-Managing-HTTP-Management-Introduction">HTTP management interfaces</link>
        can be used to add and delete Virtual Hosts.
      </para>

      <para>A new Virtual Host can be created in two ways:
        <itemizedlist>
            <listitem>
                <para>
                    <emphasis>Supplying simply a type, store path, and type specific fields (in the case of a "STANDARD" Virtual Host this is simply a <link linkend="Java-Broker-Stores">store type</link>) and a store path</emphasis>: In this case,
                    the virtual host attributes are currently derived from default attribute values defined on the broker. This is the preferred approach.
                </para>
            </listitem>
            <listitem>
                <para>
                    <emphasis>Supplying the path to a <link linkend="Java-Broker-Virtual-Hosts-Configuration-File">Virtual Host XML configuration file</link></emphasis>: In this case, specific per-virtualhost attribute configuration
                    can be set in the file, as well as pre-configuring queues, exchanges, etc. This is no longer the preferred approach and will likely be removed in
                    a future release, however it is currently still neccessary to support certain use-cases such as per-virtualhost attribute configuration, and
                    specialised Virtual Host configuration such for the <link linkend="Java-Broker-Stores-HA-BDB-Store">BDB HA Message Store</link>.
                </para>
            </listitem>
        </itemizedlist>
      </para>

      <para>The following Virtual Host Managing operations are available from
        <link linkend="Java-Broker-Configuring-And-Managing-Web-Console">Web Management Console</link>:
        <itemizedlist>
            <listitem><para>A new Virtual Host can be added into Broker by pressing "Add Virtual Host" button
            on the Broker tab.</para></listitem>
            <listitem><para>The existing Virtual Host(s) can be removed by pressing "Remove Virtual Host" button on the Broker tab.</para></listitem>
            <listitem><para>The Virtual Host details can be viewed on the Virtual Host tab.
            This tab can be displayed after clicking onto Virtual Host Name in the Broker object tree
            or onto the Virtual Host row in the Virtual Hosts grid on the Broker tab.</para></listitem>
            <listitem><para>Queues can be configured (added/removed) from Virtual Host tab</para></listitem>
            <listitem><para>Exchange can be configured (added/removed) from Virtual Host tab</para></listitem>
            <listitem><para>Existing Exchange/Queue tabs can be navigated from Virtual Host tab</para></listitem>
        </itemizedlist>
      </para>
  </section>

</chapter>