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


This is the main core server configuration file which contains the 'core' element. The 'core' element contains the main server configuration.

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:


This is to help you customize artemis on embedded systems.

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 type we will describe the properties for that configuration.

Name Description
acceptors a list of remoting acceptors
acceptors.acceptor Each acceptor is composed for just an URL
address-settings a list of address-setting
allow-failback Should stop backup on live restart. default true
amqp-use-core-subscription-naming If true uses CORE queue naming convention for AMQP. default false
async-connection-execution-enabled If False delivery would be always asynchronous. default true
bindings-directory The folder in use for the bindings folder
bridges a list of bridge
broadcast-groups a list of broadcast-group
configuration-file-refresh-period The frequency in milliseconds the configuration file is checked for changes (default 5000)
check-for-live-server Used for a live server to verify if there are other nodes with the same ID on the topology
cluster-connections a list of cluster-connection
cluster-password Cluster password. It applies to all cluster configurations.
cluster-user Cluster username. It applies to all cluster configurations.
connection-ttl-override 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 how often (in ms) to check connections for ttl violation. Default 2000
connectors.connector The URL for the connector. This is a list
create-bindings-dir true means that the server will create the bindings directory on start up. Default=true
create-journal-dir true means that the journal directory will be created. Default=true
discovery-groups a list of discovery-group
disk-scan-period The interval where the disk is scanned for percentual usage. Default=5000 ms.
diverts a list of diverts to use
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 true means that graceful shutdown is enabled. Default=true
graceful-shutdown-timeout Timeout on waitin for clients to disconnect before server shutdown. Default=-1
grouping-handler Message Group configuration
id-cache-size The duplicate detection circular cache size. Default=20000
jmx-domain the JMX domain used to registered MBeans in the MBeanServer. Default=org.apache.activemq
jmx-management-enabled true means that the management API is available via JMX. Default=true
journal-buffer-size The size of the internal buffer on the journal in KB. Default=490 KiB
journal-buffer-timeout The Flush timeout for the journal buffer
journal-compact-min-files The minimal number of data files before we can start compacting. Setting this to 0 means compacting is disabled. Default=10
journal-compact-percentage The percentage of live data on which we consider compacting the journal. Default=30
journal-directory the directory to store the journal files in. Default=data/journal
journal-file-size the size (in bytes) of each journal file. Default=10485760 (10 MB)
journal-max-io 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 how many journal files to pre-create. Default=2
journal-pool-files 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 journal-pool-files
journal-sync-non-transactional if true wait for non transaction data to be synced to the journal before returning response to client. Default=true
journal-sync-transactional if true wait for transaction data to be synchronized to the journal before returning response to client. Default=true
journal-type the type of journal to use. Default=ASYNCIO
journal-datasync It will use msync/fsync on journal operations. Default=true.
large-messages-directory the directory to store large messages. Default=data/largemessages
management-address the name of the management address to send management messages to.
management-notification-address the name of the address that consumers bind to receive management notifications. Default=activemq.notifications
mask-password 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 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 The max percentage of data we should use from disks. The System will block while the disk is full. Default=100
memory-measure-interval frequency to sample JVM memory in ms (or -1 to disable memory sampling). Default=-1
memory-warning-threshold Percentage of available memory which will trigger a warning log. Default=25
message-counter-enabled true means that message counters are enabled. Default=false
message-counter-max-day-history how many days to keep message counter history. Default=10 (days)
message-counter-sample-period the sample period (in ms) to use for message counters. Default=10000
message-expiry-scan-period how often (in ms) to scan for expired messages. Default=30000
message-expiry-thread-priority the priority of the thread expiring messages. Default=3
password-codec 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 The max number of concurrent reads allowed on paging. Default=5
paging-directory the directory to store paged messages in. Default=data/paging
persist-delivery-count-before-delivery 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 true means that the server will use the file based journal for persistence. Default=true
persist-id-cache true means that ID's are persisted to the journal. Default=true
queues a list of queue to be created
remoting-incoming-interceptors A list of interceptor
resolveProtocols Use ServiceLoader to load protocol modules. Default=true
scheduled-thread-pool-max-size Maximum number of threads to use for the scheduled thread pool. Default=5
security-enabled true means that security is enabled. Default=true
security-invalidation-interval 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 whether or not to add the name of the validated user to the messages that user sends. Default=false
security-settings a list of security-setting
thread-pool-max-size Maximum number of threads to use for the thread pool. -1 means 'no limits'.. Default=30
transaction-timeout how long (in ms) before a transaction can be removed from the resource manager after create time. Default=300000
transaction-timeout-scan-period how often (in ms) to scan for timeout transactions. Default=1000
wild-card-routing-enabled true means that the server supports wild card routing. Default=true
network-check-NIC The NIC (Network Interface Controller) to be used on InetAddress.isReacheable
network-check-URL The list of http URIs to be used to validate the network
network-check-list The list of pings to be used on ping or InetAddress.isReacheable
network-check-ping-command The command used to oping IPV4 addresses
network-check-ping6-command The command used to oping IPV6 addresses
critical-analyzer Enable or disable the critical analysis (default true)
critical-analyzer-timeout Timeout used to do the critical analysis (default 120000 milliseconds)
critical-analyzer-check-period Time used to check the response times (default half of critical-analyzer-timeout)
critical-analyzer-policy Should the server log, be halted or shutdown upon failures (default LOG)

