http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/40b66d13/docs/user-manual/en/config-reload.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/config-reload.md b/docs/user-manual/en/config-reload.md index 1ba7685..630a13d 100644 --- a/docs/user-manual/en/config-reload.md +++ b/docs/user-manual/en/config-reload.md @@ -1,8 +1,11 @@ # Configuration Reload -The system will perform a periodic check on the configuration files, configured by `configuration-file-refresh-period`, with the default at 5000, in milliseconds. +The system will perform a periodic check on the configuration files, configured +by `configuration-file-refresh-period`, with the default at 5000, in +milliseconds. -Once the configuration file is changed (broker.xml) the following modules will be reloaded automatically: +Once the configuration file is changed (broker.xml) the following modules will +be reloaded automatically: - Address Settings - Security Settings @@ -10,7 +13,7 @@ Once the configuration file is changed (broker.xml) the following modules will b - Addresses & queues -Notice: +**Note:** Deletion of Address's and Queue's, not auto created is controlled by Address Settings @@ -23,50 +26,63 @@ Deletion of Address's and Queue's, not auto created is controlled by Address Set * FORCE - will remove the queue upon config reload, even if messages remains, losing the messages in the queue. -By default both settings are OFF as such address & queues won't be removed upon reload, given the risk of losing messages. +By default both settings are OFF as such address & queues won't be removed upon +reload, given the risk of losing messages. -When OFF You may execute explicit CLI or Management operations to remove address & queues. +When OFF You may execute explicit CLI or Management operations to remove +address & queues. ## Reloadable Parameters -The broker configuration file has 2 main parts, `<core>` and `<jms>`. Some of the parameters in the 2 parts are monitored and, -if modified, reloaded into the broker at runtime. +The broker configuration file has 2 main parts, `<core>` and `<jms>`. Some of +the parameters in the 2 parts are monitored and, if modified, reloaded into the +broker at runtime. -Please note that elements under `<jms>` are deprecated. Users are encouraged to use `<core>` configuration entities. +**Note:** Elements under `<jms>` are **deprecated**. Users are encouraged to +use `<core>` configuration entities. -> *Note:* -> Most parameters reloaded take effect immediately after reloading. However there are some -> that wonât take any effect unless you restarting the broker. +> **Note:** +> +> Most parameters reloaded take effect immediately after reloading. However +> there are some that wonât take any effect unless you restarting the broker. > Such parameters are specifically indicated in the following text. -### `<core>` +### `<core>` #### `<security-settings>` * `<security-setting>` element -Changes to any <security-setting> elements will be reloaded. Each <security-setting> defines security roles for a matched address. +Changes to any `<security-setting>` elements will be reloaded. Each +`<security-setting>` defines security roles for a matched address. - * The `match` attribute +* The `match` attribute - This attribute defines the address for which the security-setting is defined. It can take wildcards such as â#â and â*â. + This attribute defines the address for which the security-setting is + defined. It can take wildcards such as â#â and â*â. - * The `<permission>` sub-elements +* The `<permission>` sub-elements - Each `<security-setting>` can have a list of `<permission>` elements, each of which defines a specific permission-roles mapping. - Each permission has 2 attributes âtypeâ and ârolesâ. The âtypeâ attribute defines the type of operation allowed, the ârolesâ - defines which roles are allowed to perform such operation. Refer to the userâs manual for a list of operations that can be defined. +Each `<security-setting>` can have a list of `<permission>` elements, each +of which defines a specific permission-roles mapping. Each permission has 2 +attributes âtypeâ and ârolesâ. The âtypeâ attribute defines the type of +operation allowed, the ârolesâ defines which roles are allowed to perform such +operation. Refer to the userâs manual for a list of operations that can be +defined. -> *Note:* -> Once loaded the security-settings will take effect immediately. Any new clients will subject -> to the new security settings. Any existing clients will subject to the new settings as well, as soon as they performs -> a new security-sensitive operation. +> **Note:** +> +> Once loaded the security-settings will take effect immediately. Any new +> clients will subject to the new security settings. Any existing clients will +> subject to the new settings as well, as soon as they performs a new +> security-sensitive operation. -Below lists the effects of adding, deleting and updating of an element/attribute within the `<security-settings>` element, whether -an change can be done or canât be done. +Below lists the effects of adding, deleting and updating of an +element/attribute within the `<security-settings>` element, whether an change +can be done or canât be done. Operation | Add | Delete | Update -:--- | :--- | :--- | :--- +---|---|---|--- `<security-settings>` | X* (at most one element is allowed) | Deleting it means delete the whole security settings from the running broker. | N/A* `<security-setting>` | Adding one element means adding a new set of security roles for an address in the running broker | Deleting one element means removing a set of security roles for an address in the running broker | Updating one element means updating the security roles for an address (if match attribute is not changed), or means removing the old match address settings and adding a new one (if match attribute is changed) attribute `match` | N/A* | X* | Changing this value is same as deleting the whole <security-setting> with the old match value and adding @@ -81,21 +97,28 @@ attribute `roles` | N/A* | X* | Changing the ârolesâ value means updating th * `<address-settings>` element -Changes to elements under `<address-settings>` will be reloaded into runtime broker. It contains a list of `<address-setting>` elements. +Changes to elements under `<address-settings>` will be reloaded into runtime +broker. It contains a list of `<address-setting>` elements. * `<address-setting>` element - - Each address-setting element has a âmatchâ attribute that defines an address pattern for which this address-setting is defined. It also has a list of sub-elements used to define the properties of a matching address. - - > *Note:* - > Parameters reloaded in this category will take effect immediately after reloading. The effect of deletion of Address's and Queue's, - > not auto created is controlled by parameter `config-delete-addresses` and `config-delete-queues` as described in the doc. - -Below lists the effects of adding, deleting and updating of an element/attribute within the address-settings element, whether an change -can be done or canât be done. + + Each address-setting element has a âmatchâ attribute that defines an address + pattern for which this address-setting is defined. It also has a list of + sub-elements used to define the properties of a matching address. + + > **Note:** + > + > Parameters reloaded in this category will take effect immediately + > after reloading. The effect of deletion of Address's and Queue's, not auto + > created is controlled by parameter `config-delete-addresses` and + > `config-delete-queues` as described in the doc. + +Below lists the effects of adding, deleting and updating of an +element/attribute within the address-settings element, whether an change can be +done or canât be done. Operation | Add | Delete | Update -:--- | :--- | :--- | :--- +---|---|---|--- `<address-settings>` | X(at most one element is allowed) | Deleting it means delete the whole address settings from the running broker | N/A `<address-setting>` | Adding one element means adding a set of address-setting for a new address in the running broker | Deleting one means removing a set of address-setting for an address in the running broker | Updating one element means updating the address setting for an address (if match attribute is not changed), or means removing the old match address settings and adding a new one (if match attribute is changed) attribute `match` | N/A | X | Changing this value is same as deleting the whole <address-setting> with the old match value and adding a new one with the new match value. @@ -132,20 +155,22 @@ attribute `match` | N/A | X | Changing this value is same as deleting the whole #### `<diverts>` -All `<divert>` elements will be reloaded. Each `<divert>` element -has a ânameâ and several sub-elements that defines the properties of a divert. +All `<divert>` elements will be reloaded. Each `<divert>` element has a ânameâ +and several sub-elements that defines the properties of a divert. -> *Note:* -> Reloading `<diverts>` only resulting in deploying new diverts. Existing diverts -> wonât get undeployed even if you delete a `<divert>` element. Nor an existing -> divert will be updated if its element is updated after reloading. -> To make this happen you need a restart of the broker. +> **Note:** +> +> Reloading `<diverts>` only resulting in deploying new diverts. Existing diverts +> wonât get undeployed even if you delete a `<divert>` element. Nor an existing +> divert will be updated if its element is updated after reloading. To make +> this happen you need a restart of the broker. -Below lists the effects of adding, deleting and updating of an element/attribute -within the diverts element, whether an change can be done or canât be done. +Below lists the effects of adding, deleting and updating of an +element/attribute within the diverts element, whether an change can be done or +canât be done. Operation | Add | Delete | Update -:--- | :--- | :--- | :--- +---|---|---|--- `<diverts>` | X (no more than one can be present) | Deleting it means delete (undeploy) all diverts in running broker. | N/A `<divert>` | Adding a new divert. It will be deployed after reloading | No effect on the deployed divert.(unless restarting broker, in which case the divert will no longer be deployed) | No effect on the deployed divert (unless restarting broker, in which case the divert will be redeployed) attribute `name` | N/A | X | A new divert with the name will be deployed. (if it is not already there in broker). Otherwise no effect. @@ -159,23 +184,28 @@ attribute `name` | N/A | X | A new divert with the name will be deployed. (if it #### `<addresses>` -The `<addresses>` element contains a list `<address>` elements. Once changed, all `<address>` elements - in `<addresses>` will be reloaded. +The `<addresses>` element contains a list `<address>` elements. Once changed, +all `<address>` elements in `<addresses>` will be reloaded. -> *Note:* -> Once reloaded, all new addresses (as well as the pre-configured queues) will be -> deployed to the running broker and all those that are missing from the configuration will be undeployed. +> **Note:** +> +> Once reloaded, all new addresses (as well as the pre-configured queues) will +> be deployed to the running broker and all those that are missing from the +> configuration will be undeployed. -> *Note:* -> Parameters reloaded in this category will take effect immediately after reloading. -> The effect of deletion of Address's and Queue's, not auto created is controlled by -> parameter `config-delete-addresses` and `config-delete-queues` as described in this doc. +> **Note:** +> +> Parameters reloaded in this category will take effect immediately after +> reloading. The effect of deletion of Address's and Queue's, not auto created +> is controlled by parameter `config-delete-addresses` and +> `config-delete-queues` as described in this doc. -Below lists the effects of adding, deleting and updating of an element/attribute -within the `<addresses>` element, whether an change can be done or canât be done. +Below lists the effects of adding, deleting and updating of an +element/attribute within the `<addresses>` element, whether an change can be +done or canât be done. Operation | Add | Delete | Update -:--- | :--- | :--- | :--- +---|---|---|--- `<addresses>` | X(no more than one is present) | Deleting it means delete (undeploy) all diverts in running broker. | N/A `<address>` | A new address will be deployed in the running broker | The corresponding address will be undeployed. | N/A attribute `name` | N/A | X | After reloading the address of the old name will be undeployed and the new will be deployed. @@ -186,21 +216,27 @@ attribute `name` | N/A | X | After reloading the address of the old name will be #### `<queues>` -The `<queues>` element contains a list `<queue>` elements. Once changed, all `<queue>` elements in `<queues>` will be reloaded. +The `<queues>` element contains a list `<queue>` elements. Once changed, all +`<queue>` elements in `<queues>` will be reloaded. -> *Note:* -> Once reloaded, all new queues will be deployed to the running broker and all +> **Note:** +> +> Once reloaded, all new queues will be deployed to the running broker and all > queues that are missing from the configuration will be undeployed. -> *Note:* -> Parameters reloaded in this category will take effect immediately after reloading. -> The effect of deletion of Address's and Queue's, not auto created is controlled by -> parameter `config-delete-addresses` and `config-delete-queues` as described in this doc. -Below lists the effects of adding, deleting and updating of an element/attribute within the `<queues>` element, -and whether an change can be done or canât be done. +> **Note:** +> +> Parameters reloaded in this category will take effect immediately after +> reloading. The effect of deletion of Address's and Queue's, not auto created +> is controlled by parameter `config-delete-addresses` and +> `config-delete-queues` as described in this doc. + +Below lists the effects of adding, deleting and updating of an +element/attribute within the `<queues>` element, and whether an change can be +done or canât be done. Operation | Add | Delete | Update -:--- | :--- | :--- | :--- +---|---|---|--- `<queues>` | X(no more than one is present) | Deleting it means delete (undeploy) all queues from running broker. | N/A `<queue>` | A new queue is deployed after reloading | The queue will be undeployed after reloading. | N/A attribute `name` | N/A | X | A queue with new name will be deployed and the queue with old name will be updeployed after reloading (see Note above). @@ -214,15 +250,17 @@ attribute `durable` | N/A | No effect unless starting broker | No effect unless #### `<queue>` -Changes to any `<queue>` elements will be reloaded to the running broker. +Changes to any `<queue>` elements will be reloaded to the running broker. -> *Note:* -> Once reloaded, new queues defined in the new changes will be deployed to the running -> broker. However existing queues wonât get undeployed even if the matching element is -> deleted/missing. Also new queue elements matching existing queues wonât get re-created â they remain unchanged. +> **Note:** +> +> Once reloaded, new queues defined in the new changes will be deployed to the +> running broker. However existing queues wonât get undeployed even if the +> matching element is deleted/missing. Also new queue elements matching +> existing queues wonât get re-created â they remain unchanged. Operation | Add | Delete | Update -:--- | :--- | :--- | :--- +---|---|---|--- `<queue>` | A new jms queue will be deployed after reloading | No effect unless starting broker | No effect unless starting broker attribute `<name>` | N/A | X | A jms queue of the new name will be deployed after reloading `<selector>` | X(no more than one is present) | No effect unless starting broker | No effect unless starting broker @@ -230,15 +268,16 @@ attribute `<name>` | N/A | X | A jms queue of the new name will be deployed afte #### `<topic>` -Changes to any `<topic>` elements will be reloaded to the running broker. +Changes to any `<topic>` elements will be reloaded to the running broker. -> *Note:* -> Once reloaded, new topics defined in the new changes will be deployed to -> the running broker. However existing topics wonât get undeployed even if the +> **Note:** +> +> Once reloaded, new topics defined in the new changes will be deployed to the +> running broker. However existing topics wonât get undeployed even if the > matching element is deleted/missing. Also any `<topic>` elements matching > existing topics wonât get re-deployed â they remain unchanged. Operation | Add | Delete | Update -:--- | :--- | :--- | :--- +---|---|---|--- `<topic>` | A new jms topic will be deployed after reloading | No effect unless starting broker | No effect unless starting broker attribute `name` | N/A | X | A jms topic of the new name will be deployed after reloading
http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/40b66d13/docs/user-manual/en/configuration-index.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/configuration-index.md b/docs/user-manual/en/configuration-index.md index 4b45de9..0064a77 100644 --- a/docs/user-manual/en/configuration-index.md +++ b/docs/user-manual/en/configuration-index.md @@ -1,51 +1,29 @@ -Configuration Reference -======================= +# Configuration Reference This section is a quick index for looking up configuration. Click on the element name to go to the specific chapter. -Server Configuration -==================== +## Broker Configuration -broker.xml --------------------------- +### broker.xml -This is the main core server configuration file which contains the 'core' -element. -The 'core' element contains the main server configuration. +This is the main core server configuration file which contains the `core` +element. The `core` element contains the main server configuration. -# System properties +#### Modularising broker.xml -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. - -To define global-max-size=1000000 using a system property you would have to define this property, for example through java arguments: - -``` -java -Dbrokerconfig.globalMaxSize=1000000 -``` - -You can also change the prefix through the broker.xml by setting: - -``` -<system-property-prefix>yourprefix</system-property-prefix> -``` - -This is to help you customize artemis on embedded systems. - -# Modularising config into separate files. - -XML XInclude support is provided in the configuration as such if you wish to break your configuration out into separate files you can. +XML XInclude support is provided in `broker.xml` so that you can break your configuration out into separate files. To do this ensure the following is defined at the root configuration element. ``` - xmlns:xi="http://www.w3.org/2001/XInclude"; +xmlns:xi="http://www.w3.org/2001/XInclude"; ``` You can now define include tag's where you want to bring in xml configuration from another file: ``` - <xi:include href="my-address-settings.xml"/> +<xi:include href="my-address-settings.xml"/> ``` 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: @@ -55,241 +33,338 @@ You should ensure xml elements in separated files should be namespaced correctly ``` An example can of this feature can be seen in the test suites: -``` - ./artemis-server/src/test/resources/ConfigurationTest-xinclude-config.xml ``` -N.B. if you use xmllint to validate xml's against schema you should enable xinclude flag when running. +./artemis-server/src/test/resources/ConfigurationTest-xinclude-config.xml +``` +**Note:** if you use `xmllint` to validate the XML against the schema you should enable xinclude flag when running. ``` - --xinclude +--xinclude ``` For further information on XInclude see: -[https://www.w3.org/TR/xinclude/](https://www.w3.org/TR/xinclude/) +[https://www.w3.org/TR/xinclude/](https://www.w3.org/TR/xinclude/) + +### System properties + +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. + +To define global-max-size=1000000 using a system property you would have to define this property, for example through java arguments: + +``` +java -Dbrokerconfig.globalMaxSize=1000000 +``` + +You can also change the prefix through the `broker.xml` by setting: + +``` +<system-property-prefix>yourprefix</system-property-prefix> +``` + +This is to help you customize artemis on embedded systems. -# The core configuration +## The core configuration 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 [list of bridge](#bridge-type) type we will describe the properties for that configuration. +Name | Description | Default +---|---|--- +[acceptors](configuring-transports.md#acceptors) | a list of remoting acceptors | n/a +[acceptors.acceptor](configuring-transports.md#acceptors) | Each acceptor is composed for just an URL | n/a +[addresses](address-model.md#basic-address-configuration) | [a list of addresses](#address-type) | n/a +[address-settings](address-model.md#configuring-addresses-and-queues-via-address-settings) | [a list of address-setting](#address-setting-type) | n/a +[allow-failback](ha.md#failing-back-to-live-server)| Should stop backup on live restart. | `true` +[amqp-use-core-subscription-naming](amqp.md) | If true uses CORE queue naming convention for AMQP. | `false` +[async-connection-execution-enabled](connection-ttl.md) | If False delivery would be always asynchronous. | `true` +[bindings-directory](persistence.md) | The folder in use for the bindings folder | `data/bindings` +[bridges](core-bridges.md) | [a list of core bridges](#bridge-type) | n/a +[ha-policy](ha.md) | the HA policy of this server | none +[broadcast-groups](clusters.md#broadcast-groups) | [a list of broadcast-group](#broadcast-group-type) | n/a +[broker-plugins](broker-plugins.md) | [a list of broker-plugins](#broker-plugin-type) | n/a +[configuration-file-refresh-period](config-reload.md) | The frequency in milliseconds the configuration file is checked for changes | 5000 +[check-for-live-server](ha.md#data-replication)| Used for a live server to verify if there are other nodes with the same ID on the topology | n/a +[cluster-connections](clusters.md#configuring-cluster-connections) | [a list of cluster-connection](#cluster-connection-type) | n/a +[cluster-password](clusters.md) |Cluster password. It applies to all cluster configurations. | n/a +[cluster-user](clusters.md) |Cluster username. It applies to all cluster configurations. | n/a +[connection-ttl-override](connection-ttl.md) |if set, this will override how long (in ms) to keep a connection alive without receiving a ping. -1 disables this setting. | -1 +[connection-ttl-check-interval](connection-ttl.md) |how often (in ms) to check connections for ttl violation. | 2000 +[connectors.connector](configuring-transports.md) | The URL for the connector. This is a list | n/a +[create-bindings-dir](persistence.md) | true means that the server will create the bindings directory on start up. | `true` +[create-journal-dir](persistence.md)| true means that the journal directory will be created. | `true` +[discovery-groups](clusters.md#discovery-groups)| [a list of discovery-group](#discovery-group-type) | n/a +[disk-scan-period](paging.md#max-disk-usage) | The interval where the disk is scanned for percentual usage. | 5000 +[diverts](diverts.md) | [a list of diverts to use](#divert-type) | n/a +[global-max-size](paging.md#global-max-size) | The amount in bytes before all addresses are considered full. | Half of the JVM's `-Xmx` +[graceful-shutdown-enabled](graceful-shutdown.md)| true means that graceful shutdown is enabled. | `false` +[graceful-shutdown-timeout](graceful-shutdown.md)| Timeout on waiting for clients to disconnect before server shutdown. | -1 +[grouping-handler](message-grouping.md) | [a message grouping handler](#grouping-handler-type) | n/a +[id-cache-size](duplicate-detection.md#configuring-the-duplicate-id-cache) | The duplicate detection circular cache size. | 20000 +[jmx-domain](management.md#configuring-jmx) | the JMX domain used to registered MBeans in the MBeanServer. | `org.apache.activemq` +[jmx-use-broker-name](management.md#configuring-jmx) | whether or not to use the broker name in the JMX properties. | `true` +[jmx-management-enabled](management.md#configuring-jmx) | true means that the management API is available via JMX. | `true` +[journal-buffer-size](persistence.md#configuring-the-message-journal) | The size of the internal buffer on the journal in KB. | 490KB +[journal-buffer-timeout](persistence.md#configuring-the-message-journal) | The Flush timeout for the journal buffer | 500000 for ASYNCIO; 3333333 for NIO +[journal-compact-min-files](persistence.md#configuring-the-message-journal) | The minimal number of data files before we can start compacting. Setting this to 0 means compacting is disabled. | 10 +[journal-compact-percentage](persistence.md#configuring-the-message-journal) | The percentage of live data on which we consider compacting the journal. | 30 +[journal-directory](persistence.md#configuring-the-message-journal) | the directory to store the journal files in. | `data/journal` +[journal-file-size](persistence.md#configuring-the-message-journal) | the size (in bytes) of each journal file. | 10MB +[journal-lock-acquisition-timeout](persistence.md#configuring-the-message-journal) | how long (in ms) to wait to acquire a file lock on the journal. | -1 +[journal-max-io](persistence.md#configuring-the-message-journal) | the maximum number of write requests that can be in the ASYNCIO queue at any one time. | 4096 for ASYNCIO; 1 for NIO; ignored for MAPPED +[journal-file-open-timeout](persistence.md#configuring-the-message-journal) | the length of time in seconds to wait when opening a new journal file before timing out and failing. | 5 +[journal-min-files](persistence.md#configuring-the-message-journal) | how many journal files to pre-create. | 2 +[journal-pool-files](persistence.md#configuring-the-message-journal) | 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 `journal-pool-files` | -1 +[journal-sync-non-transactional](persistence.md#configuring-the-message-journal) | if true wait for non transaction data to be synced to the journal before returning response to client. | `true` +[journal-sync-transactional](persistence.md#configuring-the-message-journal)| if true wait for transaction data to be synchronized to the journal before returning response to client. | `true` +[journal-type](persistence.md#configuring-the-message-journal) | the type of journal to use. | `ASYNCIO` +[journal-datasync](persistence.md#configuring-the-message-journal) | It will use msync/fsync on journal operations. | `true` +[large-messages-directory](large-messages.md) | the directory to store large messages. | `data/largemessages` +log-delegate-factory-class-name | **deprecated** the name of the factory class to use for log delegation. | n/a +[management-address](management.md#configuring-management)| the name of the management address to send management messages to. | `activemq.management` +[management-notification-address](management.md#configuring-the-management-notification-address) | the name of the address that consumers bind to receive management notifications. | `activemq.notifications` +[mask-password](masking-passwords.md) | This option controls whether passwords in server configuration need be masked. If set to "true" the passwords are masked. | `false` +[max-saved-replicated-journals-size](ha.md#data-replication) | 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. | 2 +[max-disk-usage](paging.md#max-disk-usage) | The max percentage of data we should use from disks. The System will block while the disk is full. Disable by setting -1. | 100 +[memory-measure-interval](perf-tuning.md) | frequency to sample JVM memory in ms (or -1 to disable memory sampling). | -1 +[memory-warning-threshold](perf-tuning.md)| Percentage of available memory which will trigger a warning log. | 25 +[message-counter-enabled](management.md#message-counters) | true means that message counters are enabled. | `false` +[message-counter-max-day-history](management.md#message-counters)| how many days to keep message counter history. | 10 +[message-counter-sample-period](management.md#message-counters) | the sample period (in ms) to use for message counters. | 10000 +[message-expiry-scan-period](message-expiry.md#configuring-the-expiry-reaper-thread) | how often (in ms) to scan for expired messages. | 30000 +[message-expiry-thread-priority](message-expiry.md#configuring-the-expiry-reaper-thread)| the priority of the thread expiring messages. | 3 +name | node name; used in topology notifications if set. | n/a +[password-codec](masking-passwords.md) | the name of the class (and optional configuration properties) used to decode masked passwords. Only valid when `mask-password` is `true`. | n/a +[page-max-concurrent-io](paging.md) | The max number of concurrent reads allowed on paging. | 5 +[paging-directory](paging.md#configuration)| the directory to store paged messages in. | `data/paging` +[persist-delivery-count-before-delivery](undelivered-messages.md#delivery-count-persistence) | True means that the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled. | `false` +[persistence-enabled](persistence.md#zero-persistence)| true means that the server will use the file based journal for persistence. | `true` +[persist-id-cache](duplicate-detection.md#configuring-the-duplicate-id-cache) | true means that ID's are persisted to the journal. | `true` +queues | **deprecated** [use addresses](#address-type) | n/a +[remoting-incoming-interceptors](intercepting-operations.md)| a list of <class-name/> elements with the names of classes to use for intercepting incoming remoting packets | n/a +[remoting-outgoing-interceptors](intercepting-operations.md)| a list of <class-name/> elements with the names of classes to use for intercepting outgoing remoting packets | n/a +[resolveProtocols]() | Use [ServiceLoader](https://docs.oracle.com/javase/tutorial/ext/basics/spi.html) to load protocol modules. | `true` +[resource-limit-settings](resource-limits.md) | [a list of resource-limits](#resource-limit-type) | n/a +[scheduled-thread-pool-max-size](thread-pooling.md#server-scheduled-thread-pool)| Maximum number of threads to use for the scheduled thread pool. | 5 +[security-enabled](security.md) | true means that security is enabled. | `true` +[security-invalidation-interval](security.md) | how long (in ms) to wait before invalidating the security cache. | 10000 +system-property-prefix | Prefix for replacing configuration settings using Bean Utils. | n/a +internal-naming-prefix | the prefix used when naming the internal queues and addresses required for implementing certain behaviours. | `$.activemq.internal` +[populate-validated-user](security.md#tracking-the-validated-user)| whether or not to add the name of the validated user to the messages that user sends. | `false` +[security-settings](security.md#role-based-security-for-addresses) | [a list of security-setting](#security-setting-type). | n/a +[thread-pool-max-size](thread-pooling.md#thread-management) | Maximum number of threads to use for the thread pool. -1 means 'no limits'. | 30 +[transaction-timeout](transaction-config.md) | how long (in ms) before a transaction can be removed from the resource manager after create time. | 300000 +[transaction-timeout-scan-period](transaction-config.md) | how often (in ms) to scan for timeout transactions. | 1000 +[wild-card-routing-enabled](wildcard-routing.md) | true means that the server supports wild card routing. | `true` +[network-check-NIC](network-isolation.md) | the NIC (Network Interface Controller) to be used on InetAddress.isReachable. | n/a +[network-check-URL-list](network-isolation.md) | the list of http URIs to be used to validate the network. | n/a +[network-check-list](network-isolation.md) | the list of pings to be used on ping or InetAddress.isReachable. | n/a +[network-check-period](network-isolation.md) | a frequency in milliseconds to how often we should check if the network is still up. | 10000 +[network-check-timeout](network-isolation.md) | a timeout used in milliseconds to be used on the ping. | 1000 +[network-check-ping-command](network-isolation.md) | the command used to oping IPV4 addresses. | n/a +[network-check-ping6-command](network-isolation.md) | the command used to oping IPV6 addresses. | n/a +[critical-analyzer](critical-analysis.md) | enable or disable the critical analysis. | `true` +[critical-analyzer-timeout](critical-analysis.md) | timeout used to do the critical analysis. | 120000 ms +[critical-analyzer-check-period](critical-analysis.md) | time used to check the response times. | 0.5 \* `critical-analyzer-timeout` +[critical-analyzer-policy](critical-analysis.md) | should the server log, be halted or shutdown upon failures. | `LOG` +resolve-protocols | 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. | `true` +[resource-limit-settings](resource-limits.md) | [a list of resource-limit](#resource-limit-type). | n/a +server-dump-interval | interval to log server specific information (e.g. memory usage etc). | -1 +store | the store type used by the server. | n/a +[wildcard-addresses](wildcard-syntax.md) | parameters to configure wildcard address matching format. | n/a + +## address-setting type + +Name | Description | Default +---|---|--- +[match](address-model.md) | The filter to apply to the setting | n/a +[dead-letter-address](undelivered-messages.md) | Dead letter address | n/a +[expiry-address](message-expiry.md) | Expired messages address | n/a +[expiry-delay](address-model.md) | Expiration time override; -1 don't override | -1 +[redelivery-delay](undelivered-messages.md) | Time to wait before redelivering a message | 0 +[redelivery-delay-multiplier](address-model.md) | Multiplier to apply to the `redelivery-delay` | 1.0 +[max-redelivery-delay](address-model.md) | Max value for the `redelivery-delay` | 10 \* `redelivery-delay` +[max-delivery-attempts](undelivered-messages.md)| Number of retries before dead letter address| 10 +[max-size-bytes](paging.md)| Max size a queue can be before invoking `address-full-policy` | -1 +[max-size-bytes-reject-threshold]() | Used with `BLOCK`, the max size an address can reach before messages are rejected; works in combination with `max-size-bytes` **for AMQP clients only**. | -1 +[page-size-bytes](paging.md) | Size of each file on page | 10485760 +[page-max-cache-size](paging.md) | Maximum number of files cached from paging | 5 +[address-full-policy](address-model.md)| What to do when a queue reaches `max-size-bytes` | `PAGE` +[message-counter-history-day-limit](address-model.md) | Days to keep message counter data | 0 +[last-value-queue](last-value-queues.md) | **deprecated** Queue is a last value queue; see `default-last-value-queue` instead | `false` +[default-last-value-queue](last-value-queues.md)| `last-value` value if none is set on the queue | `false` +[default-exclusive-queue](exclusive-queues.md) | `exclusive` value if none is set on the queue | `false` +[redistribution-delay](clusters.md) | Timeout before redistributing values after no consumers | -1 +[send-to-dla-on-no-route](address-model.md) | Forward messages to DLA when no queues subscribing | `false` +[slow-consumer-threshold](slow-consumers.md) | Min rate of msgs/sec consumed before a consumer is considered "slow" | -1 +[slow-consumer-policy](slow-consumers.md) | What to do when "slow" consumer is detected | `NOTIFY` +[slow-consumer-check-period](slow-consumers.md) | How often to check for "slow" consumers | 5 +[auto-create-jms-queues](address-model.md#configuring-addresses-and-queues-via-address-settings)| **deprecated** Create JMS queues automatically; see `auto-create-queues` & `auto-create-addresses` | `true` +[auto-delete-jms-queues](address-model.md#configuring-addresses-and-queues-via-address-settings)| **deprecated** Delete JMS queues automatically; see `auto-create-queues` & `auto-create-addresses` | `true` +[auto-create-jms-topics](address-model.md#configuring-addresses-and-queues-via-address-settings)| **deprecated** Create JMS topics automatically; see `auto-create-queues` & `auto-create-addresses` | `true` +[auto-delete-jms-topics](address-model.md#configuring-addresses-and-queues-via-address-settings)| **deprecated** Delete JMS topics automatically; see `auto-create-queues` & `auto-create-addresses` | `true` +[auto-create-queues](address-model.md#configuring-addresses-and-queues-via-address-settings) | Create queues automatically | `true` +[auto-delete-queues](address-model.md#configuring-addresses-and-queues-via-address-settings) | Delete queues automatically | `true` +[config-delete-queues](config-reload.md)| How to deal with queues deleted from XML at runtime| `OFF` +[auto-create-addresses](address-model.md#configuring-addresses-and-queues-via-address-settings) | Create addresses automatically | `true` +[auto-delete-addresses](address-model.md#configuring-addresses-and-queues-via-address-settings) | Delete addresses automatically | `true` +[config-delete-addresses](config-reload.md) | How to deal with addresses deleted from XML at runtime | `OFF` +[management-browse-page-size]() | Number of messages a management resource can browse| 200 +[default-purge-on-no-consumers](address-model.md#non-durable-subscription-queue) | `purge-on-no-consumers` value if none is set on the queue | `false` +[default-max-consumers](address-model.md#shared-durable-subscription-queue-using-max-consumers) | `max-consumers` value if none is set on the queue | -1 +[default-queue-routing-type](address-model.md#routing-type) | Routing type for auto-created queues if the type can't be otherwise determined | `MULTICAST` +[default-address-routing-type](address-model.md#routing-type) | Routing type for auto-created addresses if the type can't be otherwise determined | `MULTICAST` + + +## bridge type + +Name | Description | Default +---|---|--- +[name ](core-bridges.md)| unique name | n/a +[queue-name](core-bridges.md) | name of queue that this bridge consumes from | n/a +[forwarding-address](core-bridges.md) | address to forward to. If omitted original address is used | n/a +[ha](core-bridges.md)| whether this bridge supports fail-over | `false` +[filter](core-bridges.md) | optional core filter expression | n/a +[transformer-class-name](core-bridges.md) | optional name of transformer class | n/a +[min-large-message-size](core-bridges.md) | Limit before message is considered large. | 100KB +[check-period](connection-ttl.md)| How often to check for [TTL](https://en.wikipedia.org/wiki/Time_to_live) violation. -1 means disabled. | 30000 +[connection-ttl](connection-ttl.md) | [TTL](https://en.wikipedia.org/wiki/Time_to_live "Time to Live") for the Bridge. This should be greater than the ping period. | 60000 +[retry-interval](core-bridges.md)| period (in ms) between successive retries. | 2000 +[retry-interval-multiplier](core-bridges.md) | multiplier to apply to successive retry intervals. | 1 +[max-retry-interval](core-bridges.md) | Limit to the retry-interval growth. | 2000 +[reconnect-attempts](core-bridges.md) | maximum number of retry attempts.| -1 (no limit) +[use-duplicate-detection](core-bridges.md)| forward duplicate detection headers? | `true` +[confirmation-window-size](core-bridges.md) | number of bytes before confirmations are sent. | 1MB +[producer-window-size](core-bridges.md)| Producer flow control size on the bridge. | -1 (disabled) +[user](core-bridges.md) | Username for the bridge, the default is the cluster username. | n/a +[password](core-bridges.md)| Password for the bridge, default is the cluster password. | n/a +[reconnect-attempts-same-node](core-bridges.md) | Number of retries before trying another node. | 10 + +## broadcast-group type + +Name | Type +---|--- +[name ](clusters.md) | unique name +[local-bind-address](clusters.md) | Local bind address that the datagram socket is bound to. +[local-bind-port](clusters.md) | Local port to which the datagram socket is bound to. +[group-address](clusters.md)| Multicast address to which the data will be broadcast. +[group-port](clusters.md)| UDP port number used for broadcasting. +[broadcast-period](clusters.md)| Period in milliseconds between consecutive broadcasts. Default=2000. +[jgroups-file](clusters.md) | Name of JGroups configuration file. +[jgroups-channel](clusters.md) | Name of JGroups Channel. +[connector-ref](clusters.md)| The `connector` to broadcast. + + +## cluster-connection type + +Name | Description | Default +---|---|--- +[name](clusters.md) | unique name | n/a +[address](clusters.md) | name of the address this cluster connection applies to | n/a +[connector-ref](clusters.md) | Name of the connector reference to use. | n/a +[check-period](connection-ttl.md) | The period (in milliseconds) used to check if the cluster connection has failed to receive pings from another server | 30000 +[connection-ttl](connection-ttl.md)| Timeout for TTL. | 60000 +[min-large-message-size](large-messages.md) | Messages larger than this are considered large-messages. | 100KB +[call-timeout](clusters.md) | Time(ms) before giving up on blocked calls. | 30000 +[retry-interval](clusters.md)| period (in ms) between successive retries. | 500 +[retry-interval-multiplier](clusters.md) | multiplier to apply to the retry-interval. | 1 +[max-retry-interval](clusters.md) | Maximum value for retry-interval. | 2000 +[reconnect-attempts](clusters.md) | How many attempts should be made to reconnect after failure. | -1 +[use-duplicate-detection](clusters.md)| should duplicate detection headers be inserted in forwarded messages? | `true` +[message-load-balancing](clusters.md) | how should messages be load balanced? | `OFF` +[max-hops](clusters.md)| maximum number of hops cluster topology is propagated. | 1 +[confirmation-window-size](client-reconnection.md#client-reconnection-and-session-reattachment)| The size (in bytes) of the window used for confirming data from the server connected to. | 1048576 +[producer-window-size](clusters.md)| Flow Control for the Cluster connection bridge. | -1 (disabled) +[call-failover-timeout](clusters.md#configuring-cluster-connections)| How long to wait for a reply if in the middle of a fail-over. -1 means wait forever. | -1 +[notification-interval](clusters.md) | how often the cluster connection will notify the cluster of its existence right after joining the cluster. | 1000 +[notification-attempts](clusters.md) | how many times this cluster connection will notify the cluster of its existence right after joining the cluster | 2 + + +## discovery-group type + Name | Description -:--- | :--- -[acceptors](configuring-transports.md "Understanding Acceptors") | a list of remoting acceptors -[acceptors.acceptor](configuring-transports.md "Understanding Acceptors") | Each acceptor is composed for just an URL -[address-settings](address-model.md "Configuring Addresses and Queues Via Address Settings") | [a list of address-setting](#address-setting-type) -[allow-failback](ha.md "Failing Back to live Server") | Should stop backup on live restart. default true -[amqp-use-core-subscription-naming](using-AMQP.md "Message Conversions") | If true uses CORE queue naming convention for AMQP. default false -[async-connection-execution-enabled](connection-ttl.md "Configuring Asynchronous Connection Execution") | If False delivery would be always asynchronous. default true -[bindings-directory](persistence.md "Configuring the bindings journal") | The folder in use for the bindings folder -[bridges](core-bridges.md "Core Bridges") | [a list of bridge](#bridge-type) -[broadcast-groups](clusters.md "Clusters") | [a list of broadcast-group](#broadcast-group-type) -[configuration-file-refresh-period](config-reload.md) | The frequency in milliseconds the configuration file is checked for changes (default 5000) -[check-for-live-server](ha.md) | Used for a live server to verify if there are other nodes with the same ID on the topology -[cluster-connections](clusters.md "Clusters") | [a list of cluster-connection](#cluster-connection-type) -[cluster-password](clusters.md "Clusters") | Cluster password. It applies to all cluster configurations. -[cluster-user](clusters.md "Clusters") | Cluster username. It applies to all cluster configurations. -[connection-ttl-override](connection-ttl.md) | if set, this will override how long (in ms) to keep a connection alive without receiving a ping. -1 disables this setting. Default -1 -[connection-ttl-check-period](connection-ttl.md) | how often (in ms) to check connections for ttl violation. Default 2000 -[connectors.connector](configuring-transports.md "Understanding Connectors") | The URL for the connector. This is a list -[create-bindings-dir](persistence.md "Configuring the bindings journal") | true means that the server will create the bindings directory on start up. Default=true -[create-journal-dir](persistence.md) | true means that the journal directory will be created. Default=true -[discovery-groups](clusters.md "Clusters") | [a list of discovery-group](#discovery-group-type) -[disk-scan-period](paging.md#max-disk-usage) | The interval where the disk is scanned for percentual usage. Default=5000 ms. -[diverts](diverts.md "Diverting and Splitting Message Flows") | [a list of diverts to use](#divert-type) -[global-max-size](paging.md#global-max-size) | The amount in bytes before all addresses are considered full. Default is half of the memory used by the JVM (-Xmx argument). -[graceful-shutdown-enabled](graceful-shutdown.md "Graceful Server Shutdown") | true means that graceful shutdown is enabled. Default=false -[graceful-shutdown-timeout](graceful-shutdown.md "Graceful Server Shutdown") | Timeout on waiting for clients to disconnect before server shutdown. Default=-1 -[grouping-handler](message-grouping.md "Message Grouping") | Message Group configuration -[id-cache-size](duplicate-detection.md "Configuring the Duplicate ID Cache") | The duplicate detection circular cache size. Default=20000 -[jmx-domain](management.md "Configuring JMX") | the JMX domain used to registered MBeans in the MBeanServer. Default=org.apache.activemq -[jmx-management-enabled](management.md "Configuring JMX") | true means that the management API is available via JMX. Default=true -[journal-buffer-size](persistence.md) | The size of the internal buffer on the journal in KB. Default=490 KiB -[journal-buffer-timeout](persistence.md) | The Flush timeout for the journal buffer -[journal-compact-min-files](persistence.md) | The minimal number of data files before we can start compacting. Setting this to 0 means compacting is disabled. Default=10 -[journal-compact-percentage](persistence.md) | The percentage of live data on which we consider compacting the journal. Default=30 -[journal-directory](persistence.md) | the directory to store the journal files in. Default=data/journal -[journal-file-size](persistence.md) | the size (in bytes) of each journal file. Default=10485760 (10 MB) -[journal-max-io](persistence.md#configuring-the-message-journal) | the maximum number of write requests that can be in the AIO queue at any one time. Default is 4096 for AIO and 1 for NIO, ignored for MAPPED. -[journal-min-files](persistence.md#configuring-the-message-journal) | how many journal files to pre-create. Default=2 -[journal-pool-files](persistence.md#configuring-the-message-journal) | The upper threshold 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 `journal-pool-files` -[journal-sync-non-transactional](persistence.md) | if true wait for non transaction data to be synced to the journal before returning response to client. Default=true -[journal-sync-transactional](persistence.md) | if true wait for transaction data to be synchronized to the journal before returning response to client. Default=true -[journal-type](persistence.md) | the type of journal to use. Default=ASYNCIO -[journal-datasync](persistence.md) | It will use msync/fsync on journal operations. Default=true. -[large-messages-directory](large-messages.md "Configuring the server") | the directory to store large messages. Default=data/largemessages -[management-address](management.md "Configuring Core Management") | the name of the management address to send management messages to. Default=activemq.management -[management-notification-address](management.md "Configuring The Core Management Notification Address") | the name of the address that consumers bind to receive management notifications. Default=activemq.notifications -[mask-password](masking-passwords.md "Masking Passwords") | This option controls whether passwords in server configuration need be masked. If set to "true" the passwords are masked. Default=false -[max-saved-replicated-journals-size](ha.md#data-replication) | 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 -[max-disk-usage](paging.md#max-disk-usage) | The max percentage of data we should use from disks. The System will block while the disk is full. Disable by setting -1. Default=100 -[memory-measure-interval](perf-tuning.md) | frequency to sample JVM memory in ms (or -1 to disable memory sampling). Default=-1 -[memory-warning-threshold](perf-tuning.md) | Percentage of available memory which will trigger a warning log. Default=25 -[message-counter-enabled](management.md "Configuring Message Counters") | true means that message counters are enabled. Default=false -[message-counter-max-day-history](management.md "Configuring Message Counters") | how many days to keep message counter history. Default=10 (days) -[message-counter-sample-period](management.md "Configuring Message Counters") | the sample period (in ms) to use for message counters. Default=10000 -[message-expiry-scan-period](message-expiry.md "Configuring The Expiry Reaper Thread") | how often (in ms) to scan for expired messages. Default=30000 -[message-expiry-thread-priority](message-expiry.md "Configuring The Expiry Reaper Thread") | the priority of the thread expiring messages. Default=3 -[password-codec](masking-passwords.md "Masking Passwords") | the name of the class (and optional configuration properties) used to decode masked passwords. Only valid when `mask-password` is `true`. Default=empty -[page-max-concurrent-io](paging.md "Paging Mode") | The max number of concurrent reads allowed on paging. Default=5 -[paging-directory](paging.md "Configuration") | the directory to store paged messages in. Default=data/paging -[persist-delivery-count-before-delivery](undelivered-messages.md "Delivery Count Persistence") | True means that the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled. Default=false -[persistence-enabled](persistence.md "Configuring ActiveMQ Artemis for Zero Persistence") | true means that the server will use the file based journal for persistence. Default=true -[persist-id-cache](duplicate-detection.md "Configuring the Duplicate ID Cache") | true means that ID's are persisted to the journal. Default=true -[queues](address-model.md "Predefined Queues") | [a list of queue to be created](#queue-type) -[remoting-incoming-interceptors](intercepting-operations.md "Intercepting Operations") | A list of interceptor -[resolveProtocols]() | Use [ServiceLoader](https://docs.oracle.com/javase/tutorial/ext/basics/spi.html) to load protocol modules. Default=true -[scheduled-thread-pool-max-size](thread-pooling.md#server-scheduled-thread-pool "Server Scheduled Thread Pool")| Maximum number of threads to use for the scheduled thread pool. Default=5 -[security-enabled](security.md "Security") | true means that security is enabled. Default=true -[security-invalidation-interval](security.md "Security") | how long (in ms) to wait before invalidating the security cache. Default=10000 -system-property-prefix | Prefix for replacing configuration settings using Bean Utils. -[populate-validated-user](security.md "Security") | whether or not to add the name of the validated user to the messages that user sends. Default=false -[security-settings](security.md "Role based security for addresses") | [a list of security-setting](#security-setting-type) -[thread-pool-max-size](thread-pooling.md "Server Scheduled Thread Pool") | Maximum number of threads to use for the thread pool. -1 means 'no limits'.. Default=30 -[transaction-timeout](transaction-config.md "Resource Manager Configuration") | how long (in ms) before a transaction can be removed from the resource manager after create time. Default=300000 -[transaction-timeout-scan-period](transaction-config.md "Resource Manager Configuration") | how often (in ms) to scan for timeout transactions. Default=1000 -[wild-card-routing-enabled](wildcard-routing.md "Routing Messages With Wild Cards") | true means that the server supports wild card routing. Default=true -[network-check-NIC](network-isolation.md) | The NIC (Network Interface Controller) to be used on InetAddress.isReachable -[network-check-URL](network-isolation.md) | The list of http URIs to be used to validate the network -[network-check-list](network-isolation.md) | The list of pings to be used on ping or InetAddress.isReachable -[network-check-ping-command](network-isolation.md) | The command used to oping IPV4 addresses -[network-check-ping6-command](network-isolation.md) | The command used to oping IPV6 addresses -[critical-analyzer](critical-analysis.md) | Enable or disable the critical analysis (default true) -[critical-analyzer-timeout](critical-analysis.md) | Timeout used to do the critical analysis (default 120000 milliseconds) -[critical-analyzer-check-period](critical-analysis.md) | Time used to check the response times (default half of critical-analyzer-timeout) -[critical-analyzer-policy](critical-analysis.md) | Should the server log, be halted or shutdown upon failures (default `LOG`) - - -#address-setting type +---|--- +[name](clusters.md)| unique name +[group-address](clusters.md)| Multicast IP address of the group to listen on +[group-port](clusters.md)| UDP port number of the multi cast group +[jgroups-file](clusters.md) | Name of a JGroups configuration file. If specified, the server uses JGroups for discovery. +[jgroups-channel](clusters.md) | Name of a JGroups Channel. If specified, the server uses the named channel for discovery. +[refresh-timeout]()| 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 +[local-bind-address](clusters.md) | local bind address that the datagram socket is bound to +[local-bind-port](clusters.md) | local port to which the datagram socket is bound to. Default=-1 +initial-wait-timeout | time to wait for an initial broadcast to give us at least one node in the cluster. Default=10000 + +## divert type Name | Description -:--- | :--- -[match ](address-model.md "Configuring Queues Via Address Settings") | The filter to apply to the setting -[dead-letter-address](undelivered-messages.md "Configuring Dead Letter Addresses") | dead letter address -[expiry-address](message-expiry.md "Configuring Expiry Addresses") | expired messages address -[expiry-delay](address-model.md "Configuring Queues Via Address Settings") | expiration time override, -1 don't override with default=-1 -[redelivery-delay](undelivered-messages.md "Configuring Delayed Redelivery") | time to redeliver a message (in ms) with default=0 -[redelivery-delay-multiplier](address-model.md "Configuring Queues Via Address Settings") | multiplier to apply to the "redelivery-delay" -[max-redelivery-delay](address-model.md "Configuring Queues Via Address Settings") | Max value for the redelivery-delay -[max-delivery-attempts](undelivered-messages.md "Configuring Dead Letter Addresses") | Number of retries before dead letter address, default=10 -[max-size-bytes](paging.md "Paging") | Limit before paging. -1 = infinite -[page-size-bytes](paging.md "Paging") | Size of each file on page, default=10485760 -[page-max-cache-size](paging.md "Paging") | Maximum number of files cached from paging default=5 -[address-full-policy](address-model.md "Configuring Queues Via Address Settings") | Model to chose after queue full -[message-counter-history-day-limit](address-model.md "Configuring Queues Via Address Settings") | Days to keep in history -[last-value-queue](last-value-queues.md "Last-Value Queues") | Queue is a last value queue, default=false -[redistribution-delay](clusters.md "Clusters") | Timeout before redistributing values after no consumers. default=-1 -[send-to-dla-on-no-route](address-model.md "Configuring Queues Via Address Settings") | Forward messages to DLA when no queues subscribing. default=false - - -#bridge type +---|--- +[name](diverts.md) | unique name +[transformer-class-name](diverts.md) | an optional class name of a transformer +[exclusive](diverts.md) | whether this is an exclusive divert. Default=false +[routing-name](diverts.md) | the routing name for the divert +[address](diverts.md) | the address this divert will divert from +[forwarding-address](diverts.md) | the forwarding address for the divert +[filter](diverts.md) | optional core filter expression + + +## address type Name | Description -:--- | :--- -[name ](core-bridges.md "Core Bridges") | unique name -[queue-name](core-bridges.md "Core Bridges") | name of queue that this bridge consumes from -[forwarding-address](core-bridges.md "Core Bridges") | address to forward to. If omitted original address is used -[ha](core-bridges.md "Core Bridges") | whether this bridge supports fail-over -[filter](core-bridges.md "Core Bridges") | optional core filter expression -[transformer-class-name](core-bridges.md "Core Bridges") | optional name of transformer class -[min-large-message-size](core-bridges.md "Core Bridges") | Limit before message is considered large. default 100KB -[check-period](connection-ttl.md "Detecting Dead Connections") | [TTL](https://en.wikipedia.org/wiki/Time_to_live "Time to Live") check period for the bridge. -1 means disabled. default 30000 (ms) -[connection-ttl](connection-ttl.md "Detecting Dead Connections") | [TTL](https://en.wikipedia.org/wiki/Time_to_live "Time to Live") for the Bridge. This should be greater than the ping period. default 60000 (ms) -[retry-interval](core-bridges.md "Core Bridges") | period (in ms) between successive retries. default 2000 -[retry-interval-multiplier](core-bridges.md "Core Bridges") | multiplier to apply to successive retry intervals. default 1 -[max-retry-interval](core-bridges.md "Core Bridges") | Limit to the retry-interval growth. default 2000 -[reconnect-attempts](core-bridges.md "Core Bridges") | maximum number of retry attempts, -1 means 'no limits'. default -1 -[use-duplicate-detection](core-bridges.md "Core Bridges") | forward duplicate detection headers?. default true -[confirmation-window-size](core-bridges.md "Core Bridges") | number of bytes before confirmations are sent. default 1MB -[producer-window-size](core-bridges.md "Core Bridges") | Producer flow control size on the bridge. Default -1 (disabled) -[user](core-bridges.md "Core Bridges") | Username for the bridge, the default is the cluster username -[password](core-bridges.md "Core Bridges") | Password for the bridge, default is the cluster password -[reconnect-attempts-same-node](core-bridges.md "Core Bridges") | Number of retries before trying another node. default 10 - -# broadcast-group type +---|--- +name | unique name | n/a +[anycast](address-model.md)| list of anycast [queues](#queue-type) +[multicast](address-model.md) | list of multicast [queues](#queue-type) -Name | Type -:--- | :--- -[name ](clusters.md "Clusters") | unique name -[local-bind-address](clusters.md "Clusters") | local bind address that the datagram socket is bound to -[local-bind-port](clusters.md "Clusters") | local port to which the datagram socket is bound to -[group-address](clusters.md "Clusters") | multicast address to which the data will be broadcast -[group-port](clusters.md "Clusters") | UDP port number used for broadcasting -[broadcast-period](clusters.md "Clusters") | period in milliseconds between consecutive broadcasts. default 2000 -[jgroups-file](clusters.md) | Name of JGroups configuration file -[jgroups-channel](clusters.md) | Name of JGroups Channel -[connector-ref](clusters.md "Clusters") | +## queue type -#cluster-connection type +Name | Description | Default +---|---|--- +name | unique name | n/a +filter | optional core filter expression | n/a +durable | whether the queue is durable (persistent). | `true` +user | the name of the user to associate with the creation of the queue | n/a +[max-consumers](address-model.md#shared-durable-subscription-queue-using-max-consumers) | the max number of consumers allowed on this queue | -1 (no max) +[purge-on-no-consumers](address-model.md#non-durable-subscription-queue) | whether or not to delete all messages and prevent routing when no consumers are connected | `false` +[exclusive](exclusive-queues.md) | only deliver messages to one of the connected consumers | `false` +[last-value](last-value-queues.md) | use last-value semantics | `false` -Name | Description -:--- | :--- -[name](clusters.md "Clusters") | unique name -[address](clusters.md "Clusters") | name of the address this cluster connection applies to -[connector-ref](clusters.md "Clusters") | Name of the connector reference to use. -[check-period](connection-ttl.md "Detecting Dead Connections") | The period (in milliseconds) used to check if the cluster connection has failed to receive pings from another server with default = 30000 -[connection-ttl](connection-ttl.md "Detecting Dead Connections") | Timeout for TTL. Default 60000 -[min-large-message-size](large-messages.md "Large Messages") | Messages larger than this are considered large-messages, default=100KB -[call-timeout](clusters.md "Clusters") | Time(ms) before giving up on blocked calls. Default=30000 -[retry-interval](clusters.md "Clusters") | period (in ms) between successive retries. Default=500 -[retry-interval-multiplier](clusters.md "Clusters") | multiplier to apply to the retry-interval. Default=1 -[max-retry-interval](clusters.md "Clusters") | Maximum value for retry-interval. Default=2000 -[reconnect-attempts](clusters.md "Clusters") | How many attempts should be made to reconnect after failure. Default=-1 -[use-duplicate-detection](clusters.md "Clusters") | should duplicate detection headers be inserted in forwarded messages?. Default=true -[message-load-balancing](clusters.md "Clusters") | how should messages be load balanced? Default=OFF -[max-hops](clusters.md "Clusters") | maximum number of hops cluster topology is propagated. Default=1 -[confirmation-window-size](client-reconnection.md "Client Reconnection and Session Reattachment")| The size (in bytes) of the window used for confirming data from the server connected to. Default 1048576 -[producer-window-size](clusters.md "Clusters") | Flow Control for the Cluster connection bridge. Default -1 (disabled) -[call-failover-timeout](clusters.md "Configuring Cluster Connections") | How long to wait for a reply if in the middle of a fail-over. -1 means wait forever. Default -1 -[notification-interval](clusters.md "Clusters") | how often the cluster connection will notify the cluster of its existence right after joining the cluster. Default 1000 -[notification-attempts](clusters.md "Clusters") | how many times this cluster connection will notify the cluster of its existence right after joining the cluster Default 2 - - -#discovery-group type -Name | Description -:--- | :--- -[name](clusters.md "Clusters") | unique name -[group-address](clusters.md "Clusters") | Multicast IP address of the group to listen on -[group-port](clusters.md "Clusters") | UDP port number of the multi cast group -[jgroups-file](clusters.md) | Name of a JGroups configuration file. If specified, the server uses JGroups for discovery. -[jgroups-channel](clusters.md) | Name of a JGroups Channel. If specified, the server uses the named channel for discovery. -[refresh-timeout]() | 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 -[local-bind-address](clusters.md "Clusters") | local bind address that the datagram socket is bound to -[local-bind-port](clusters.md "Clusters") | local port to which the datagram socket is bound to. Default=-1 -[initial-wait-timeout]() | time to wait for an initial broadcast to give us at least one node in the cluster. Default=10000 - -#divert type +## security-setting type Name | Description -:--- | :--- -[name](diverts.md "Diverting and Splitting Message Flows") | unique name -[transformer-class-name](diverts.md "Diverting and Splitting Message Flows") | an optional class name of a transformer -[exclusive](diverts.md "Diverting and Splitting Message Flows") | whether this is an exclusive divert. Default=false -[routing-name](diverts.md "Diverting and Splitting Message Flows") | the routing name for the divert -[address](diverts.md "Diverting and Splitting Message Flows") | the address this divert will divert from -[forwarding-address](diverts.md "Diverting and Splitting Message Flows") | the forwarding address for the divert -[filter](diverts.md "Diverting and Splitting Message Flows")| optional core filter expression +---|--- +[match](security.md)| [address expression](wildcard-syntax.md) +[permission](security.md) | +[permission.type](security.md) | the type of permission +[permission.roles](security.md) | a comma-separated list of roles to apply the permission to -#queue type +## broker-plugin type Name | Description -:--- | :--- -[name ](address-model.md "Predefined Queues") | unique name -[address](address-model.md "Predefined Queues") | address for the queue -[filter](address-model.md "Predefined Queues") | optional core filter expression -[durable](address-model.md "Predefined Queues") | whether the queue is durable (persistent). Default=true +---|--- +[property](broker-plugins.md#registering-a-plugin)| properties to configure a plugin +[class-name](broker-plugins.md#registering-a-plugin) | the name of the broker plugin class to instantiate -#security-setting type +## resource-limit type -Name | Description -:--- | :--- -[match ](security.md "Role based security for addresses") | [address expression](wildcard-syntax.md) -[permission](security.md "Role based security for addresses") | -[permission.type ](security.md "Role based security for addresses") | the type of permission -[permission.roles ](security.md "Role based security for addresses") | a comma-separated list of roles to apply the permission to +Name | Description | Default +---|---|--- +[match](resource-limits.md#configuring-limits-via-resource-limit-settings)| the name of the user to whom the limits should be applied | n/a +[max-connections](resource-limits.md#configuring-limits-via-resource-limit-settings)| how many connections are allowed by the matched user | -1 (no max) +[max-queues](resource-limits.md#configuring-limits-via-resource-limit-settings)| how many queues can be created by the matched user | -1 (no max) + + +## grouping-handler type +Name | Description | Default +---|---|--- +[name](message-grouping.md#clustered-grouping) | A unique name | n/a +[type](message-grouping.md#clustered-grouping) | `LOCAL` or `REMOTE` | n/a +[address](message-grouping.md#clustered-grouping) | A reference to a `cluster-connection` `address` | n/a +[timeout](message-grouping.md#clustered-grouping) | How long to wait for a decision | 5000 +[group-timeout](message-grouping.md#clustered-grouping) | How long a group binding will be used. | -1 (disabled) +[reaper-period](message-grouping.md#clustered-grouping) | How often the reaper will be run to check for timed out group bindings. Only valid for `LOCAL` handlers. | 30000 \ No newline at end of file
