diff options
Diffstat (limited to 'doc/book/src/java-broker/Java-Broker-Stores-Memory-Store.xml')
| -rw-r--r-- | doc/book/src/java-broker/Java-Broker-Stores-Memory-Store.xml | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/doc/book/src/java-broker/Java-Broker-Stores-Memory-Store.xml b/doc/book/src/java-broker/Java-Broker-Stores-Memory-Store.xml new file mode 100644 index 0000000000..b8694f3315 --- /dev/null +++ b/doc/book/src/java-broker/Java-Broker-Stores-Memory-Store.xml @@ -0,0 +1,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> |