address-setting type

Name Description
match The filter to apply to the setting
dead-letter-address dead letter address
expiry-address expired messages address
expiry-delay expiration time override, -1 don't override with default=-1
redelivery-delay time to redeliver a message (in ms) with default=0
redelivery-delay-multiplier multiplier to apply to the "redelivery-delay"
max-redelivery-delay Max value for the redelivery-delay
max-delivery-attempts Number of retries before dead letter address, default=10
max-size-bytes Limit before paging. -1 = infinite
page-size-bytes Size of each file on page, default=10485760
page-max-cache-size Maximum number of files cached from paging default=5
address-full-policy Model to chose after queue full
message-counter-history-day-limit Days to keep in history
last-value-queue Queue is a last value queue, default=false
redistribution-delay Timeout before redistributing values after no consumers. default=-1
send-to-dla-on-no-route Forward messages to DLA when no queues subscribing. default=false

bridge type

Name Description
name unique name
queue-name name of queue that this bridge consumes from
forwarding-address address to forward to. If omitted original address is used
ha whether this bridge supports fail-over
filter optional core filter expression
transformer-class-name optional name of transformer class
min-large-message-size Limit before message is considered large. default 100KB
check-period TTL check period for the bridge. -1 means disabled. default 30000 (ms)
connection-ttl TTL for the Bridge. This should be greater than the ping period. default 60000 (ms)
retry-interval period (in ms) between successive retries. default 2000
retry-interval-multiplier multiplier to apply to successive retry intervals. default 1
max-retry-interval Limit to the retry-interval growth. default 2000
reconnect-attempts maximum number of retry attempts, -1 means 'no limits'. default -1
use-duplicate-detection forward duplicate detection headers?. default true
confirmation-window-size number of bytes before confirmations are sent. default 1MB
producer-window-size Producer flow control size on the bridge. Default -1 (disabled)
user Username for the bridge, the default is the cluster username
password Password for the bridge, default is the cluster password
reconnect-attempts-same-node Number of retries before trying another node. default 10

broadcast-group type

Name Type
name unique name
local-bind-address local bind address that the datagram socket is bound to
local-bind-port local port to which the datagram socket is bound to
group-address multicast address to which the data will be broadcast
group-port UDP port number used for broadcasting
broadcast-period period in milliseconds between consecutive broadcasts. default 2000
jgroups-file Name of JGroups configuration file
jgroups-channel Name of JGroups Channel

cluster-connection type

Name Description
name unique name
address name of the address this cluster connection applies to
connector-ref Name of the connector reference to use.
check-period The period (in milliseconds) used to check if the cluster connection has failed to receive pings from another server with default = 30000
connection-ttl Timeout for TTL. Default 60000
min-large-message-size Messages larger than this are considered large-messages, default=100KB
call-timeout Time(ms) before giving up on blocked calls. Default=30000
retry-interval period (in ms) between successive retries. Default=500
retry-interval-multiplier multiplier to apply to the retry-interval. Default=1
max-retry-interval Maximum value for retry-interval. Default=2000
reconnect-attempts How many attempts should be made to reconnect after failure. Default=-1
use-duplicate-detection should duplicate detection headers be inserted in forwarded messages?. Default=true
message-load-balancing how should messages be load balanced? Default=OFF
max-hops maximum number of hops cluster topology is propagated. Default=1
confirmation-window-size The size (in bytes) of the window used for confirming data from the server connected to. Default 1048576
producer-window-size Flow Control for the Cluster connection bridge. Default -1 (disabled)
call-failover-timeout How long to wait for a reply if in the middle of a fail-over. -1 means wait forever. Default -1
notification-interval how often the cluster connection will notify the cluster of its existence right after joining the cluster. Default 1000
notification-attempts 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 unique name
group-address Multicast IP address of the group to listen on
group-port UDP port number of the multi cast group
jgroups-file Name of a JGroups configuration file. If specified, the server uses JGroups for discovery.
jgroups-channel 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 local bind address that the datagram socket is bound to
local-bind-port 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
name unique name
transformer-class-name an optional class name of a transformer
exclusive whether this is an exclusive divert. Default=false
routing-name the routing name for the divert
address the address this divert will divert from
forwarding-address the forwarding address for the divert
filter optional core filter expression

queue type

Name Description
name unique name
address address for the queue
filter optional core filter expression
durable whether the queue is durable (persistent). Default=true

security-setting type

Name Description
match address expression
permission.type the type of permission
permission.roles a comma-separated list of roles to apply the permission to

results matching ""

    No results matching ""