summaryrefslogtreecommitdiff
path: root/qpid/doc/book/src/java-broker/Java-Broker-Virtual-Hosts.xml
blob: 0a8f754aa028ae4f62773cfa1b9d9980adf74333 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<?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-REST-API">REST Management interfaces</link>
      and <link linkend="Java-Broker-Configuring-And-Managing-Web-Console">Web Management Console</link>
      can be used to add and delete Virtual Hosts.</para>

      <para>A new Virtual Host can be created in two ways by specifying either:
        <itemizedlist>
            <listitem><para>A <link linkend="Java-Broker-Stores">store type</link> and a store path</para></listitem>
            <listitem><para>A path to Virtual Host XML configuration file</para></listitem>
        </itemizedlist>
        In first case the virtual host attributes are derived from Broker global attributes.
        In the second case, the Virtual Host specific configuration can be set in the configuration XML,
        for example, alert thresholds, message store, queues, exchanges, ACL etc. The first way of Virtual Host creation
        is more preferable as it will reduce the burden of configuration changes when migrating to a newer version,
        especially, when the support of Virtual Host configuration XML will be removed. However, the second way
        is the only way at the moment to configure <link linkend="Java-Broker-Stores-HA-BDB-Store">HA Message Store</link>,
        Virtual Host <link linkend="Java-Broker-Security-ACLs">ACL</link> and virtual host specific attributes.
      </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>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Virtual-Hosts-Configuration.xml"/>

</chapter>