summaryrefslogtreecommitdiff
path: root/doc/book/src/java-broker/Java-Broker-Stores-Memory-Store.xml
blob: b8694f33152e245948d2576703bad0ae31108229 (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
<?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-Stores-Memory-Store">
  <title>Memory Store</title>
  <para>
    The Java broker has an in-memory message store implementation.
    This section will detail configuration for using the MemoryMessageStore.
  </para>
  <para>
    Note: when using this store, the broker will store both persistent and non-persistent messages
    in memory, which is to say that neither will be available following a broker restart, and the
    ability to store new messages will be entirely constrained by the JVM heap size.
  </para>

  <section role="h3" id="Java-Broker-Stores-Memory-Store-Configuration">
    <title>Configuration</title>
    <para>
      In order to use the MemoryMessageStore, you must configure it for each VirtualHost desired by updating the store element
      to specify the associated store class, as shown below.
    </para>

    <example>
      <title>Configuring a VirtualHost to use the MemoryMessageStore</title>
      <programlisting><![CDATA[
<virtualhosts>
  <virtualhost>
    <name>vhostname</name>
    <vhostname>
      <store>
        <class>org.apache.qpid.server.store.MemoryMessageStore</class
      </store>
      ...
    </vhostname>
  </virtualhost>
</virtualhosts>
]]></programlisting>
    </example>
  </section>


</section>