blob: d49c3192d4aba6d910cd42fbf0c088e07f203e69 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.18">
<link rel="icon" type="image/png" href="images/favicon.png">
<title>Configuration Reference</title>
<link rel="stylesheet" href="css/asciidoctor.css">
<link rel="stylesheet" href="css/font-awesome.css">
<link rel="stylesheet" href="css/rouge-github.css">
</head>
<body class="book toc2 toc-left">
<div id="header">
<h1>Configuration Reference</h1>
<div id="toc" class="toc2">
<div id="toctitle"><a href="index.html">User Manual for 2.32.0</a></div>
<ul class="sectlevel1">
<li><a href="#broker-configuration">1. Broker Configuration</a>
<ul class="sectlevel2">
<li><a href="#broker-xml">1.1. broker.xml</a></li>
<li><a href="#system-properties">1.2. System properties</a></li>
<li><a href="#broker-properties">1.3. Broker properties</a></li>
</ul>
</li>
<li><a href="#the-core-configuration">2. The core configuration</a></li>
<li><a href="#address-setting-type">3. address-setting type</a></li>
<li><a href="#bridge-type">4. bridge type</a></li>
<li><a href="#broadcast-group-type">5. broadcast-group type</a></li>
<li><a href="#cluster-connection-type">6. cluster-connection type</a></li>
<li><a href="#discovery-group-type">7. discovery-group type</a></li>
<li><a href="#divert-type">8. divert type</a></li>
<li><a href="#address-type">9. address type</a></li>
<li><a href="#queue-type">10. queue type</a></li>
<li><a href="#security-setting-type">11. security-setting type</a></li>
<li><a href="#broker-plugin-type">12. broker-plugin type</a></li>
<li><a href="#metrics-plugin-type">13. metrics-plugin type</a></li>
<li><a href="#resource-limit-type">14. resource-limit type</a></li>
<li><a href="#grouping-handler-type">15. grouping-handler type</a></li>
<li><a href="#amqp-connection-type">16. amqp-connection type</a></li>
</ul>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>This section is a quick index for looking up configuration.
Click on the element name to go to the specific chapter.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="broker-configuration"><a class="anchor" href="#broker-configuration"></a><a class="link" href="#broker-configuration">1. Broker Configuration</a></h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="broker-xml"><a class="anchor" href="#broker-xml"></a><a class="link" href="#broker-xml">1.1. broker.xml</a></h3>
<div class="paragraph">
<p>This is the main core server configuration file which contains the <code>core</code> element.
The <code>core</code> element contains the main server configuration.</p>
</div>
<div class="sect3">
<h4 id="modularising-broker-xml"><a class="anchor" href="#modularising-broker-xml"></a><a class="link" href="#modularising-broker-xml">1.1.1. Modularising broker.xml</a></h4>
<div class="paragraph">
<p>XML XInclude support is provided in <code>broker.xml</code> so that you can break your configuration out into separate files.</p>
</div>
<div class="paragraph">
<p>To do this ensure the following is defined at the root configuration element.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight nowrap"><code data-lang="xml">xmlns:xi="http://www.w3.org/2001/XInclude"</code></pre>
</div>
</div>
<div class="paragraph">
<p>You can now define include tag&#8217;s where you want to bring in xml configuration from another file:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight nowrap"><code data-lang="xml"><span class="nt">&lt;xi:include</span> <span class="na">href=</span><span class="s">"my-address-settings.xml"</span><span class="nt">/&gt;</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>You should ensure xml elements in separated files should be namespaced correctly for example if address-settings element was separated, it should have the element namespace defined:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight nowrap"><code data-lang="xml"> <span class="nt">&lt;address-settings</span> <span class="na">xmlns=</span><span class="s">"urn:activemq:core"</span><span class="nt">&gt;</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>An example can of this feature can be seen in the test suites:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="nowrap">./artemis-server/src/test/resources/ConfigurationTest-xinclude-config.xml</pre>
</div>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
if you use <code>xmllint</code> to validate the XML against the schema you should enable xinclude flag when running.
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="content">
<pre class="nowrap">--xinclude</pre>
</div>
</div>
<div class="paragraph">
<p>For further information on XInclude see: <a href="https://www.w3.org/TR/xinclude/" class="bare">https://www.w3.org/TR/xinclude/</a></p>
</div>
<div class="paragraph">
<p>To disable XML external entity processing use the system property <code>artemis.disableXxe</code>, e.g.:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="nowrap">-Dartemis.disableXxe=true</pre>
</div>
</div>
<div class="sect4">
<h5 id="reloading-modular-configuration-files"><a class="anchor" href="#reloading-modular-configuration-files"></a><a class="link" href="#reloading-modular-configuration-files">Reloading modular configuration files</a></h5>
<div class="paragraph">
<p>Certain changes in <code>broker.xml</code> can be picked up at runtime as discussed in the <a href="config-reload.html#configuration-reload">Configuration Reload</a> chapter.
Changes made directly to files which are included in <code>broker.xml</code> via <code>xi:include</code> will not be automatically reloaded.
For example, if <code>broker.xml</code> is including <code>my-address-settings.xml</code> and <code>my-address-settings.xml</code> is modified those changes won&#8217;t be reloaded automatically.
To force a reload in this situation there are 2 main options:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Use the <code>reloadConfiguration</code> management operation on the <code>ActiveMQServerControl</code>.</p>
</li>
<li>
<p>Update the timestamp on <code>broker.xml</code> using something like the <a href="https://en.wikipedia.org/wiki/Touch_%28Unix%29">touch</a> command.
The next time the broker inspects <code>broker.xml</code> for automatic reload it will see the updated timestamp and trigger a reload of <code>broker.xml</code> and all its included files.</p>
</li>
</ol>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="system-properties"><a class="anchor" href="#system-properties"></a><a class="link" href="#system-properties">1.2. System properties</a></h3>
<div class="paragraph">
<p>It is possible to use System properties to replace some of the configuration properties.
If you define a System property starting with "brokerconfig." that will be passed along to Bean Utils and the configuration would be replaced.</p>
</div>
<div class="paragraph">
<p>To define global-max-size=1000000 using a system property you would have to define this property, for example through java arguments:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="nowrap">java -Dbrokerconfig.globalMaxSize=1000000</pre>
</div>
</div>
<div class="paragraph">
<p>You can also change the prefix through the <code>broker.xml</code> by setting:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="nowrap">&lt;system-property-prefix&gt;yourprefix&lt;/system-property-prefix&gt;</pre>
</div>
</div>
<div class="paragraph">
<p>This is to help you customize artemis on embedded systems.</p>
</div>
</div>
<div class="sect2">
<h3 id="broker-properties"><a class="anchor" href="#broker-properties"></a><a class="link" href="#broker-properties">1.3. Broker properties</a></h3>
<div class="paragraph">
<p>Broker properties extends the use of properties to allow updates and additions to the broker configuration after any xml has been parsed.
In the absence of any broker.xml, the hard coded defaults can be modified.
Internally, any xml configuration is applied to a java bean style configuration object.
Typically, there are setters for each of the xml attributes.
However, for properties, the naming convention changes from 'a-b' to 'aB' to reflect the camelCase java naming convention.</p>
</div>
<div class="paragraph">
<p>Collections need some special treatment to allow additions and reference.
We utilise the name attribute of configuration entities to find existing entries and when populating new entities, we set the name to match the requested key.
Removal of configuration from named collections is supported by setting a key value to "-".
The remove match value can be configured with a property key "remove.value".</p>
</div>
<div class="paragraph">
<p>For example, a properties file containing:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="nowrap">securityEnabled=false
acceptorConfigurations.tcp.factoryClassName=org.apache.activemq.artemis.core.remoting.impl.netty.NettyAcceptorFactory
acceptorConfigurations.tcp.params.HOST=localhost
acceptorConfigurations.tcp.params.PORT=61616</pre>
</div>
</div>
<div class="paragraph">
<p>would: 1) disable RBAC security checks 2) add or modify an acceptor named "tcp" that will use Netty 3) set the acceptor named "tcp" 'HOST' parameter to localhost 4) set the acceptor named "tcp" 'PORT' parameter to 61616</p>
</div>
<div class="paragraph">
<p>The configuration properties are low level, lower level than xml, however it is very powerful;
any accessible attribute of the internal <code>org.apache.activemq.artemis.core.config.impl.ConfigurationImpl</code> objects can be modified.</p>
</div>
<div class="paragraph">
<p>With great power one must take great care!</p>
</div>
<div class="paragraph">
<p>The <code>artemis run</code> command script supports <code>--properties &lt;properties file url&gt;</code>, where a properties file can be configured.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
one shortcoming of this method of configuration is that any property that does not match is ignored with no fanfare.
Enable debug logging for <code>org.apache.activemq.artemis.core.config.impl.ConfigurationImpl</code> to get more insight.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>There are a growing number of examples of what can be explicitly configured in this way in the <a href="https://github.com/apache/activemq-artemis/blob/065bfe14f532858f2c2a20b0afb1a226b08ce013/artemis-server/src/test/java/org/apache/activemq/artemis/core/config/impl/ConfigurationImplTest.java#L675">unit test</a>.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="the-core-configuration"><a class="anchor" href="#the-core-configuration"></a><a class="link" href="#the-core-configuration">2. The core configuration</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>This describes the root of the XML configuration.
You will see here also multiple sub-types listed.
For example on the main config you will have bridges and at the <a href="#bridge-type">list of bridge</a> type we will describe the properties for that configuration.</p>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The default values listed below are the values which will be used if the configuration parameter is <strong>not set</strong> either programmatically or via <code>broker.xml</code>.
Some of these values are set in the <code>broker.xml</code> which is available out-of-the-box.
Any values set in the out-of-the-box configuration will override the default values listed here.
Please consult your specific configuration to know which values will actually be used when the broker is running.</p>
</div>
</td>
</tr>
</table>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="configuring-transports.html#acceptors">acceptors</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">a list of remoting acceptors</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="configuring-transports.html#acceptors">acceptors.acceptor</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Each acceptor is composed for just an URL</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-model.html#basic-manual-configuration">addresses</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#address-type">a list of addresses</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-settings.html#address-settings">address-settings</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#address-setting-type">a list of address-setting</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="ha.html#failing-back-to-primary-server">allow-failback</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Should stop backup on primary restart.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="amqp.html#amqp">amqp-use-core-subscription-naming</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If true uses CORE queue naming convention for AMQP.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="connection-ttl.html#detecting-dead-connections">async-connection-execution-enabled</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If False delivery would be always asynchronous.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#persistence">bindings-directory</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The folder in use for the bindings folder</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>data/bindings</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">bridges</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#bridge-type">a list of core bridges</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="ha.html#high-availability-and-failover">ha-policy</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the HA policy of this server</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">none</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#broadcast-groups">broadcast-groups</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#broadcast-group-type">a list of broadcast-group</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="amqp-broker-connections.html#broker-connections">broker-connections</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#amqp-connection-type">a list of amqp-connection</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="broker-plugins.html#plugin-support">broker-plugins</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#broker-plugin-type">a list of broker-plugins</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="config-reload.html#configuration-reload">configuration-file-refresh-period</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The frequency in milliseconds the configuration file is checked for changes</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="ha.html#data-replication">check-for-live-server</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Used by a primary server to verify if there are other nodes with the same ID on the topology</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#configuring-cluster-connections">cluster-connections</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cluster-connection-type">a list of cluster-connection</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">cluster-password</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cluster password.
It applies to all cluster configurations.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">cluster-user</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cluster username.
It applies to all cluster configurations.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="connection-ttl.html#detecting-dead-connections">connection-ttl-override</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">if set, this will override how long (in ms) to keep a connection alive without receiving a ping.
-1 disables this setting.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="connection-ttl.html#detecting-dead-connections">connection-ttl-check-interval</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how often (in ms) to check connections for ttl violation.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="configuring-transports.html#configuring-the-transport">connectors.connector</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The URL for the connector.
This is a list</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#persistence">create-bindings-dir</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true means that the server will create the bindings directory on start up.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#persistence">create-journal-dir</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true means that the journal directory will be created.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#discovery-groups">discovery-groups</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#discovery-group-type">a list of discovery-group</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="paging.html#max-disk-usage">disk-scan-period</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The interval where the disk is scanned for percentual usage.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="diverts.html#diverting-and-splitting-message-flows">diverts</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#divert-type">a list of diverts to use</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="paging.html#global-max-size">global-max-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The amount in bytes before all addresses are considered full.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Half of the JVM&#8217;s <code>-Xmx</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="graceful-shutdown.html#graceful-server-shutdown">graceful-shutdown-enabled</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true means that graceful shutdown is enabled.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="graceful-shutdown.html#graceful-server-shutdown">graceful-shutdown-timeout</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Timeout on waiting for clients to disconnect before server shutdown.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="message-grouping.html#message-grouping">grouping-handler</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#grouping-handler-type">a message grouping handler</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="duplicate-detection.html#configuring-the-duplicate-id-cache">id-cache-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The duplicate detection circular cache size.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">20000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="management.html#configuring-jmx">jmx-domain</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the JMX domain used to registered MBeans in the MBeanServer.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.apache.activemq</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="management.html#configuring-jmx">jmx-use-broker-name</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">whether or not to use the broker name in the JMX properties.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="management.html#configuring-jmx">jmx-management-enabled</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true means that the management API is available via JMX.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">journal-buffer-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The size of the internal buffer on the journal in KB.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">490KB</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">journal-buffer-timeout</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The Flush timeout for the journal buffer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">500000 for ASYNCIO;
3333333 for NIO</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">journal-compact-min-files</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The minimal number of data files before we can start compacting.
Setting this to 0 means compacting is disabled.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">10</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">journal-compact-percentage</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The percentage of live data on which we consider compacting the journal.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">30</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">journal-directory</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the directory to store the journal files in.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>data/journal</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">node-manager-lock-directory</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the directory to store the node manager lock file.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">same of <code>journal-directory</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">journal-file-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the size (in bytes) of each journal file.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">10MB</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">journal-lock-acquisition-timeout</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how long (in ms) to wait to acquire a file lock on the journal.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">journal-max-io</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the maximum number of write requests that can be in the ASYNCIO queue at any one time.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">4096 for ASYNCIO;
1 for NIO;
ignored for MAPPED</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">journal-file-open-timeout</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the length of time in seconds to wait when opening a new journal file before timing out and failing.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">journal-min-files</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how many journal files to pre-create.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">2</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">journal-pool-files</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The upper threshold of the journal file pool, -1 means no Limit.
The system will create as many files as needed however when reclaiming files it will shrink back to the <code>journal-pool-files</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">journal-sync-non-transactional</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">if true wait for non transaction data to be synced to the journal before returning response to client.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">journal-sync-transactional</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">if true wait for transaction data to be synchronized to the journal before returning response to client.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">journal-type</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the type of journal to use.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ASYNCIO</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#configuring-the-message-journal">journal-datasync</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">It will use msync/fsync on journal operations.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="large-messages.html#large-messages">large-messages-directory</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the directory to store large messages.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>data/largemessages</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">log-delegate-factory-class-name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>deprecated</strong> the name of the factory class to use for log delegation.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="management.html#configuring-management">management-address</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the name of the management address to send management messages to.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>activemq.management</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="management.html#configuring-the-management-notification-address">management-notification-address</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the name of the address that consumers bind to receive management notifications.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>activemq.notifications</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="masking-passwords.html#masking-passwords">mask-password</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">This option controls whether passwords in server configuration need be masked.
If set to "true" the passwords are masked.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="ha.html#data-replication">max-saved-replicated-journals-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">This specifies how many replication backup directories will be kept when server starts as replica.
-1 Means no Limit;
0 don&#8217;t keep a copy at all.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">2</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="paging.html#max-disk-usage">max-disk-usage</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The max percentage of data we should use from disks.
The broker will block while the disk is full.
Disable by setting -1.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">90</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="perf-tuning.html#performance-tuning">memory-measure-interval</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">frequency to sample JVM memory in ms (or -1 to disable memory sampling).</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="perf-tuning.html#performance-tuning">memory-warning-threshold</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Percentage of available memory which will trigger a warning log.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">25</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="management.html#message-counters">message-counter-enabled</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true means that message counters are enabled.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="management.html#message-counters">message-counter-max-day-history</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how many days to keep message counter history.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">10</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="management.html#message-counters">message-counter-sample-period</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the sample period (in ms) to use for message counters.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">10000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="message-expiry.html#configuring-the-expiry-reaper-thread">message-expiry-scan-period</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how often (in ms) to scan for expired messages.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">30000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="message-expiry.html#configuring-the-expiry-reaper-thread">message-expiry-thread-priority</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>deprecated</strong> the priority of the thread expiring messages.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">3</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="metrics.html#metrics">metrics-plugin</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#metrics-plugin-type">a plugin to export metrics</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-settings.html#address-settings">address-queue-scan-period</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how often (in ms) to scan for addresses &amp; queues that should be removed.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">30000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">node name;
used in topology notifications if set.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="masking-passwords.html#masking-passwords">password-codec</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the name of the class (and optional configuration properties) used to decode masked passwords.
Only valid when <code>mask-password</code> is <code>true</code>.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="paging.html#paging">page-max-concurrent-io</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The max number of concurrent reads allowed on paging.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="paging.html#page-sync-timeout">page-sync-timeout</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The time in nanoseconds a page will be synced.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">3333333 for ASYNCIO;
<code>journal-buffer-timeout</code> for NIO</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="paging.html#paging">read-whole-page</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If true the whole page would be read, otherwise just seek and read while getting message.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="paging.html#configuration">paging-directory</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the directory to store paged messages in.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>data/paging</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="undelivered-messages.html#delivery-count-persistence">persist-delivery-count-before-delivery</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">True means that the delivery count is persisted before delivery.
False means that this only happens after a message has been cancelled.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="undelivered-messages.html#delivery-count-persistence">max-redelivery-records</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum number of records the system will store for redeliveries.
In most cases this should be set to '1'.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>10</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="persistence.html#zero-persistence">persistence-enabled</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true means that the server will use the file based journal for persistence.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="duplicate-detection.html#configuring-the-duplicate-id-cache">persist-id-cache</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true means that ID&#8217;s are persisted to the journal.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">queues</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>deprecated</strong> <a href="#address-type">use addresses</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="intercepting-operations.html#intercepting-operations">remoting-incoming-interceptors</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">a list of &lt;class-name/&gt; elements with the names of classes to use for intercepting incoming remoting packets</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="intercepting-operations.html#intercepting-operations">remoting-outgoing-interceptors</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">a list of &lt;class-name/&gt; elements with the names of classes to use for intercepting outgoing remoting packets</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">resolveProtocols</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use <a href="https://docs.oracle.com/javase/tutorial/ext/basics/spi.html">ServiceLoader</a> to load protocol modules.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="resource-limits.html#resource-limits">resource-limit-settings</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#resource-limit-type">a list of resource-limits</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="thread-pooling.html#server-scheduled-thread-pool">scheduled-thread-pool-max-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum number of threads to use for the scheduled thread pool.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="security.html#authentication-authorization">security-enabled</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true means that security is enabled.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="security.html#authentication-authorization">security-invalidation-interval</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how long (in ms) to wait before invalidating the security cache.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">10000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">system-property-prefix</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Prefix for replacing configuration settings using Bean Utils.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">internal-naming-prefix</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the prefix used when naming the internal queues and addresses required for implementing certain behaviours.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>$.activemq.internal</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="security.html#tracking-the-validated-user">populate-validated-user</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">whether or not to add the name of the validated user to the messages that user sends.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="security.html#role-based-security-for-addresses">security-settings</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#security-setting-type">a list of security-setting</a>.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="thread-pooling.html#thread-management">thread-pool-max-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum number of threads to use for the thread pool.
-1 means 'no limits'.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">30</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="transaction-config.html#resource-manager-configuration">transaction-timeout</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how long (in ms) before a transaction can be removed from the resource manager after create time.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">300000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="transaction-config.html#resource-manager-configuration">transaction-timeout-scan-period</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how often (in ms) to scan for timeout transactions.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="wildcard-routing.html#routing-messages-with-wild-cards">wild-card-routing-enabled</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true means that the server supports wild card routing.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="network-isolation.html#network-isolation-split-brain">network-check-NIC</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the NIC (Network Interface Controller) to be used on InetAddress.isReachable.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="network-isolation.html#network-isolation-split-brain">network-check-URL-list</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the list of http URIs to be used to validate the network.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="network-isolation.html#network-isolation-split-brain">network-check-list</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the list of pings to be used on ping or InetAddress.isReachable.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="network-isolation.html#network-isolation-split-brain">network-check-period</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">a frequency in milliseconds to how often we should check if the network is still up.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">10000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="network-isolation.html#network-isolation-split-brain">network-check-timeout</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">a timeout used in milliseconds to be used on the ping.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="network-isolation.html#network-isolation-split-brain">network-check-ping-command</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the command used to oping IPV4 addresses.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="network-isolation.html#network-isolation-split-brain">network-check-ping6-command</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the command used to oping IPV6 addresses.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="critical-analysis.html#critical-analysis-of-the-broker">critical-analyzer</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">enable or disable the critical analysis.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="critical-analysis.html#critical-analysis-of-the-broker">critical-analyzer-timeout</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">timeout used to do the critical analysis.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">120000 ms</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="critical-analysis.html#critical-analysis-of-the-broker">critical-analyzer-check-period</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">time used to check the response times.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">0.5 * <code>critical-analyzer-timeout</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="critical-analysis.html#critical-analysis-of-the-broker">critical-analyzer-policy</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">should the server log, be halted or shutdown upon failures.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>LOG</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">resolve-protocols</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">if true then the broker will make use of any protocol managers that are in available on the classpath, otherwise only the core protocol will be available, unless in embedded mode where users can inject their own protocol managers.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="resource-limits.html#resource-limits">resource-limit-settings</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#resource-limit-type">a list of resource-limit</a>.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">server-dump-interval</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">interval to log server specific information (e.g. memory usage etc).</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">store</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the store type used by the server.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="wildcard-syntax.html#wildcard-syntax">wildcard-addresses</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">parameters to configure wildcard address matching format.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="address-setting-type"><a class="anchor" href="#address-setting-type"></a><a class="link" href="#address-setting-type">3. address-setting type</a></h2>
<div class="sectionbody">
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-model.html#address-model">match</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The filter to apply to the setting</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="undelivered-messages.html#message-redelivery-and-undelivered-messages">dead-letter-address</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Dead letter address</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="undelivered-messages.html#message-redelivery-and-undelivered-messages">auto-create-dead-letter-resources</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Whether or not to auto-create dead-letter address and/or queue</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="undelivered-messages.html#message-redelivery-and-undelivered-messages">dead-letter-queue-prefix</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Prefix to use for auto-created dead-letter queues</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>DLQ.</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="undelivered-messages.html#message-redelivery-and-undelivered-messages">dead-letter-queue-suffix</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Suffix to use for auto-created dead-letter queues</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">`` (empty)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="message-expiry.html#message-expiry">expiry-address</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Expired messages address</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="message-expiry.html#message-expiry">expiry-delay</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Expiration time override;
-1 don&#8217;t override</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="undelivered-messages.html#message-redelivery-and-undelivered-messages">redelivery-delay</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Time to wait before redelivering a message</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">0</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="undelivered-messages.html#message-redelivery-and-undelivered-messages">redelivery-delay-multiplier</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Multiplier to apply to the <code>redelivery-delay</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="undelivered-messages.html#message-redelivery-and-undelivered-messages">redelivery-collision-avoidance-factor</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">an additional factor used to calculate an adjustment to the <code>redelivery-delay</code> (up or down)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">0.0</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="undelivered-messages.html#message-redelivery-and-undelivered-messages">max-redelivery-delay</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Max value for the <code>redelivery-delay</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">10 * <code>redelivery-delay</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="undelivered-messages.html#message-redelivery-and-undelivered-messages">max-delivery-attempts</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Number of retries before dead letter address</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">10</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="paging.html#paging">max-size-bytes</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Max size a queue can be before invoking <code>address-full-policy</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="paging.html#paging">max-size-bytes-reject-threshold</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Used with <code>BLOCK</code>, the max size an address can reach before messages are rejected;
works in combination with <code>max-size-bytes</code> <strong>for AMQP clients only</strong>.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="paging.html#paging">page-size-bytes</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Size of each file on page</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">10485760</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-model.html#address-model">address-full-policy</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">What to do when a queue reaches <code>max-size-bytes</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>PAGE</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-model.html#address-model">message-counter-history-day-limit</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Days to keep message counter data</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">0</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="last-value-queues.html#last-value-queues">last-value-queue</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>deprecated</strong> Queue is a last value queue;
see <code>default-last-value-queue</code> instead</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="last-value-queues.html#last-value-queues">default-last-value-queue</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>last-value</code> value if none is set on the queue</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="last-value-queues.html#last-value-queues">default-last-value-key</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>last-value-key</code> value if none is set on the queue</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>null</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="exclusive-queues.html#exclusive-queues">default-exclusive-queue</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>exclusive</code> value if none is set on the queue</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="exclusive-queues.html#exclusive-queues">default-non-destructive</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>non-destructive</code> value if none is set on the queue</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="exclusive-queues.html#exclusive-queues">default-consumers-before-dispatch</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>consumers-before-dispatch</code> value if none is set on the queue</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">0</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="exclusive-queues.html#exclusive-queues">default-delay-before-dispatch</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>delay-before-dispatch</code> value if none is set on the queue</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">redistribution-delay</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Timeout before redistributing values after no consumers</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-model.html#address-model">send-to-dla-on-no-route</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Forward messages to DLA when no queues subscribing</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="slow-consumers.html#detecting-slow-consumers">slow-consumer-threshold</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Min rate of msgs/sec consumed before a consumer is considered "slow"</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="slow-consumers.html#detecting-slow-consumers">slow-consumer-policy</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">What to do when "slow" consumer is detected</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NOTIFY</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="slow-consumers.html#detecting-slow-consumers">slow-consumer-check-period</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">How often to check for "slow" consumers</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-settings.html#address-settings">auto-create-jms-queues</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>deprecated</strong> Create JMS queues automatically;
see <code>auto-create-queues</code> &amp; <code>auto-create-addresses</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-settings.html#address-settings">auto-delete-jms-queues</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>deprecated</strong> Delete JMS queues automatically;
see <code>auto-create-queues</code> &amp; <code>auto-create-addresses</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-settings.html#address-settings">auto-create-jms-topics</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>deprecated</strong> Create JMS topics automatically;
see <code>auto-create-queues</code> &amp; <code>auto-create-addresses</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-settings.html#address-settings">auto-delete-jms-topics</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>deprecated</strong> Delete JMS topics automatically;
see <code>auto-create-queues</code> &amp; <code>auto-create-addresses</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-settings.html#address-settings">auto-create-queues</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Create queues automatically</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-settings.html#address-settings">auto-delete-queues</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Delete auto-created queues automatically</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-settings.html#address-settings">auto-delete-created-queues</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Delete created queues automatically</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-settings.html#address-settings">auto-delete-queues-delay</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Delay for deleting auto-created queues</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">0</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-settings.html#address-settings">auto-delete-queues-message-count</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Message count the queue must be at or below before it can be auto deleted</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">0</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="config-reload.html#configuration-reload">config-delete-queues</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">How to deal with queues deleted from XML at runtime</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>OFF</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-settings.html#address-settings">auto-create-addresses</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Create addresses automatically</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-settings.html#address-settings">auto-delete-addresses</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Delete auto-created addresses automatically</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-settings.html#address-settings">auto-delete-addresses-delay</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Delay for deleting auto-created addresses</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">0</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="config-reload.html#configuration-reload">config-delete-addresses</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">How to deal with addresses deleted from XML at runtime</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>OFF</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="config-reload.html#configuration-reload">config-delete-diverts</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">How to deal with diverts deleted from XML at runtime</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>OFF</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-settings.html#address-settings">management-browse-page-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Number of messages a management resource can browse</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-model.html#non-durable-subscription-queue">default-purge-on-no-consumers</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>purge-on-no-consumers</code> value if none is set on the queue</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-model.html#shared-durable-subscription-queue-using-max-consumers">default-max-consumers</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>max-consumers</code> value if none is set on the queue</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-model.html#routing-type">default-queue-routing-type</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Routing type for auto-created queues if the type can&#8217;t be otherwise determined</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>MULTICAST</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-model.html#routing-type">default-address-routing-type</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Routing type for auto-created addresses if the type can&#8217;t be otherwise determined</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>MULTICAST</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="ring-queues.html#ring-queue">default-ring-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The ring-size applied to queues without an explicit <code>ring-size</code> configured</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>-1</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="retroactive-addresses.html#retroactive-addresses">retroactive-message-count</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the number of messages to preserve for future queues created on the matching address</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="duplicate-detection.html#configuring-the-duplicate-id-cache">id-cache-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The duplicate detection circular cache size</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Inherits from global <code>id-cache-size</code></p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="bridge-type"><a class="anchor" href="#bridge-type"></a><a class="link" href="#bridge-type">4. bridge type</a></h2>
<div class="sectionbody">
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">name</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">unique name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">queue-name</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">name of queue that this bridge consumes from</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">forwarding-address</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">address to forward to.
If omitted original address is used</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">ha</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">whether this bridge supports fail-over</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">filter</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">optional core filter expression</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">transformer-class-name</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">optional name of transformer class</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">min-large-message-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Limit before message is considered large.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">100KB</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="connection-ttl.html#detecting-dead-connections">check-period</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">How often to check for <a href="https://en.wikipedia.org/wiki/Time_to_live">TTL</a> violation.
-1 means disabled.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">30000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="connection-ttl.html#detecting-dead-connections">connection-ttl</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://en.wikipedia.org/wiki/Time_to_live">TTL</a> for the Bridge.
This should be greater than the ping period.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">60000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">retry-interval</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">period (in ms) between successive retries.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">retry-interval-multiplier</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">multiplier to apply to successive retry intervals.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">max-retry-interval</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Limit to the retry-interval growth.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">reconnect-attempts</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">maximum number of retry attempts.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1 (no limit)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">use-duplicate-detection</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">forward duplicate detection headers?</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">confirmation-window-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">number of bytes before confirmations are sent.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1MB</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">producer-window-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Producer flow control size on the bridge.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1 (disabled)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">user</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Username for the bridge, the default is the cluster username.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">password</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Password for the bridge, default is the cluster password.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">reconnect-attempts-same-node</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Number of retries before trying another node.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">10</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">routing-type</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how to set the routing-type on the bridged message</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>PASS</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="core-bridges.html#core-bridges">concurrency</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Concurrency of the bridge</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="broadcast-group-type"><a class="anchor" href="#broadcast-group-type"></a><a class="link" href="#broadcast-group-type">5. broadcast-group type</a></h2>
<div class="sectionbody">
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">name</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">unique name</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">local-bind-address</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Local bind address that the datagram socket is bound to.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">local-bind-port</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Local port to which the datagram socket is bound to.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">group-address</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Multicast address to which the data will be broadcast.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">group-port</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">UDP port number used for broadcasting.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">broadcast-period</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Period in milliseconds between consecutive broadcasts.
Default=2000.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">jgroups-file</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name of JGroups configuration file.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">jgroups-channel</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name of JGroups Channel.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">connector-ref</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The <code>connector</code> to broadcast.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="cluster-connection-type"><a class="anchor" href="#cluster-connection-type"></a><a class="link" href="#cluster-connection-type">6. cluster-connection type</a></h2>
<div class="sectionbody">
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">name</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">unique name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">address</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">name of the address this cluster connection applies to</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">connector-ref</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name of the connector reference to use.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="connection-ttl.html#detecting-dead-connections">check-period</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The period (in milliseconds) used to check if the cluster connection has failed to receive pings from another server</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">30000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="connection-ttl.html#detecting-dead-connections">connection-ttl</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Timeout for TTL.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">60000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="large-messages.html#large-messages">min-large-message-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Messages larger than this are considered large-messages.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">100KB</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">call-timeout</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Time(ms) before giving up on blocked calls.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">30000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">retry-interval</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">period (in ms) between successive retries.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">500</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">retry-interval-multiplier</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">multiplier to apply to the retry-interval.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">max-retry-interval</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum value for retry-interval.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">2000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">reconnect-attempts</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">How many attempts should be made to reconnect after failure.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">use-duplicate-detection</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">should duplicate detection headers be inserted in forwarded messages?</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">message-load-balancing</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how should messages be load balanced?</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>OFF</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">max-hops</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">maximum number of hops cluster topology is propagated.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="client-failover.html#reconnect-to-the-same-server">confirmation-window-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The size (in bytes) of the window used for confirming data from the server connected to.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1048576</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">producer-window-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Flow Control for the Cluster connection bridge.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1 (disabled)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#configuring-cluster-connections">call-failover-timeout</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">How long to wait for a reply if in the middle of a fail-over.
-1 means wait forever.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">notification-interval</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how often the cluster connection will notify the cluster of its existence right after joining the cluster.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">notification-attempts</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how many times this cluster connection will notify the cluster of its existence right after joining the cluster</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">2</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="discovery-group-type"><a class="anchor" href="#discovery-group-type"></a><a class="link" href="#discovery-group-type">7. discovery-group type</a></h2>
<div class="sectionbody">
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">name</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">unique name</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">group-address</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Multicast IP address of the group to listen on</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">group-port</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">UDP port number of the multi cast group</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">jgroups-file</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name of a JGroups configuration file.
If specified, the server uses JGroups for discovery.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">jgroups-channel</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name of a JGroups Channel.
If specified, the server uses the named channel for discovery.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">refresh-timeout</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Period the discovery group waits after receiving the last broadcast from a particular server before removing that servers connector pair entry from its list.
Default=10000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">local-bind-address</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">local bind address that the datagram socket is bound to</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="clusters.html#clusters">local-bind-port</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">local port to which the datagram socket is bound to.
Default=-1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">initial-wait-timeout</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">time to wait for an initial broadcast to give us at least one node in the cluster.
Default=10000</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="divert-type"><a class="anchor" href="#divert-type"></a><a class="link" href="#divert-type">8. divert type</a></h2>
<div class="sectionbody">
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="diverts.html#diverting-and-splitting-message-flows">name</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">unique name</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="diverts.html#diverting-and-splitting-message-flows">transformer-class-name</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">an optional class name of a transformer</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="diverts.html#diverting-and-splitting-message-flows">exclusive</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">whether this is an exclusive divert.
Default=false</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="diverts.html#diverting-and-splitting-message-flows">routing-name</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the routing name for the divert</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="diverts.html#diverting-and-splitting-message-flows">address</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the address this divert will divert from</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="diverts.html#diverting-and-splitting-message-flows">forwarding-address</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the forwarding address for the divert</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="diverts.html#diverting-and-splitting-message-flows">filter</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">optional core filter expression</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="diverts.html#diverting-and-splitting-message-flows">routing-type</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how to set the routing-type on the diverted message.
Default=<code>STRIP</code></p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="address-type"><a class="anchor" href="#address-type"></a><a class="link" href="#address-type">9. address type</a></h2>
<div class="sectionbody">
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top"></th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">unique name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-model.html#anycast">anycast</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">list of anycast <a href="#queue-type">queues</a></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-model.html#multicast">multicast</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">list of multicast <a href="#queue-type">queues</a></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="queue-type"><a class="anchor" href="#queue-type"></a><a class="link" href="#queue-type">10. queue type</a></h2>
<div class="sectionbody">
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">unique name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">filter</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">optional core filter expression</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">durable</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">whether the queue is durable (persistent).</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">user</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the name of the user to associate with the creation of the queue</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-model.html#shared-durable-subscription-queue-using-max-consumers">max-consumers</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the max number of consumers allowed on this queue</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1 (no max)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="address-model.html#non-durable-subscription-queue">purge-on-no-consumers</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">whether or not to delete all messages and prevent routing when no consumers are connected</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="exclusive-queues.html#exclusive-queues">exclusive</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">only deliver messages to one of the connected consumers</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="last-value-queues.html#last-value-queues">last-value</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">use last-value semantics</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="ring-queues.html#ring-queue">ring-size</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the size this queue should maintain according to ring semantics</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">based on <code>default-ring-size</code> <code>address-setting</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">consumers-before-dispatch</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">number of consumers required before dispatching messages</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">0</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">delay-before-dispatch</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">milliseconds to wait for <code>consumers-before-dispatch</code> to be met before dispatching messages anyway</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1 (wait forever)</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="security-setting-type"><a class="anchor" href="#security-setting-type"></a><a class="link" href="#security-setting-type">11. security-setting type</a></h2>
<div class="sectionbody">
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="security.html#authentication-authorization">match</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="wildcard-syntax.html#wildcard-syntax">address expression</a></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="security.html#authentication-authorization">permission</a></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="security.html#authentication-authorization">permission.type</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the type of permission</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="security.html#authentication-authorization">permission.roles</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">a comma-separated list of roles to apply the permission to</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="security.html#authentication-authorization">role-mapping</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A simple role mapping that can be used to map roles from external authentication providers (i.e. LDAP) to internal roles</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="security.html#authentication-authorization">role-mapping.from</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The external role which should be mapped</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="security.html#authentication-authorization">role-mapping.to</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The internal role which should be assigned to the authenticated user</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="broker-plugin-type"><a class="anchor" href="#broker-plugin-type"></a><a class="link" href="#broker-plugin-type">12. broker-plugin type</a></h2>
<div class="sectionbody">
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="broker-plugins.html#registering-a-plugin">property</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">properties to configure a plugin</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="broker-plugins.html#registering-a-plugin">class-name</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the name of the broker plugin class to instantiate</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="metrics-plugin-type"><a class="anchor" href="#metrics-plugin-type"></a><a class="link" href="#metrics-plugin-type">13. metrics-plugin type</a></h2>
<div class="sectionbody">
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="metrics.html#metrics">property</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">properties to configure a plugin</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="metrics.html#metrics">class-name</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the name of the metrics plugin class to instantiate</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="resource-limit-type"><a class="anchor" href="#resource-limit-type"></a><a class="link" href="#resource-limit-type">14. resource-limit type</a></h2>
<div class="sectionbody">
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="resource-limits.html#configuring-limits-via-resource-limit-settings">match</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the name of the user to whom the limits should be applied</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="resource-limits.html#configuring-limits-via-resource-limit-settings">max-connections</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how many connections are allowed by the matched user</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1 (no max)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="resource-limits.html#configuring-limits-via-resource-limit-settings">max-queues</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">how many queues can be created by the matched user</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1 (no max)</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="grouping-handler-type"><a class="anchor" href="#grouping-handler-type"></a><a class="link" href="#grouping-handler-type">15. grouping-handler type</a></h2>
<div class="sectionbody">
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="message-grouping.html#clustered-grouping">name</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A unique name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="message-grouping.html#clustered-grouping">type</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>LOCAL</code> or <code>REMOTE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="message-grouping.html#clustered-grouping">address</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A reference to a <code>cluster-connection</code> <code>address</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="message-grouping.html#clustered-grouping">timeout</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">How long to wait for a decision</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">5000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="message-grouping.html#clustered-grouping">group-timeout</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">How long a group binding will be used.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1 (disabled)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="message-grouping.html#clustered-grouping">reaper-period</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">How often the reaper will be run to check for timed out group bindings.
Only valid for <code>LOCAL</code> handlers.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">30000</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="amqp-connection-type"><a class="anchor" href="#amqp-connection-type"></a><a class="link" href="#amqp-connection-type">16. amqp-connection type</a></h2>
<div class="sectionbody">
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Name</th>
<th class="tableblock halign-left valign-top">Description</th>
<th class="tableblock halign-left valign-top">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="amqp-broker-connections.html#amqp-server-connections">uri</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">AMQP broker connection URI (required)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="amqp-broker-connections.html#amqp-server-connections">name</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">A unique name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="amqp-broker-connections.html#amqp-server-connections">user</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Broker authentication user (optional)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="amqp-broker-connections.html#amqp-server-connections">password</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Broker authentication password (optional)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="amqp-broker-connections.html#amqp-server-connections">reconnect-attempts</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">How many attempts should be made to reconnect after failure.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1 (infinite)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="amqp-broker-connections.html#amqp-server-connections">auto-start</a></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Broker connection starts automatically with broker</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</body>
</html>