Added: websites/production/activemq/content/artemis/docs/1.5.4/configuration-index.html ============================================================================== --- websites/production/activemq/content/artemis/docs/1.5.4/configuration-index.html (added) +++ websites/production/activemq/content/artemis/docs/1.5.4/configuration-index.html Sun Mar 12 16:08:18 2017 @@ -0,0 +1,1985 @@ + +<!DOCTYPE HTML> +<html lang="" > + <head> + <title>Configuration Reference · ActiveMQ Artemis Documentation</title> + <meta charset="UTF-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge" /> + <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + <meta name="description" content=""> + <meta name="generator" content="GitBook 3.1.1"> + + + + + <link rel="stylesheet" href="gitbook/style.css"> + + + + + <link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css"> + + + + <link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css"> + + + + <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css"> + + + + + + + + + + + + + + + + + + + + + + + + <meta name="HandheldFriendly" content="true"/> + <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"> + <meta name="apple-mobile-web-app-capable" content="yes"> + <meta name="apple-mobile-web-app-status-bar-style" content="black"> + <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png"> + <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon"> + + + + <link rel="prev" href="perf-tuning.html" /> + + + </head> + <body> + +<div class="book"> + <div class="book-summary"> + + +<div id="book-search-input" role="search"> + <input type="text" placeholder="Type to search" /> +</div> + + + <nav role="navigation"> + + + +<ul class="summary"> + + + + + + + + + + <li class="chapter " data-level="1.1" data-path="./"> + + <a href="./"> + + + Introduction + + </a> + + + + </li> + + <li class="chapter " data-level="1.2" data-path="notice.html"> + + <a href="notice.html"> + + + Legal Notice + + </a> + + + + </li> + + <li class="chapter " data-level="1.3" data-path="preface.html"> + + <a href="preface.html"> + + + Preface + + </a> + + + + </li> + + <li class="chapter " data-level="1.4" data-path="project-info.html"> + + <a href="project-info.html"> + + + Project Info + + </a> + + + + </li> + + <li class="chapter " data-level="1.5" data-path="messaging-concepts.html"> + + <a href="messaging-concepts.html"> + + + Messaging Concepts + + </a> + + + + </li> + + <li class="chapter " data-level="1.6" data-path="architecture.html"> + + <a href="architecture.html"> + + + Architecture + + </a> + + + + </li> + + <li class="chapter " data-level="1.7" data-path="using-server.html"> + + <a href="using-server.html"> + + + Using the Server + + </a> + + + + </li> + + <li class="chapter " data-level="1.8" data-path="using-jms.html"> + + <a href="using-jms.html"> + + + Using JMS + + </a> + + + + </li> + + <li class="chapter " data-level="1.9" data-path="using-core.html"> + + <a href="using-core.html"> + + + Using Core + + </a> + + + + </li> + + <li class="chapter " data-level="1.10" data-path="jms-core-mapping.html"> + + <a href="jms-core-mapping.html"> + + + Mapping JMS Concepts to the Core API + + </a> + + + + </li> + + <li class="chapter " data-level="1.11" data-path="client-classpath.html"> + + <a href="client-classpath.html"> + + + The Client Classpath + + </a> + + + + </li> + + <li class="chapter " data-level="1.12" data-path="examples.html"> + + <a href="examples.html"> + + + Examples + + </a> + + + + </li> + + <li class="chapter " data-level="1.13" data-path="wildcard-routing.html"> + + <a href="wildcard-routing.html"> + + + Routing Messages With Wild Cards + + </a> + + + + </li> + + <li class="chapter " data-level="1.14" data-path="wildcard-syntax.html"> + + <a href="wildcard-syntax.html"> + + + Understanding the Apache ActiveMQ Artemis Wildcard Syntax + + </a> + + + + </li> + + <li class="chapter " data-level="1.15" data-path="filter-expressions.html"> + + <a href="filter-expressions.html"> + + + Filter Expressions + + </a> + + + + </li> + + <li class="chapter " data-level="1.16" data-path="persistence.html"> + + <a href="persistence.html"> + + + Persistence + + </a> + + + + </li> + + <li class="chapter " data-level="1.17" data-path="configuring-transports.html"> + + <a href="configuring-transports.html"> + + + Configuring Transports + + </a> + + + + </li> + + <li class="chapter " data-level="1.18" data-path="config-reload.html"> + + <a href="config-reload.html"> + + + Configuration Reload + + </a> + + + + </li> + + <li class="chapter " data-level="1.19" data-path="connection-ttl.html"> + + <a href="connection-ttl.html"> + + + Detecting Dead Connections + + </a> + + + + </li> + + <li class="chapter " data-level="1.20" data-path="slow-consumers.html"> + + <a href="slow-consumers.html"> + + + Detecting Slow Consumers + + </a> + + + + </li> + + <li class="chapter " data-level="1.21" data-path="transaction-config.html"> + + <a href="transaction-config.html"> + + + Resource Manager Configuration + + </a> + + + + </li> + + <li class="chapter " data-level="1.22" data-path="flow-control.html"> + + <a href="flow-control.html"> + + + Flow Control + + </a> + + + + </li> + + <li class="chapter " data-level="1.23" data-path="send-guarantees.html"> + + <a href="send-guarantees.html"> + + + Guarantees of sends and commits + + </a> + + + + </li> + + <li class="chapter " data-level="1.24" data-path="undelivered-messages.html"> + + <a href="undelivered-messages.html"> + + + Message Redelivery and Undelivered Messages + + </a> + + + + </li> + + <li class="chapter " data-level="1.25" data-path="message-expiry.html"> + + <a href="message-expiry.html"> + + + Message Expiry + + </a> + + + + </li> + + <li class="chapter " data-level="1.26" data-path="large-messages.html"> + + <a href="large-messages.html"> + + + Large Messages + + </a> + + + + </li> + + <li class="chapter " data-level="1.27" data-path="paging.html"> + + <a href="paging.html"> + + + Paging + + </a> + + + + </li> + + <li class="chapter " data-level="1.28" data-path="queue-attributes.html"> + + <a href="queue-attributes.html"> + + + Queue Attributes + + </a> + + + + </li> + + <li class="chapter " data-level="1.29" data-path="scheduled-messages.html"> + + <a href="scheduled-messages.html"> + + + Scheduled Messages + + </a> + + + + </li> + + <li class="chapter " data-level="1.30" data-path="last-value-queues.html"> + + <a href="last-value-queues.html"> + + + Last-Value Queues + + </a> + + + + </li> + + <li class="chapter " data-level="1.31" data-path="message-grouping.html"> + + <a href="message-grouping.html"> + + + Message Grouping + + </a> + + + + </li> + + <li class="chapter " data-level="1.32" data-path="pre-acknowledge.html"> + + <a href="pre-acknowledge.html"> + + + Extra Acknowledge Modes + + </a> + + + + </li> + + <li class="chapter " data-level="1.33" data-path="management.html"> + + <a href="management.html"> + + + Management + + </a> + + + + </li> + + <li class="chapter " data-level="1.34" data-path="security.html"> + + <a href="security.html"> + + + Security + + </a> + + + + </li> + + <li class="chapter " data-level="1.35" data-path="resource-limits.html"> + + <a href="resource-limits.html"> + + + Resource Limits + + </a> + + + + </li> + + <li class="chapter " data-level="1.36" data-path="jms-bridge.html"> + + <a href="jms-bridge.html"> + + + The JMS Bridge + + </a> + + + + </li> + + <li class="chapter " data-level="1.37" data-path="client-reconnection.html"> + + <a href="client-reconnection.html"> + + + Client Reconnection and Session Reattachment + + </a> + + + + </li> + + <li class="chapter " data-level="1.38" data-path="diverts.html"> + + <a href="diverts.html"> + + + Diverting and Splitting Message Flows + + </a> + + + + </li> + + <li class="chapter " data-level="1.39" data-path="core-bridges.html"> + + <a href="core-bridges.html"> + + + Core Bridges + + </a> + + + + </li> + + <li class="chapter " data-level="1.40" data-path="duplicate-detection.html"> + + <a href="duplicate-detection.html"> + + + Duplicate Message Detection + + </a> + + + + </li> + + <li class="chapter " data-level="1.41" data-path="clusters.html"> + + <a href="clusters.html"> + + + Clusters + + </a> + + + + </li> + + <li class="chapter " data-level="1.42" data-path="ha.html"> + + <a href="ha.html"> + + + High Availability and Failover + + </a> + + + + </li> + + <li class="chapter " data-level="1.43" data-path="graceful-shutdown.html"> + + <a href="graceful-shutdown.html"> + + + Graceful Server Shutdown + + </a> + + + + </li> + + <li class="chapter " data-level="1.44" data-path="libaio.html"> + + <a href="libaio.html"> + + + Libaio Native Libraries + + </a> + + + + </li> + + <li class="chapter " data-level="1.45" data-path="thread-pooling.html"> + + <a href="thread-pooling.html"> + + + Thread management + + </a> + + + + </li> + + <li class="chapter " data-level="1.46" data-path="logging.html"> + + <a href="logging.html"> + + + Logging + + </a> + + + + </li> + + <li class="chapter " data-level="1.47" data-path="rest.html"> + + <a href="rest.html"> + + + REST Interface + + </a> + + + + </li> + + <li class="chapter " data-level="1.48" data-path="embedding-activemq.html"> + + <a href="embedding-activemq.html"> + + + Embedding Apache ActiveMQ Artemis + + </a> + + + + </li> + + <li class="chapter " data-level="1.49" data-path="karaf.html"> + + <a href="karaf.html"> + + + Apache Karaf + + </a> + + + + </li> + + <li class="chapter " data-level="1.50" data-path="spring-integration.html"> + + <a href="spring-integration.html"> + + + Spring Integration + + </a> + + + + </li> + + <li class="chapter " data-level="1.51" data-path="aerogear-integration.html"> + + <a href="aerogear-integration.html"> + + + AeroGear Integration + + </a> + + + + </li> + + <li class="chapter " data-level="1.52" data-path="vertx-integration.html"> + + <a href="vertx-integration.html"> + + + VertX Integration + + </a> + + + + </li> + + <li class="chapter " data-level="1.53" data-path="cdi-integration.html"> + + <a href="cdi-integration.html"> + + + CDI Integration + + </a> + + + + </li> + + <li class="chapter " data-level="1.54" data-path="intercepting-operations.html"> + + <a href="intercepting-operations.html"> + + + Intercepting Operations + + </a> + + + + </li> + + <li class="chapter " data-level="1.55" data-path="protocols-interoperability.html"> + + <a href="protocols-interoperability.html"> + + + Protocols and Interoperability + + </a> + + + + </li> + + <li class="chapter " data-level="1.56" data-path="tools.html"> + + <a href="tools.html"> + + + Tools + + </a> + + + + </li> + + <li class="chapter " data-level="1.57" data-path="maven-plugin.html"> + + <a href="maven-plugin.html"> + + + Maven Plugin + + </a> + + + + </li> + + <li class="chapter " data-level="1.58" data-path="unit-testing.html"> + + <a href="unit-testing.html"> + + + Unit Testing + + </a> + + + + </li> + + <li class="chapter " data-level="1.59" data-path="perf-tuning.html"> + + <a href="perf-tuning.html"> + + + Troubleshooting and Performance Tuning + + </a> + + + + </li> + + <li class="chapter active" data-level="1.60" data-path="configuration-index.html"> + + <a href="configuration-index.html"> + + + Configuration Reference + + </a> + + + + </li> + + + + + <li class="divider"></li> + + <li> + <a href="https://www.gitbook.com"; target="blank" class="gitbook-link"> + Published with GitBook + </a> + </li> +</ul> + + + </nav> + + + </div> + + <div class="book-body"> + + <div class="body-inner"> + + + +<div class="book-header" role="navigation"> + + + <!-- Title --> + <h1> + <i class="fa fa-circle-o-notch fa-spin"></i> + <a href="." >Configuration Reference</a> + </h1> +</div> + + + + + <div class="page-wrapper" tabindex="-1" role="main"> + <div class="page-inner"> + +<div id="book-search-results"> + <div class="search-noresults"> + + <section class="normal markdown-section"> + + <h1 id="configuration-reference">Configuration Reference</h1> +<p>This section is a quick index for looking up configuration. Click on the +element name to go to the specific chapter.</p> +<h1 id="server-configuration">Server Configuration</h1> +<h2 id="brokerxml">broker.xml</h2> +<p>This is the main core server configuration file which contains to elements +'core' and 'jms'. +The 'core' element contains the main server configuration while the 'jms' +element is used by the server side JMS service to load JMS Queues, Topics</p> +<h1 id="the-core-configuration">The core configuration</h1> +<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> +<table> +<thead> +<tr> +<th style="text-align:left">Name</th> +<th style="text-align:left">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td style="text-align:left"><a href="configuring-transports.html" title="Understanding Acceptors">acceptors</a></td> +<td style="text-align:left">a list of remoting acceptors</td> +</tr> +<tr> +<td style="text-align:left"><a href="configuring-transports.html" title="Understanding Acceptors">acceptors.acceptor</a></td> +<td style="text-align:left">Each acceptor is composed for just an URL</td> +</tr> +<tr> +<td style="text-align:left"><a href="queue-attributes.html" title="Configuring Queues Via Address Settings">address-settings</a></td> +<td style="text-align:left"><a href="#address-setting-type">a list of address-setting</a></td> +</tr> +<tr> +<td style="text-align:left"><a href="ha.html" title="Failing Back to live Server">allow-failback</a></td> +<td style="text-align:left">Should stop backup on live restart. default true</td> +</tr> +<tr> +<td style="text-align:left"><a href="connection-ttl.html" title="Configuring Asynchronous Connection Execution">async-connection-execution-enabled</a></td> +<td style="text-align:left">If False delivery would be always asynchronous. default true</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html" title="Configuring the bindings journal">bindings-directory</a></td> +<td style="text-align:left">The folder in use for the bindings folder</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">bridges</a></td> +<td style="text-align:left"><a href="#bridge-type">a list of bridge</a></td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">broadcast-groups</a></td> +<td style="text-align:left"><a href="#broadcast-group-type">a list of broadcast-group</a></td> +</tr> +<tr> +<td style="text-align:left"><a href="config-reload.html">configuration-file-refresh-period</a></td> +<td style="text-align:left">The frequency in milliseconds the configuration file is checked for changes (default 5000)</td> +</tr> +<tr> +<td style="text-align:left"><a href="ha.html">check-for-live-server</a></td> +<td style="text-align:left">Used for a live server to verify if there are other nodes with the same ID on the topology</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">cluster-connections</a></td> +<td style="text-align:left"><a href="#cluster-connection-type">a list of cluster-connection</a></td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">cluster-password</a></td> +<td style="text-align:left">Cluster password. It applies to all cluster configurations.</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">cluster-user</a></td> +<td style="text-align:left">Cluster username. It applies to all cluster configurations.</td> +</tr> +<tr> +<td style="text-align:left"><a href="connection-ttl.html">connection-ttl-override</a></td> +<td style="text-align:left">if set, this will override how long (in ms) to keep a connection alive without receiving a ping. -1 disables this setting. Default -1</td> +</tr> +<tr> +<td style="text-align:left"><a href="connection-ttl.html">connection-ttl-check-period</a></td> +<td style="text-align:left">how often (in ms) to check connections for ttl violation. Default 2000</td> +</tr> +<tr> +<td style="text-align:left"><a href="configuring-transports.html" title="Understanding Connectors">connectors.connector</a></td> +<td style="text-align:left">The URL for the connector. This is a list</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html" title="Configuring the bindings journal">create-bindings-dir</a></td> +<td style="text-align:left">true means that the server will create the bindings directory on start up. Default=true</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html">create-journal-dir</a></td> +<td style="text-align:left">true means that the journal directory will be created. Default=true</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">discovery-groups</a></td> +<td style="text-align:left"><a href="#discovery-group-type">a list of discovery-group</a></td> +</tr> +<tr> +<td style="text-align:left"><a href="paging.html#max-disk-usage">disk-scan-period</a></td> +<td style="text-align:left">The interval where the disk is scanned for percentual usage. Default=5000 ms.</td> +</tr> +<tr> +<td style="text-align:left"><a href="diverts.html" title="Diverting and Splitting Message Flows">diverts</a></td> +<td style="text-align:left"><a href="#divert-type">a list of diverts to use</a></td> +</tr> +<tr> +<td style="text-align:left"><a href="paging.html#global-max-size">global-max-size</a></td> +<td style="text-align:left">The amount in bytes before all addresses are considered full</td> +</tr> +<tr> +<td style="text-align:left"><a href="graceful-shutdown.html" title="Graceful Server Shutdown">graceful-shutdown-enabled</a></td> +<td style="text-align:left">true means that graceful shutdown is enabled. Default=true</td> +</tr> +<tr> +<td style="text-align:left"><a href="graceful-shutdown.html" title="Graceful Server Shutdown">graceful-shutdown-timeout</a></td> +<td style="text-align:left">Timeout on waitin for clients to disconnect before server shutdown. Default=-1</td> +</tr> +<tr> +<td style="text-align:left"><a href="message-grouping.html" title="Message Grouping">grouping-handler</a></td> +<td style="text-align:left">Message Group configuration</td> +</tr> +<tr> +<td style="text-align:left"><a href="duplicate-detection.html" title="Configuring the Duplicate ID Cache">id-cache-size</a></td> +<td style="text-align:left">The duplicate detection circular cache size. Default=20000</td> +</tr> +<tr> +<td style="text-align:left"><a href="management.html" title="Configuring JMX">jmx-domain</a></td> +<td style="text-align:left">the JMX domain used to registered MBeans in the MBeanServer. Default=org.apache.activemq</td> +</tr> +<tr> +<td style="text-align:left"><a href="management.html" title="Configuring JMX">jmx-management-enabled</a></td> +<td style="text-align:left">true means that the management API is available via JMX. Default=true</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html">journal-buffer-size</a></td> +<td style="text-align:left">The size of the internal buffer on the journal in KB. Default=490 KiB</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html">journal-buffer-timeout</a></td> +<td style="text-align:left">The Flush timeout for the journal buffer</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html">journal-compact-min-files</a></td> +<td style="text-align:left">The minimal number of data files before we can start compacting. Setting this to 0 means compacting is disabled. Default=10</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html">journal-compact-percentage</a></td> +<td style="text-align:left">The percentage of live data on which we consider compacting the journal. Default=30</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html">journal-directory</a></td> +<td style="text-align:left">the directory to store the journal files in. Default=data/journal</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html">journal-file-size</a></td> +<td style="text-align:left">the size (in bytes) of each journal file. Default=10485760 (10 MB)</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html#configuring.message.journal.journal-max-io">journal-max-io</a></td> +<td style="text-align:left">the maximum number of write requests that can be in the AIO queue at any one time. Default is 500 for AIO and 1 for NIO.</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html#configuring.message.journal.journal-min-files">journal-min-files</a></td> +<td style="text-align:left">how many journal files to pre-create. Default=2</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html#configuring.message.journal.journal-pool-files">journal-pool-files</a></td> +<td style="text-align:left">The upper theshold of the journal file pool,-1 (default) 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></td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html">journal-sync-non-transactional</a></td> +<td style="text-align:left">if true wait for non transaction data to be synced to the journal before returning response to client. Default=true</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html">journal-sync-transactional</a></td> +<td style="text-align:left">if true wait for transaction data to be synchronized to the journal before returning response to client. Default=true</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html">journal-type</a></td> +<td style="text-align:left">the type of journal to use. Default=ASYNCIO</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html">journal-datasync</a></td> +<td style="text-align:left">It will use fsync on journal operations. Default=true.</td> +</tr> +<tr> +<td style="text-align:left"><a href="large-messages.html" title="Configuring the server">large-messages-directory</a></td> +<td style="text-align:left">the directory to store large messages. Default=data/largemessages</td> +</tr> +<tr> +<td style="text-align:left"><a href="management.html" title="Configuring Core Management">management-address</a></td> +<td style="text-align:left">the name of the management address to send management messages to. It is prefixed with "jms.queue" so that JMS clients can send messages to it. Default=jms.queue.activemq.management</td> +</tr> +<tr> +<td style="text-align:left"><a href="management.html" title="Configuring The Core Management Notification Address">management-notification-address</a></td> +<td style="text-align:left">the name of the address that consumers bind to receive management notifications. Default=activemq.notifications</td> +</tr> +<tr> +<td style="text-align:left"><a href="configuration-index.html" title="Using Masked Passwords in Configuration Files">mask-password</a></td> +<td style="text-align:left">This option controls whether passwords in server configuration need be masked. If set to "true" the passwords are masked. Default=false</td> +</tr> +<tr> +<td style="text-align:left"><a href="ha.html#data-replication">max-saved-replicated-journals-size</a></td> +<td style="text-align:left">This specifies how many times a replicated backup server can restart after moving its files on start. Once there are this number of backup journal files the server will stop permanently after if fails back. -1 Means no Limit, 0 don't keep a copy at all, Default=2</td> +</tr> +<tr> +<td style="text-align:left"><a href="paging.html#max-disk-usage">max-disk-usage</a></td> +<td style="text-align:left">The max percentage of data we should use from disks. The System will block while the disk is full. Default=100</td> +</tr> +<tr> +<td style="text-align:left"><a href="perf-tuning.html">memory-measure-interval</a></td> +<td style="text-align:left">frequency to sample JVM memory in ms (or -1 to disable memory sampling). Default=-1</td> +</tr> +<tr> +<td style="text-align:left"><a href="perf-tuning.html">memory-warning-threshold</a></td> +<td style="text-align:left">Percentage of available memory which will trigger a warning log. Default=25</td> +</tr> +<tr> +<td style="text-align:left"><a href="management.html" title="Configuring Message Counters">message-counter-enabled</a></td> +<td style="text-align:left">true means that message counters are enabled. Default=false</td> +</tr> +<tr> +<td style="text-align:left"><a href="management.html" title="Configuring Message Counters">message-counter-max-day-history</a></td> +<td style="text-align:left">how many days to keep message counter history. Default=10 (days)</td> +</tr> +<tr> +<td style="text-align:left"><a href="management.html" title="Configuring Message Counters">message-counter-sample-period</a></td> +<td style="text-align:left">the sample period (in ms) to use for message counters. Default=10000</td> +</tr> +<tr> +<td style="text-align:left"><a href="message-expiry.html" title="Configuring The Expiry Reaper Thread">message-expiry-scan-period</a></td> +<td style="text-align:left">how often (in ms) to scan for expired messages. Default=30000</td> +</tr> +<tr> +<td style="text-align:left"><a href="message-expiry.html" title="Configuring The Expiry Reaper Thread">message-expiry-thread-priority</a></td> +<td style="text-align:left">the priority of the thread expiring messages. Default=3</td> +</tr> +<tr> +<td style="text-align:left"><a href="paging.html" title="Paging Mode">page-max-concurrent-io</a></td> +<td style="text-align:left">The max number of concurrent reads allowed on paging. Default=5</td> +</tr> +<tr> +<td style="text-align:left"><a href="paging.html" title="Configuration">paging-directory</a></td> +<td style="text-align:left">the directory to store paged messages in. Default=data/paging</td> +</tr> +<tr> +<td style="text-align:left"><a href="undelivered-messages.html" title="Delivery Count Persistence">persist-delivery-count-before-delivery</a></td> +<td style="text-align:left">True means that the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled. Default=false</td> +</tr> +<tr> +<td style="text-align:left"><a href="persistence.html" title="Configuring ActiveMQ Artemis for Zero Persistence">persistence-enabled</a></td> +<td style="text-align:left">true means that the server will use the file based journal for persistence. Default=true</td> +</tr> +<tr> +<td style="text-align:left"><a href="duplicate-detection.html" title="Configuring the Duplicate ID Cache">persist-id-cache</a></td> +<td style="text-align:left">true means that ID's are persisted to the journal. Default=true</td> +</tr> +<tr> +<td style="text-align:left"><a href="queue-attributes.html" title="Predefined Queues">queues</a></td> +<td style="text-align:left"><a href="#queue-type">a list of queue to be created</a></td> +</tr> +<tr> +<td style="text-align:left"><a href="intercepting-operations.html" title="Intercepting Operations">remoting-incoming-interceptors</a></td> +<td style="text-align:left">A list of interceptor</td> +</tr> +<tr> +<td style="text-align:left"><a href="">resolveProtocols</a></td> +<td style="text-align:left">Use <a href="http://docs.oracle.com/javase/tutorial/ext/basics/spi.html"; target="_blank">ServiceLoader</a> to load protocol modules. Default=true</td> +</tr> +<tr> +<td style="text-align:left"><a href="thread-pooling.html#server.scheduled.thread.pool" title="Server Scheduled Thread Pool">scheduled-thread-pool-max-size</a></td> +<td style="text-align:left">Maximum number of threads to use for the scheduled thread pool. Default=5</td> +</tr> +<tr> +<td style="text-align:left"><a href="security.html" title="Security">security-enabled</a></td> +<td style="text-align:left">true means that security is enabled. Default=true</td> +</tr> +<tr> +<td style="text-align:left"><a href="security.html" title="Security">security-invalidation-interval</a></td> +<td style="text-align:left">how long (in ms) to wait before invalidating the security cache. Default=10000</td> +</tr> +<tr> +<td style="text-align:left"><a href="security.html" title="Security">populate-validated-user</a></td> +<td style="text-align:left">whether or not to add the name of the validated user to the messages that user sends. Default=false</td> +</tr> +<tr> +<td style="text-align:left"><a href="security.html" title="Role based security for addresses">security-settings</a></td> +<td style="text-align:left"><a href="#security-setting-type">a list of security-setting</a></td> +</tr> +<tr> +<td style="text-align:left"><a href="thread-pooling.html" title="Server Scheduled Thread Pool">thread-pool-max-size</a></td> +<td style="text-align:left">Maximum number of threads to use for the thread pool. -1 means 'no limits'.. Default=30</td> +</tr> +<tr> +<td style="text-align:left"><a href="transaction-config.html" title="Resource Manager Configuration">transaction-timeout</a></td> +<td style="text-align:left">how long (in ms) before a transaction can be removed from the resource manager after create time. Default=300000</td> +</tr> +<tr> +<td style="text-align:left"><a href="transaction-config.html" title="Resource Manager Configuration">transaction-timeout-scan-period</a></td> +<td style="text-align:left">how often (in ms) to scan for timeout transactions. Default=1000</td> +</tr> +<tr> +<td style="text-align:left"><a href="wildcard-routing.html" title="Routing Messages With Wild Cards">wild-card-routing-enabled</a></td> +<td style="text-align:left">true means that the server supports wild card routing. Default=true</td> +</tr> +</tbody> +</table> +<h1 id="address-setting-type">address-setting type</h1> +<table> +<thead> +<tr> +<th style="text-align:left">Name</th> +<th style="text-align:left">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td style="text-align:left"><a href="queue-attributes.html" title="Configuring Queues Via Address Settings">match </a></td> +<td style="text-align:left">The filter to apply to the setting</td> +</tr> +<tr> +<td style="text-align:left"><a href="undelivered-messages.html" title="Configuring Dead Letter Addresses">dead-letter-address</a></td> +<td style="text-align:left">dead letter address</td> +</tr> +<tr> +<td style="text-align:left"><a href="message-expiry.html" title="Configuring Expiry Addresses">expiry-address</a></td> +<td style="text-align:left">expired messages address</td> +</tr> +<tr> +<td style="text-align:left"><a href="queue-attributes.html" title="Configuring Queues Via Address Settings">expiry-delay</a></td> +<td style="text-align:left">expiration time override, -1 don't override with default=-1</td> +</tr> +<tr> +<td style="text-align:left"><a href="undelivered-messages.html" title="Configuring Delayed Redelivery">redelivery-delay</a></td> +<td style="text-align:left">time to redeliver a message (in ms) with default=0</td> +</tr> +<tr> +<td style="text-align:left"><a href="queue-attributes.html" title="Configuring Queues Via Address Settings">redelivery-delay-multiplier</a></td> +<td style="text-align:left">multiplier to apply to the "redelivery-delay"</td> +</tr> +<tr> +<td style="text-align:left"><a href="queue-attributes.html" title="Configuring Queues Via Address Settings">max-redelivery-delay</a></td> +<td style="text-align:left">Max value for the redelivery-delay</td> +</tr> +<tr> +<td style="text-align:left"><a href="undelivered-messages.html" title="Configuring Dead Letter Addresses">max-delivery-attempts</a></td> +<td style="text-align:left">Number of retries before dead letter address, default=10</td> +</tr> +<tr> +<td style="text-align:left"><a href="paging.html" title="Paging">max-size-bytes</a></td> +<td style="text-align:left">Limit before paging. -1 = infinite</td> +</tr> +<tr> +<td style="text-align:left"><a href="paging.html" title="Paging">page-size-bytes</a></td> +<td style="text-align:left">Size of each file on page, default=10485760</td> +</tr> +<tr> +<td style="text-align:left"><a href="paging.html" title="Paging">page-max-cache-size</a></td> +<td style="text-align:left">Maximum number of files cached from paging default=5</td> +</tr> +<tr> +<td style="text-align:left"><a href="queue-attributes.html" title="Configuring Queues Via Address Settings">address-full-policy</a></td> +<td style="text-align:left">Model to chose after queue full</td> +</tr> +<tr> +<td style="text-align:left"><a href="queue-attributes.html" title="Configuring Queues Via Address Settings">message-counter-history-day-limit</a></td> +<td style="text-align:left">Days to keep in history</td> +</tr> +<tr> +<td style="text-align:left"><a href="last-value-queues.html" title="Last-Value Queues">last-value-queue</a></td> +<td style="text-align:left">Queue is a last value queue, default=false</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">redistribution-delay</a></td> +<td style="text-align:left">Timeout before redistributing values after no consumers. default=-1</td> +</tr> +<tr> +<td style="text-align:left"><a href="queue-attributes.html" title="Configuring Queues Via Address Settings">send-to-dla-on-no-route</a></td> +<td style="text-align:left">Forward messages to DLA when no queues subscribing. default=false</td> +</tr> +</tbody> +</table> +<h1 id="bridge-type">bridge type</h1> +<table> +<thead> +<tr> +<th style="text-align:left">Name</th> +<th style="text-align:left">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">name </a></td> +<td style="text-align:left">unique name</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">queue-name</a></td> +<td style="text-align:left">name of queue that this bridge consumes from</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">forwarding-address</a></td> +<td style="text-align:left">address to forward to. If omitted original address is used</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">ha</a></td> +<td style="text-align:left">whether this bridge supports fail-over</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">filter</a></td> +<td style="text-align:left">optional core filter expression</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">transformer-class-name</a></td> +<td style="text-align:left">optional name of transformer class</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">min-large-message-size</a></td> +<td style="text-align:left">Limit before message is considered large. default 100KB</td> +</tr> +<tr> +<td style="text-align:left"><a href="connection-ttl.html" title="Detecting Dead Connections">check-period</a></td> +<td style="text-align:left"><a href="http://en.wikipedia.org/wiki/Time_to_live"; title="Time to Live" target="_blank">TTL</a> check period for the bridge. -1 means disabled. default 30000 (ms)</td> +</tr> +<tr> +<td style="text-align:left"><a href="connection-ttl.html" title="Detecting Dead Connections">connection-ttl</a></td> +<td style="text-align:left"><a href="http://en.wikipedia.org/wiki/Time_to_live"; title="Time to Live" target="_blank">TTL</a> for the Bridge. This should be greater than the ping period. default 60000 (ms)</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">retry-interval</a></td> +<td style="text-align:left">period (in ms) between successive retries. default 2000</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">retry-interval-multiplier</a></td> +<td style="text-align:left">multiplier to apply to successive retry intervals. default 1</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">max-retry-interval</a></td> +<td style="text-align:left">Limit to the retry-interval growth. default 2000</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">reconnect-attempts</a></td> +<td style="text-align:left">maximum number of retry attempts, -1 means 'no limits'. default -1</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">use-duplicate-detection</a></td> +<td style="text-align:left">forward duplicate detection headers?. default true</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">confirmation-window-size</a></td> +<td style="text-align:left">number of bytes before confirmations are sent. default 1MB</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">producer-window-size</a></td> +<td style="text-align:left">Producer flow control size on the bridge. Default -1 (disabled)</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">user</a></td> +<td style="text-align:left">Username for the bridge, the default is the cluster username</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">password</a></td> +<td style="text-align:left">Password for the bridge, default is the cluster password</td> +</tr> +<tr> +<td style="text-align:left"><a href="core-bridges.html" title="Core Bridges">reconnect-attempts-same-node</a></td> +<td style="text-align:left">Number of retries before trying another node. default 10</td> +</tr> +</tbody> +</table> +<h1 id="broadcast-group-type">broadcast-group type</h1> +<table> +<thead> +<tr> +<th style="text-align:left">Name</th> +<th style="text-align:left">Type</th> +</tr> +</thead> +<tbody> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">name </a></td> +<td style="text-align:left">unique name</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">local-bind-address</a></td> +<td style="text-align:left">local bind address that the datagram socket is bound to</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">local-bind-port</a></td> +<td style="text-align:left">local port to which the datagram socket is bound to</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">group-address</a></td> +<td style="text-align:left">multicast address to which the data will be broadcast</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">group-port</a></td> +<td style="text-align:left">UDP port number used for broadcasting</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">broadcast-period</a></td> +<td style="text-align:left">period in milliseconds between consecutive broadcasts. default 2000</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html">jgroups-file</a></td> +<td style="text-align:left">Name of JGroups configuration file</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html">jgroups-channel</a></td> +<td style="text-align:left">Name of JGroups Channel</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">connector-ref</a></td> +<td style="text-align:left"></td> +</tr> +</tbody> +</table> +<h1 id="cluster-connection-type">cluster-connection type</h1> +<table> +<thead> +<tr> +<th style="text-align:left">Name</th> +<th style="text-align:left">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">name</a></td> +<td style="text-align:left">unique name</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">address</a></td> +<td style="text-align:left">name of the address this cluster connection applies to</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">connector-ref</a></td> +<td style="text-align:left">Name of the connector reference to use.</td> +</tr> +<tr> +<td style="text-align:left"><a href="connection-ttl.html" title="Detecting Dead Connections">check-period</a></td> +<td style="text-align:left">The period (in milliseconds) used to check if the cluster connection has failed to receive pings from another server with default = 30000</td> +</tr> +<tr> +<td style="text-align:left"><a href="connection-ttl.html" title="Detecting Dead Connections">connection-ttl</a></td> +<td style="text-align:left">Timeout for TTL. Default 60000</td> +</tr> +<tr> +<td style="text-align:left"><a href="large-messages.html" title="Large Messages">min-large-message-size</a></td> +<td style="text-align:left">Messages larger than this are considered large-messages, default=100KB</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">call-timeout</a></td> +<td style="text-align:left">Time(ms) before giving up on blocked calls. Default=30000</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">retry-interval</a></td> +<td style="text-align:left">period (in ms) between successive retries. Default=500</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">retry-interval-multiplier</a></td> +<td style="text-align:left">multiplier to apply to the retry-interval. Default=1</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">max-retry-interval</a></td> +<td style="text-align:left">Maximum value for retry-interval. Default=2000</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">reconnect-attempts</a></td> +<td style="text-align:left">How many attempts should be made to reconnect after failure. Default=-1</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">use-duplicate-detection</a></td> +<td style="text-align:left">should duplicate detection headers be inserted in forwarded messages?. Default=true</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">message-load-balancing</a></td> +<td style="text-align:left">how should messages be load balanced? Default=OFF</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">max-hops</a></td> +<td style="text-align:left">maximum number of hops cluster topology is propagated. Default=1</td> +</tr> +<tr> +<td style="text-align:left"><a href="client-reconnection.html" title="Client Reconnection and Session Reattachment">confirmation-window-size</a></td> +<td style="text-align:left">The size (in bytes) of the window used for confirming data from the server connected to. Default 1048576</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">producer-window-size</a></td> +<td style="text-align:left">Flow Control for the Cluster connection bridge. Default -1 (disabled)</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Configuring Cluster Connections">call-failover-timeout</a></td> +<td style="text-align:left">How long to wait for a reply if in the middle of a fail-over. -1 means wait forever. Default -1</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">notification-interval</a></td> +<td style="text-align:left">how often the cluster connection will notify the cluster of its existence right after joining the cluster. Default 1000</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">notification-attempts</a></td> +<td style="text-align:left">how many times this cluster connection will notify the cluster of its existence right after joining the cluster Default 2</td> +</tr> +</tbody> +</table> +<h1 id="discovery-group-type">discovery-group type</h1> +<table> +<thead> +<tr> +<th style="text-align:left">Name</th> +<th style="text-align:left">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">name</a></td> +<td style="text-align:left">unique name</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">group-address</a></td> +<td style="text-align:left">Multicast IP address of the group to listen on</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">group-port</a></td> +<td style="text-align:left">UDP port number of the multi cast group</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html">jgroups-file</a></td> +<td style="text-align:left">Name of a JGroups configuration file. If specified, the server uses JGroups for discovery.</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html">jgroups-channel</a></td> +<td style="text-align:left">Name of a JGroups Channel. If specified, the server uses the named channel for discovery.</td> +</tr> +<tr> +<td style="text-align:left"><a href="">refresh-timeout</a></td> +<td style="text-align:left">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</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">local-bind-address</a></td> +<td style="text-align:left">local bind address that the datagram socket is bound to</td> +</tr> +<tr> +<td style="text-align:left"><a href="clusters.html" title="Clusters">local-bind-port</a></td> +<td style="text-align:left">local port to which the datagram socket is bound to. Default=-1</td> +</tr> +<tr> +<td style="text-align:left"><a href="">initial-wait-timeout</a></td> +<td style="text-align:left">time to wait for an initial broadcast to give us at least one node in the cluster. Default=10000</td> +</tr> +</tbody> +</table> +<h1 id="divert-type">divert type</h1> +<table> +<thead> +<tr> +<th style="text-align:left">Name</th> +<th style="text-align:left">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td style="text-align:left"><a href="diverts.html" title="Diverting and Splitting Message Flows">name</a></td> +<td style="text-align:left">unique name</td> +</tr> +<tr> +<td style="text-align:left"><a href="diverts.html" title="Diverting and Splitting Message Flows">transformer-class-name</a></td> +<td style="text-align:left">an optional class name of a transformer</td> +</tr> +<tr> +<td style="text-align:left"><a href="diverts.html" title="Diverting and Splitting Message Flows">exclusive</a></td> +<td style="text-align:left">whether this is an exclusive divert. Default=false</td> +</tr> +<tr> +<td style="text-align:left"><a href="diverts.html" title="Diverting and Splitting Message Flows">routing-name</a></td> +<td style="text-align:left">the routing name for the divert</td> +</tr> +<tr> +<td style="text-align:left"><a href="diverts.html" title="Diverting and Splitting Message Flows">address</a></td> +<td style="text-align:left">the address this divert will divert from</td> +</tr> +<tr> +<td style="text-align:left"><a href="diverts.html" title="Diverting and Splitting Message Flows">forwarding-address</a></td> +<td style="text-align:left">the forwarding address for the divert</td> +</tr> +<tr> +<td style="text-align:left"><a href="diverts.html" title="Diverting and Splitting Message Flows">filter</a></td> +<td style="text-align:left">optional core filter expression</td> +</tr> +</tbody> +</table> +<h1 id="queue-type">queue type</h1> +<table> +<thead> +<tr> +<th style="text-align:left">Name</th> +<th style="text-align:left">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td style="text-align:left"><a href="queue-attributes.html" title="Predefined Queues">name </a></td> +<td style="text-align:left">unique name</td> +</tr> +<tr> +<td style="text-align:left"><a href="queue-attributes.html" title="Predefined Queues">address</a></td> +<td style="text-align:left">address for the queue</td> +</tr> +<tr> +<td style="text-align:left"><a href="queue-attributes.html" title="Predefined Queues">filter</a></td> +<td style="text-align:left">optional core filter expression</td> +</tr> +<tr> +<td style="text-align:left"><a href="queue-attributes.html" title="Predefined Queues">durable</a></td> +<td style="text-align:left">whether the queue is durable (persistent). Default=true</td> +</tr> +</tbody> +</table> +<h1 id="security-setting-type">security-setting type</h1> +<table> +<thead> +<tr> +<th style="text-align:left">Name</th> +<th style="text-align:left">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td style="text-align:left"><a href="security.html" title="Role based security for addresses">match </a></td> +<td style="text-align:left"><a href="wildcard-syntax.html">address expression</a></td> +</tr> +<tr> +<td style="text-align:left"><a href="security.html" title="Role based security for addresses">permission</a></td> +<td style="text-align:left"></td> +</tr> +<tr> +<td style="text-align:left"><a href="security.html" title="Role based security for addresses">permission.type </a></td> +<td style="text-align:left">the type of permission</td> +</tr> +<tr> +<td style="text-align:left"><a href="security.html" title="Role based security for addresses">permission.roles </a></td> +<td style="text-align:left">a comma-separated list of roles to apply the permission to</td> +</tr> +</tbody> +</table> +<hr> +<h2 id="the-jms-configuration">The jms configuration</h2> +<table> +<thead> +<tr> +<th style="text-align:left">Name</th> +<th style="text-align:left">Type</th> +<th style="text-align:left">Description</th> +</tr> +</thead> +<tbody> +<tr> +<td style="text-align:left"><a href="using-jms.html" title="JMS Server Configuration">queue</a></td> +<td style="text-align:left">Queue</td> +<td style="text-align:left">a queue</td> +</tr> +<tr> +<td style="text-align:left"><a href="using-jms.html" title="JMS Server Configuration">queue.name (attribute)</a></td> +<td style="text-align:left">String</td> +<td style="text-align:left">unique name of the queue</td> +</tr> +<tr> +<td style="text-align:left"><a href="using-jms.html" title="JMS Server Configuration">queue.durable</a></td> +<td style="text-align:left">Boolean</td> +<td style="text-align:left">is the queue durable?. Default=true</td> +</tr> +<tr> +<td style="text-align:left"><a href="using-jms.html" title="JMS Server Configuration">queue.filter</a></td> +<td style="text-align:left">String</td> +<td style="text-align:left">optional filter expression for the queue</td> +</tr> +<tr> +<td style="text-align:left"><a href="using-jms.html" title="JMS Server Configuration">topic</a></td> +<td style="text-align:left">Topic</td> +<td style="text-align:left">a topic</td> +</tr> +<tr> +<td style="text-align:left"><a href="using-jms.html" title="JMS Server Configuration">topic.name (attribute)</a></td> +<td style="text-align:left">String</td> +<td style="text-align:left">unique name of the topic</td> +</tr> +</tbody> +</table> +<h2 id="using-masked-passwords-in-configuration-files">Using Masked Passwords in Configuration Files</h2> +<p>By default all passwords in Apache ActiveMQ Artemis server's configuration files are in +plain text form. This usually poses no security issues as those files +should be well protected from unauthorized accessing. However, in some +circumstances a user doesn't want to expose its passwords to more eyes +than necessary.</p> +<p>Apache ActiveMQ Artemis can be configured to use 'masked' passwords in its +configuration files. A masked password is an obscure string +representation of a real password. To mask a password a user will use an +'encoder'. The encoder takes in the real password and outputs the masked +version. A user can then replace the real password in the configuration +files with the new masked password. When Apache ActiveMQ Artemis loads a masked +password, it uses a suitable 'decoder' to decode it into real password.</p> +<p>Apache ActiveMQ Artemis provides a default password encoder and decoder. Optionally +users can use or implement their own encoder and decoder for masking the +passwords.</p> +<h3 id="password-masking-in-server-configuration-file">Password Masking in Server Configuration File</h3> +<h4 id="the-password-masking-property">The password masking property</h4> +<p>The server configuration file has a property that defines the default +masking behaviors over the entire file scope.</p> +<p><code>mask-password</code>: this boolean type property indicates if a password +should be masked or not. Set it to "true" if you want your passwords +masked. The default value is "false".</p> +<h4 id="specific-masking-behaviors">Specific masking behaviors</h4> +<h5 id="cluster-password">cluster-password</h5> +<p>The nature of the value of cluster-password is subject to the value of +property 'mask-password'. If it is true the cluster-password is masked.</p> +<h5 id="passwords-in-connectors-and-acceptors">Passwords in connectors and acceptors</h5> +<p>In the server configuration, Connectors and Acceptors sometimes needs to +specify passwords. For example if a users wants to use an SSL-enabled +NettyAcceptor, it can specify a key-store-password and a +trust-store-password. Because Acceptors and Connectors are pluggable +implementations, each transport will have different password masking +needs.</p> +<p>When a Connector or Acceptor configuration is initialised, Apache ActiveMQ Artemis will +add the "mask-password" and "password-codec" values to the Connector or +Acceptors params using the keys <code>activemq.usemaskedpassword</code> and +<code>activemq.passwordcodec</code> respectively. The Netty and InVM +implementations will use these as needed and any other implementations +will have access to these to use if they so wish.</p> +<h5 id="passwords-in-core-bridge-configurations">Passwords in Core Bridge configurations</h5> +<p>Core Bridges are configured in the server configuration file and so the +masking of its 'password' properties follows the same rules as that of +'cluster-password'.</p> +<h4 id="examples">Examples</h4> +<p>The following table summarizes the relations among the above-mentioned +properties</p> +<table> +<thead> +<tr> +<th style="text-align:left">mask-password</th> +<th style="text-align:left">cluster-password</th> +<th style="text-align:left">acceptor/connector passwords</th> +<th style="text-align:left">bridge password</th> +</tr> +</thead> +<tbody> +<tr> +<td style="text-align:left"> absent</td> +<td style="text-align:left">plain text</td> +<td style="text-align:left">plain text</td> +<td style="text-align:left">plain text</td> +</tr> +<tr> +<td style="text-align:left"> false</td> +<td style="text-align:left">plain text</td> +<td style="text-align:left">plain text</td> +<td style="text-align:left">plain text</td> +</tr> +<tr> +<td style="text-align:left"> true</td> +<td style="text-align:left">masked</td> +<td style="text-align:left">masked</td> +<td style="text-align:left">masked</td> +</tr> +</tbody> +</table> +<p>Examples</p> +<p>Note: In the following examples if related attributed or properties are +absent, it means they are not specified in the configure file.</p> +<p>example 1</p> +<pre><code class="lang-xml"><span class="hljs-tag"><<span class="hljs-name">cluster-password</span>></span>bbc<span class="hljs-tag"></<span class="hljs-name">cluster-password</span>></span> +</code></pre> +<p>This indicates the cluster password is a plain text value ("bbc").</p> +<p>example 2</p> +<pre><code class="lang-xml"><span class="hljs-tag"><<span class="hljs-name">mask-password</span>></span>true<span class="hljs-tag"></<span class="hljs-name">mask-password</span>></span> +<span class="hljs-tag"><<span class="hljs-name">cluster-password</span>></span>80cf731af62c290<span class="hljs-tag"></<span class="hljs-name">cluster-password</span>></span> +</code></pre> +<p>This indicates the cluster password is a masked value and Apache ActiveMQ Artemis will +use its built-in decoder to decode it. All other passwords in the +configuration file, Connectors, Acceptors and Bridges, will also use +masked passwords.</p> +<h3 id="jms-bridge-password-masking">JMS Bridge password masking</h3> +<p>The JMS Bridges are configured and deployed as separate beans so they +need separate configuration to control the password masking. A JMS +Bridge has two password parameters in its constructor, SourcePassword +and TargetPassword. It uses the following two optional properties to +control their masking:</p> +<p><code>useMaskedPassword</code> -- If set to "true" the passwords are masked. +Default is false.</p> +<p><code>passwordCodec</code> -- Class name and its parameters for the Decoder used to +decode the masked password. Ignored if <code>useMaskedPassword</code> is false. The +format of this property is a full qualified class name optionally +followed by key/value pairs, separated by semi-colons. For example:</p> +<pre><code class="lang-xml"><span class="hljs-tag"><<span class="hljs-name">property</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"useMaskedPassword"</span>></span>true<span class="hljs-tag"></<span class="hljs-name">property</span>></span> +<span class="hljs-tag"><<span class="hljs-name">property</span> <span class="hljs-attr">name</span>=<span class="hljs-string">"passwordCodec"</span>></span>com.foo.FooDecoder;key=value<span class="hljs-tag"></<span class="hljs-name">property</span>></span> +</code></pre> +<p>Apache ActiveMQ Artemis will load this property and initialize the class with a +parameter map containing the "key"->"value" pair. If <code>passwordCodec</code> is +not specified, the built-in decoder is used.</p> +<h3 id="masking-passwords-in-activemq-artemis-resourceadapters-and-mdb-activation-configurations">Masking passwords in ActiveMQ Artemis ResourceAdapters and MDB activation configurations</h3> +<p>Both ra.xml and MDB activation configuration have a 'password' property +that can be masked. They are controlled by the following two optional +Resource Adapter properties in ra.xml:</p> +<p><code>UseMaskedPassword</code> -- If setting to "true" the passwords are masked. +Default is false.</p> +<p><code>PasswordCodec</code> -- Class name and its parameters for the Decoder used to +decode the masked password. Ignored if UseMaskedPassword is false. The +format of this property is a full qualified class name optionally +followed by key/value pairs. It is the same format as that for JMS +Bridges. Example:</p> +<pre><code class="lang-xml"><span class="hljs-tag"><<span class="hljs-name">config-property</span>></span> + <span class="hljs-tag"><<span class="hljs-name">config-property-name</span>></span>UseMaskedPassword<span class="hljs-tag"></<span class="hljs-name">config-property-name</span>></span> + <span class="hljs-tag"><<span class="hljs-name">config-property-type</span>></span>boolean<span class="hljs-tag"></<span class="hljs-name">config-property-type</span>></span> + <span class="hljs-tag"><<span class="hljs-name">config-property-value</span>></span>true<span class="hljs-tag"></<span class="hljs-name">config-property-value</span>></span> +<span class="hljs-tag"></<span class="hljs-name">config-property</span>></span> +<span class="hljs-tag"><<span class="hljs-name">config-property</span>></span> + <span class="hljs-tag"><<span class="hljs-name">config-property-name</span>></span>PasswordCodec<span class="hljs-tag"></<span class="hljs-name">config-property-name</span>></span> + <span class="hljs-tag"><<span class="hljs-name">config-property-type</span>></span>java.lang.String<span class="hljs-tag"></<span class="hljs-name">config-property-type</span>></span> + <span class="hljs-tag"><<span class="hljs-name">config-property-value</span>></span>com.foo.ADecoder;key=helloworld<span class="hljs-tag"></<span class="hljs-name">config-property-value</span>></span> +<span class="hljs-tag"></<span class="hljs-name">config-property</span>></span> +</code></pre> +<p>With this configuration, both passwords in ra.xml and all of its MDBs +will have to be in masked form.</p> +<h3 id="masking-passwords-in-artemis-usersproperties">Masking passwords in artemis-users.properties</h3> +<p>Apache ActiveMQ Artemis's built-in security manager uses plain properties files +where the user passwords are specified in hash forms by default. </p> +<p>Please use Artemis CLI command to add a password. For example</p> +<pre><code class="lang-sh"> ./artemis user add --username guest --password guest --role admin +</code></pre> +<h3 id="choosing-a-decoder-for-password-masking">Choosing a decoder for password masking</h3> +<p>As described in the previous sections, all password masking requires a +decoder. A decoder uses an algorithm to convert a masked password into +its original clear text form in order to be used in various security +operations. The algorithm used for decoding must match that for +encoding. Otherwise the decoding may not be successful.</p> +<p>For user's convenience Apache ActiveMQ Artemis provides a default built-in Decoder. +However a user can if they so wish implement their own.</p> +<h4 id="the-built-in-decoder">The built-in Decoder</h4> +<p>Whenever no decoder is specified in the configuration file, the built-in +decoder is used. The class name for the built-in decoder is +org.apache.activemq.artemis.utils.DefaultSensitiveStringCodec. It has both +encoding and decoding capabilities. It uses java.crypto.Cipher utilities +to encrypt (encode) a plaintext password and decrypt a mask string using +same algorithm. Using this decoder/encoder is pretty straightforward. To +get a mask for a password, just run the main class at org.apache.activemq.artemis.utils.DefaultSensitiveStringCodec.</p> +<p>An easy way to do it is through activemq-tools-<version>-jar-with-dependencies.jar since it has all the dependencies:</version></p> +<pre><code class="lang-sh"> java -cp artemis-tools-1.0.0-jar-with-dependencies.jar org.apache.activemq.artemis.utils.DefaultSensitiveStringCodec <span class="hljs-string">"your plaintext password"</span> +</code></pre> +<p>If you don't want to use the jar-with-dependencies, make sure the classpath is correct. You'll get something like</p> +<pre><code> Encoded password: 80cf731af62c290 +</code></pre><p>Just copy "80cf731af62c290" and replace your plaintext password with it.</p> +<h4 id="using-a-different-decoder">Using a different decoder</h4> +<p>It is possible to use a different decoder rather than the built-in one. +Simply make sure the decoder is in Apache ActiveMQ Artemis's classpath and configure +the server to use it as follows:</p> +<pre><code class="lang-xml"> <span class="hljs-tag"><<span class="hljs-name">password-codec</span>></span>com.foo.SomeDecoder;key1=value1;key2=value2<span class="hljs-tag"></<span class="hljs-name">password-codec</span>></span> +</code></pre> +<p>If your decoder needs params passed to it you can do this via key/value +pairs when configuring. For instance if your decoder needs say a +"key-location" parameter, you can define like so:</p> +<pre><code class="lang-xml"> <span class="hljs-tag"><<span class="hljs-name">password-codec</span>></span>com.foo.NewDecoder;key-location=/some/url/to/keyfile<span class="hljs-tag"></<span class="hljs-name">password-codec</span>></span> +</code></pre> +<p>Then configure your cluster-password like this:</p> +<pre><code class="lang-xml"> <span class="hljs-tag"><<span class="hljs-name">mask-password</span>></span>true<span class="hljs-tag"></<span class="hljs-name">mask-password</span>></span> + <span class="hljs-tag"><<span class="hljs-name">cluster-password</span>></span>masked_password<span class="hljs-tag"></<span class="hljs-name">cluster-password</span>></span> +</code></pre> +<p>When Apache ActiveMQ Artemis reads the cluster-password it will initialize the +NewDecoder and use it to decode "mask_password". It also process all +passwords using the new defined decoder.</p> +<h4 id="implementing-your-own-codecs">Implementing your own codecs</h4> +<p>To use a different decoder than the built-in one, you either pick one +from existing libraries or you implement it yourself. All decoders must +implement the <code>org.apache.activemq.artemis.utils.SensitiveDataCodec<T></code> +interface:</p> +<pre><code class="lang-java"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">interface</span> <span class="hljs-title">SensitiveDataCodec</span><<span class="hljs-title">T</span>> +</span>{ + <span class="hljs-function">T <span class="hljs-title">decode</span><span class="hljs-params">(Object mask)</span> <span class="hljs-keyword">throws</span> Exception</span>; + + <span class="hljs-function"><span class="hljs-keyword">void</span> <span class="hljs-title">init</span><span class="hljs-params">(Map<String, String> params)</span></span>; +} +</code></pre> +<p>This is a generic type interface but normally for a password you just +need String type. So a new decoder would be defined like</p> +<pre><code class="lang-java"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyNewDecoder</span> <span class="hljs-keyword">implements</span> <span class="hljs-title">SensitiveDataCodec</span><<span class="hljs-title">String</span>> +</span>{ + <span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">decode</span><span class="hljs-params">(Object mask)</span> <span class="hljs-keyword">throws</span> Exception + </span>{ + <span class="hljs-comment">//decode the mask into clear text password</span> + <span class="hljs-keyword">return</span> <span class="hljs-string">"the password"</span>; + } + + <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">init</span><span class="hljs-params">(Map<String, String> params)</span> + </span>{ + <span class="hljs-comment">//initialization done here. It is called right after the decoder has been created.</span> + } +} +</code></pre> +<p>Last but not least, once you get your own decoder, please add it to the +classpath. Otherwise Apache ActiveMQ Artemis will fail to load it!</p> + + + </section> + + </div> + <div class="search-results"> + <div class="has-results"> + + <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1> + <ul class="search-results-list"></ul> + + </div> + <div class="no-results"> + + <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> + + </div> + </div> +</div> + + </div> + </div> + + </div> + + + + <a href="perf-tuning.html" class="navigation navigation-prev navigation-unique" aria-label="Previous page: Troubleshooting and Performance Tuning"> + <i class="fa fa-angle-left"></i> + </a> + + + + + </div> + + <script> + var gitbook = gitbook || []; + gitbook.push(function() { + gitbook.page.hasChanged({"page":{"title":"Configuration Reference","level":"1.60","depth":1,"previous":{"title":"Troubleshooting and Performance Tuning","level":"1.59","depth":1,"path":"perf-tuning.md","ref":"perf-tuning.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"github":"apache/activemq-artemis","the me":"default","githubHost":"https://github.com/","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"ActiveMQ Artemis Documentation","links":{"home":"http://activemq.apache.org/","issues":"http://activemq.apache.org/","contribute":"http://activemq.apache.org/contributing.html"},"gitbook":"3.x.x","description":"ActiveMQ Artemis User Guide and Reference Documentation"},"file":{"path":"configuration-index.md","mtime":"2016-11-12T00:49:50.000Z","type":"markdown"},"gitbook":{"version":"3.1.1","time":"2016-11-12T01:00:04.718Z"},"basePath":".","book":{"language":""}}); + }); + </script> +</div> + + + <script src="gitbook/gitbook.js"></script> + <script src="gitbook/theme.js"></script> + + + <script src="gitbook/gitbook-plugin-search/search-engine.js"></script> + + + + <script src="gitbook/gitbook-plugin-search/search.js"></script> + + + + <script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script> + + + + <script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script> + + + + <script src="gitbook/gitbook-plugin-sharing/buttons.js"></script> + + + + <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script> + + + + </body> +</html> +
