QPID-8091: [Broker-J] Update transaction timeout chapter in docbook
[qpid-broker-j.git] / doc / java-broker / src / docbkx / management / managing / Java-Broker-Management-Managing-Virtualhosts.xml
1 <?xml version="1.0"?>
2 <!--
3
4 Licensed to the Apache Software Foundation (ASF) under one
5 or more contributor license agreements. See the NOTICE file
6 distributed with this work for additional information
7 regarding copyright ownership. The ASF licenses this file
8 to you under the Apache License, Version 2.0 (the
9 "License"); you may not use this file except in compliance
10 with the License. You may obtain a copy of the License at
11
12 http://www.apache.org/licenses/LICENSE-2.0
13
14 Unless required by applicable law or agreed to in writing,
15 software distributed under the License is distributed on an
16 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 KIND, either express or implied. See the License for the
18 specific language governing permissions and limitations
19 under the License.
20
21 -->
22
23 <section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Management-Managing-Virtualhosts">
24 <title>VirtualHosts</title>
25 <para>A virtualhost is a independent namespace in which messaging is performed. Virtualhosts are
26 responsible for the storage of message data.</para>
27 <para>Virtualhosts can only be managed by the HTTP management channel.</para>
28 <section xml:id="Java-Broker-Management-Managing-Virtualhosts-Types">
29 <title>Types</title>
30 <para>The following virtualhost types are supported. <itemizedlist>
31 <listitem>
32 <para>BDB - Virtualhost backed with Oracle Berkeley DB JE</para>
33 </listitem>
34 <listitem>
35 <para>BDB HA - Virtualhost backed with Oracle BDB utilising High Availability</para>
36 </listitem>
37 <listitem>
38 <para>DERBY - Virtualhost backed with Apache Derby</para>
39 </listitem>
40 <listitem>
41 <para>JDBC - Virtualhost backed with an external database <footnote>
42 <para>JDBC 4.0 compatible drivers must be available. See <xref linkend="Java-Broker-Miscellaneous-Installing-External-JDBC-Driver"/></para>
43 </footnote></para>
44 </listitem>
45 <listitem>
46 <para>Memory - In-memory node (changes lost on Broker restart)</para>
47 </listitem>
48 <listitem>
49 <para>Provided - Virtualhost that co-locates message data within the parent virtualhost
50 node <footnote>
51 <para>Not available if Virtualhost Node type is JSON.</para>
52 </footnote>.</para>
53 </listitem>
54 </itemizedlist>
55 </para>
56 </section>
57 <section xml:id="Java-Broker-Management-Managing-Virtualhost-Context">
58 <title>Context</title>
59 <para>
60 <itemizedlist>
61 <listitem>
62 <para><emphasis>use_async_message_store_recovery</emphasis> Controls the <link linkend="Java-Broker-Runtime-Background-Recovery">background recovery</link>
63 feature.</para>
64 </listitem>
65 </itemizedlist>
66 </para>
67 </section>
68 <section xml:id="Java-Broker-Management-Managing-Virtualhost-Attributes">
69 <title>Attributes</title>
70 <para>
71 <itemizedlist>
72 <listitem>
73 <para><emphasis>Name the virtualhost</emphasis>. This is the name the messaging clients
74 refer to when forming a connection to the Broker.</para>
75 </listitem>
76 <listitem>
77 <para><emphasis>Store Path/JDBC URL</emphasis>. Refers the file system location or
78 database URL used to store the message data.</para>
79 </listitem>
80 <listitem>
81 <para><emphasis>Store overflow/underflow</emphasis>. Some virtualhosts have the ability to
82 limit the of the cumulative size of all the messages contained within the store. This
83 feature is described in detail <xref linkend="Java-Broker-Runtime-Disk-Space-Management"/>.</para>
84 </listitem>
85 <listitem>
86 <para><emphasis>Connection thread pool size</emphasis>. Number of worker threads
87 used to perform messaging with connected clients. </para>
88 <para>Defaults to 64 or double the maximum number of available processors, whichever
89 is the larger.</para>
90 </listitem>
91 <listitem>
92 <para><emphasis>Number of selectors</emphasis>. Number of worker threads
93 used from the thread pool to dispatch I/O activity to the worker threads.</para>
94 <para>Defaults to one eighth of the thread pool size. Minimum 1.</para>
95 </listitem>
96 <listitem>
97 <para><emphasis>Store transaction timeouts</emphasis>. Warns of long running producer
98 transactions. See <xref linkend="Java-Broker-Runtime-Transaction-Timeout"/></para>
99 </listitem>
100 <listitem>
101 <para><emphasis>Synchronization policy</emphasis>. HA only. See <xref linkend="Java-Broker-High-Availability-Behaviour-SynchronizationPolicy"/></para>
102 </listitem>
103 </itemizedlist>
104 </para>
105 </section>
106 <section xml:id="Java-Broker-Management-Managing-Virtualhost-Children">
107 <title>Children</title>
108 <para>
109 <itemizedlist>
110 <listitem>
111 <para>
112 <link linkend="Java-Broker-Management-Managing-Exchanges">Exchange</link>
113 </para>
114 </listitem>
115 <listitem>
116 <para>
117 <link linkend="Java-Broker-Management-Managing-Queues">Queue</link>
118 </para>
119 </listitem>
120 </itemizedlist>
121 </para>
122 </section>
123 <section xml:id="Java-Broker-Management-Managing-Virtualhost-Lifecycle">
124 <title>Lifecycle</title>
125 <para>
126 <itemizedlist>
127 <listitem>
128 <para><emphasis>Stop</emphasis>. Stops the virtualhost. This closes any existing messaging
129 connections to the virtualhost and prevents new ones. Any inflight transactions are
130 rolled back. Non durable queues and non durable exchanges are lost. Transient messages
131 or persistent messages on non-durable queues are lost.</para>
132 </listitem>
133 <listitem>
134 <para><emphasis>Start</emphasis>. Activates the virtualhost.</para>
135 </listitem>
136 </itemizedlist>
137 </para>
138 </section>
139 </section>