WildFly 16.0 Model Reference

An ActiveMQ server instance.

Children (27)

acceptor An acceptor defines a way in which connections can be made to the ActiveMQ server.
address-setting An address setting defines some attributes that are defined against an address wildcard rather than a specific queue.
bridge The function of a bridge is to consume messages from a source queue, and forward them to a target address, typically on a different ActiveMQ server.
broadcast-group A broadcast group is the means by which a server broadcasts connectors over the network.
cluster-connection Cluster connections group servers into clusters so that messages can be load balanced between the nodes of the cluster.
connection-factory Defines a connection factory.
connector A connector can be used by a client to define how it connects to a server.
connector-service A connector service allows to integrate external components with Apache ActiveMQ Artemis to send and receive messages.
core-address A runtime-only resource representing a ActiveMQ "address". Zero or more queues can be bound to a single address. When a message is routed, it is routed to the set of queues bound to the message's address.
discovery-group Multicast group to listen to receive broadcast from other servers announcing their connectors.
divert A messaging resource that allows you to transparently divert messages routed to one address to some other address, without making any changes to any client application logic.
grouping-handler Makes decisions about which node in a cluster should handle a message with a group id assigned.
ha-policy A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, replication-colocated, shared-store-master, shared-store-slave, or shared-store-colocated).

live-only A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, replication-colocated, shared-store-master, shared-store-slave, or shared-store-colocated).
replication-colocated A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, replication-colocated, shared-store-master, shared-store-slave, or shared-store-colocated).
replication-master A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, replication-colocated, shared-store-master, shared-store-slave, or shared-store-colocated).
replication-slave A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, replication-colocated, shared-store-master, shared-store-slave, or shared-store-colocated).
shared-store-colocated A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, replication-colocated, shared-store-master, shared-store-slave, or shared-store-colocated).
shared-store-master A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, replication-colocated, shared-store-master, shared-store-slave, or shared-store-colocated).
shared-store-slave A messaging resource that allows you to configure High Availability for the ActiveMQ server (the value of ha-policy can be live-only, replication-master, replication-slave, replication-colocated, shared-store-master, shared-store-slave, or shared-store-colocated).

http-acceptor Defines a way in which remote connections can be made to the ActiveMQ server over HTTP.
http-connector Used by a remote client to define how it connects to a server over HTTP.
in-vm-acceptor Defines a way in which in-VM connections can be made to the ActiveMQ server.
in-vm-connector Used by an in-VM client to define how it connects to a server.
jms-queue Defines a JMS queue.
jms-topic Defines a JMS topic.
legacy-connection-factory Connection Factory resource used by legacy HornetQ clients to connect to the messaging-activemq subsystem.
path A filesystem path pointing to one of the locations where ActiveMQ stores persistent data.

bindings-directory A filesystem path pointing to one of the locations where ActiveMQ stores persistent data.
journal-directory A filesystem path pointing to one of the locations where ActiveMQ stores persistent data.
large-messages-directory A filesystem path pointing to one of the locations where ActiveMQ stores persistent data.
paging-directory A filesystem path pointing to one of the locations where ActiveMQ stores persistent data.

pooled-connection-factory Defines a managed connection factory.
queue A Queue.
remote-acceptor Defines a way in which remote connections can be made to the ActiveMQ server.
remote-connector Used by a remote client to define how it connects to a server.
runtime-queue A runtime queue.
security-setting A security setting allows sets of permissions to be defined against queues based on their address.

Name	Dynamic	Other provider points
org.wildfly.messaging.activemq.server	true	none

Attributes (67)

active Whether the server is active (and accepting connections) or passive (in backup mode, waiting for failover).

Attribute	Value
Type	BOOLEAN
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	read-only

async-connection-execution-enabled Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

cluster-credential-reference Credential (from Credential Store) to authenticate to cluster

Attribute	Value
Type	OBJECT
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	all-services

cluster-password The password used by cluster connections to communicate between the clustered nodes.

Attribute	Value
Default Value	CHANGE ME!!
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

cluster-user The user used by cluster connections to communicate between the clustered nodes.

Attribute	Value
Default Value	ACTIVEMQ.CLUSTER.ADMIN.USER
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

connection-ttl-override If set, this will override how long (in ms) to keep a connection alive without receiving a ping.

Attribute	Value
Default Value	-1
Type	LONG
Nillable	true
Expressions Allowed	true
Unit	MILLISECONDS
Storage	configuration
Access Type	read-write
Restart Required	all-services

create-bindings-dir Whether the server should create the bindings directory on start up.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

create-journal-dir Whether the server should create the journal directory on start up.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

disk-scan-period The interval where the disk is scanned for percentual usage.

Attribute	Value
Default Value	5000
Type	INT
Nillable	true
Expressions Allowed	true
Unit	MILLISECONDS
Storage	configuration
Access Type	read-write
Restart Required	all-services

elytron-domain The name of the Elytron security domain used to verify user and role information.

Attribute	Value
Capability reference	/subsystem=elytron/security-domain=*
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	all-services

global-max-disk-usage The maximum percentage of data we should use from disks. The System will block while the disk is full.

Attribute	Value
Default Value	100
Type	INT
Nillable	true
Expressions Allowed	true
Min	-1
Max	100
Unit	PERCENTAGE
Storage	configuration
Access Type	read-write
Restart Required	all-services

global-max-memory-size Maximum amount of memory which message data may consume.

Attribute	Value
Default Value	-1
Type	LONG
Nillable	true
Expressions Allowed	true
Unit	BYTES
Storage	configuration
Access Type	read-write
Restart Required	all-services

id-cache-size The size of the cache for pre-creating message IDs.

Attribute	Value
Default Value	20000
Type	INT
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

incoming-interceptors The list of incoming interceptor classes used by this server.

Attribute	Value
Type	LIST
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	no-services

jmx-domain The JMX domain used to register internal ActiveMQ MBeans in the MBeanServer.

Attribute	Value
Default Value	org.apache.activemq.artemis
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

jmx-management-enabled Whether ActiveMQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration.

Attribute	Value
Default Value	false
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-bindings-table Name of the JDBC table to store the bindings.

Attribute	Value
Default Value	BINDINGS
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-buffer-size The size of the internal buffer on the journal.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	true
Min	0
Max	-1
Unit	BYTES
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-buffer-timeout The timeout (in nanoseconds) used to flush internal buffers on the journal.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	true
Unit	MILLISECONDS
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-compact-min-files The minimal number of journal data files before we can start compacting.

Attribute	Value
Default Value	10
Type	INT
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-compact-percentage The percentage of live data on which we consider compacting the journal.

Attribute	Value
Default Value	30
Type	INT
Nillable	true
Expressions Allowed	true
Min	0
Max	100
Unit	PERCENTAGE
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-database Type of the database (can be used to customize SQL statements). If this attribute is not specified, the type of the database will be determined based on the DataSource metadata.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-datasource Name of the DataSource for the JDBC store.

Attribute	Value
Capability reference	/subsystem=datasources-agroal/xa-datasource=* /subsystem=datasources-agroal/datasource=* /subsystem=datasources/xa-data-source=* /subsystem=datasources/data-source=*
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-file-size The size (in bytes) of each journal file.

Attribute	Value
Default Value	10485760
Type	LONG
Nillable	true
Expressions Allowed	true
Min	1,024
Max	-1
Unit	BYTES
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-jdbc-lock-expiration The time the HA lock is considered valid without keeping it alive.

Attribute	Value
Default Value	20
Type	INT
Nillable	true
Expressions Allowed	true
Unit	SECONDS
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-jdbc-lock-renew-period The renewal period for the HA lock to keep it alive.

Attribute	Value
Default Value	4
Type	INT
Nillable	true
Expressions Allowed	true
Unit	SECONDS
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-jdbc-network-timeout The timeout used by the JDBC connection to detect network issues.

Attribute	Value
Default Value	20
Type	INT
Nillable	true
Expressions Allowed	true
Unit	SECONDS
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-jms-bindings-table Name of the JDBC table to store the JMS bindings.

Deprecated Since 3.0.0

Artemis 2 no longer stores JMS bindings in its journal.

Attribute	Value
Default Value	JMS_BINDINGS
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	no-services

journal-large-messages-table Name of the JDBC table to store the large messages.

Attribute	Value
Default Value	LARGE_MESSAGES
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-max-io The maximum number of write requests that can be in the AIO queue at any one time.

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-messages-table Name of the JDBC table to store the messages.

Attribute	Value
Default Value	MESSAGES
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-min-files How many journal files to pre-create.

Attribute	Value
Default Value	2
Type	INT
Nillable	true
Expressions Allowed	true
Min	2
Max	2,147,483,647
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-node-manager-store-table Name of the JDBC table to store the node manager.

Attribute	Value
Default Value	NODE_MANAGER_STORE
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-page-store-table Name of the JDBC table to store pages.

Attribute	Value
Default Value	PAGE_STORE
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-pool-files The number of journal files that can be reused. ActiveMQ will create as many files as needed however when reclaiming files it will shrink back to the value (-1 means no limit).

Attribute	Value
Default Value	10
Type	INT
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-sync-non-transactional Whether to wait for non transaction data to be synced to the journal before returning a response to the client.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-sync-transactional Whether to wait for transaction data to be synchronized to the journal before returning a response to the client.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

journal-type The type of journal to use.

Attribute	Value
Default Value	ASYNCIO
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services
Allowed Values	NIO ASYNCIO

log-journal-write-rate Whether to periodically log the journal's write rate and flush rate.

Attribute	Value
Default Value	false
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

management-address Address to send management messages to.

Attribute	Value
Default Value	activemq.management
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

management-notification-address The name of the address that consumers bind to to receive management notifications.

Attribute	Value
Default Value	activemq.notifications
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

memory-measure-interval Frequency to sample JVM memory in ms (or -1 to disable memory sampling)

Attribute	Value
Default Value	-1
Type	LONG
Nillable	true
Expressions Allowed	true
Unit	MILLISECONDS
Storage	configuration
Access Type	read-write
Restart Required	all-services

memory-warning-threshold Percentage of available memory which if exceeded results in a warning log

Attribute	Value
Default Value	25
Type	INT
Nillable	true
Expressions Allowed	true
Unit	PERCENTAGE
Storage	configuration
Access Type	read-write
Restart Required	all-services

message-counter-max-day-history How many days to keep message counter history.

Attribute	Value
Default Value	10
Type	INT
Nillable	true
Expressions Allowed	true
Unit	DAYS
Storage	configuration
Access Type	read-write
Restart Required	no-services

message-counter-sample-period The sample period (in ms) to use for message counters.

Attribute	Value
Default Value	10000
Type	LONG
Nillable	true
Expressions Allowed	true
Unit	MILLISECONDS
Storage	configuration
Access Type	read-write
Restart Required	no-services

message-expiry-scan-period How often (in ms) to scan for expired messages.

Attribute	Value
Default Value	30000
Type	LONG
Nillable	true
Expressions Allowed	true
Unit	MILLISECONDS
Storage	configuration
Access Type	read-write
Restart Required	all-services

message-expiry-thread-priority The priority of the thread expiring messages.

Attribute	Value
Default Value	3
Type	INT
Nillable	true
Expressions Allowed	true
Min	1
Max	10
Storage	configuration
Access Type	read-write
Restart Required	all-services

outgoing-interceptors The list of outgoing interceptor classes used by this server.

Attribute	Value
Type	LIST
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	no-services

override-in-vm-security Whether the ActiveMQ server will override security credentials for in-vm connections.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

page-max-concurrent-io The maximum number of concurrent reads allowed on paging

Attribute	Value
Default Value	5
Type	INT
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

perf-blast-pages Number of pages to add to check the journal performance (only meant to be used to test performance of pages).

Deprecated Since 3.0.0

Artemis 2 no longer supports this attribute.

Attribute	Value
Default Value	-1
Type	INT
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

persist-delivery-count-before-delivery Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled.

Attribute	Value
Default Value	false
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

persist-id-cache Whether IDs are persisted to the journal.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

persistence-enabled Whether the server will use the file based journal for persistence.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

run-sync-speed-test Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues.

Deprecated Since 3.0.0

Artemis 2 no longer supports this attribute.

Attribute	Value
Default Value	false
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

scheduled-thread-pool-max-size The number of threads that the main scheduled thread pool has.

Attribute	Value
Default Value	5
Type	INT
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

security-domain The security domain to use to verify user and role information.

Deprecated Since 2.0.0

Deprecated. Replaced by the elytron-domain attribute to use a security domain configured by Elytron.

Attribute	Value
Default Value	other
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	all-services

security-enabled Whether security is enabled.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

security-invalidation-interval How long (in ms) to wait before invalidating the security cache.

Attribute	Value
Default Value	10000
Type	LONG
Nillable	true
Expressions Allowed	true
Unit	MILLISECONDS
Storage	configuration
Access Type	read-write
Restart Required	all-services

server-dump-interval How often to dump basic runtime information to the server log. A value less than 1 disables this feature.

Attribute	Value
Default Value	-1
Type	LONG
Nillable	true
Expressions Allowed	true
Unit	MILLISECONDS
Storage	configuration
Access Type	read-write
Restart Required	all-services

started Whether this server is started.

Attribute	Value
Type	BOOLEAN
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	read-only

statistics-enabled Whether gathering of statistics such as message counters are enabled.

Attribute	Value
Default Value	false
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	no-services

thread-pool-max-size The number of threads that the main thread pool has. -1 means no limit.

Attribute	Value
Default Value	30
Type	INT
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

transaction-timeout Default duration before a transaction will be rolled back after create time. If a Transaction Manager is used, this value will be replaced by that of the TM.

Attribute	Value
Default Value	300000
Type	LONG
Nillable	true
Expressions Allowed	true
Unit	MILLISECONDS
Storage	configuration
Access Type	read-write
Restart Required	all-services

transaction-timeout-scan-period How often (in ms) to scan for timeout transactions.

Attribute	Value
Default Value	1000
Type	LONG
Nillable	true
Expressions Allowed	true
Unit	MILLISECONDS
Storage	configuration
Access Type	read-write
Restart Required	all-services

version The server's version.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

wild-card-routing-enabled Whether the server supports wild card routing.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

Operations (35)

add Operation adding a ActiveMQ server.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
async-connection-execution-enabled	BOOLEAN	false	true	true	Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread.
connection-ttl-override	LONG	false	true	-1	If set, this will override how long (in ms) to keep a connection alive without receiving a ping.
id-cache-size	INT	false	true	20000	The size of the cache for pre-creating message IDs.
incoming-interceptors	LIST	false	false		The list of incoming interceptor classes used by this server.
outgoing-interceptors	LIST	false	false		The list of outgoing interceptor classes used by this server.
page-max-concurrent-io	INT	false	true	5	The maximum number of concurrent reads allowed on paging
persist-delivery-count-before-delivery	BOOLEAN	false	true	false	Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled.
persist-id-cache	BOOLEAN	false	true	true	Whether IDs are persisted to the journal.
persistence-enabled	BOOLEAN	false	true	true	Whether the server will use the file based journal for persistence.
scheduled-thread-pool-max-size	INT	false	true	5	The number of threads that the main scheduled thread pool has.
thread-pool-max-size	INT	false	true	30	The number of threads that the main thread pool has. -1 means no limit.
wild-card-routing-enabled	BOOLEAN	false	true	true	Whether the server supports wild card routing.
cluster-credential-reference	OBJECT	false	false		Credential (from Credential Store) to authenticate to cluster
cluster-password	STRING	false	true	CHANGE ME!!	The password used by cluster connections to communicate between the clustered nodes.
cluster-user	STRING	false	true	ACTIVEMQ.CLUSTER.ADMIN.USER	The user used by cluster connections to communicate between the clustered nodes.
memory-measure-interval	LONG	false	true	-1	Frequency to sample JVM memory in ms (or -1 to disable memory sampling)
memory-warning-threshold	INT	false	true	25	Percentage of available memory which if exceeded results in a warning log
perf-blast-pages	INT	false	true	-1	Number of pages to add to check the journal performance (only meant to be used to test performance of pages).
run-sync-speed-test	BOOLEAN	false	true	false	Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues.
server-dump-interval	LONG	false	true	-1	How often to dump basic runtime information to the server log. A value less than 1 disables this feature.
create-bindings-dir	BOOLEAN	false	true	true	Whether the server should create the bindings directory on start up.
create-journal-dir	BOOLEAN	false	true	true	Whether the server should create the journal directory on start up.
disk-scan-period	INT	false	true	5000	The interval where the disk is scanned for percentual usage.
global-max-disk-usage	INT	false	true	100	The maximum percentage of data we should use from disks. The System will block while the disk is full.
global-max-memory-size	LONG	false	true	-1	Maximum amount of memory which message data may consume.
journal-bindings-table	STRING	false	true	BINDINGS	Name of the JDBC table to store the bindings.
journal-buffer-size	LONG	false	true		The size of the internal buffer on the journal.
journal-buffer-timeout	LONG	false	true		The timeout (in nanoseconds) used to flush internal buffers on the journal.
journal-compact-min-files	INT	false	true	10	The minimal number of journal data files before we can start compacting.
journal-compact-percentage	INT	false	true	30	The percentage of live data on which we consider compacting the journal.
journal-database	STRING	false	true		Type of the database (can be used to customize SQL statements). If this attribute is not specified, the type of the database will be determined based on the DataSource metadata.
journal-datasource	STRING	false	false		Name of the DataSource for the JDBC store.
journal-file-size	LONG	false	true	10485760	The size (in bytes) of each journal file.
journal-jdbc-lock-expiration	INT	false	true	20	The time the HA lock is considered valid without keeping it alive.
journal-jdbc-lock-renew-period	INT	false	true	4	The renewal period for the HA lock to keep it alive.
journal-jdbc-network-timeout	INT	false	true	20	The timeout used by the JDBC connection to detect network issues.
journal-jms-bindings-table	STRING	false	true	JMS_BINDINGS	Name of the JDBC table to store the JMS bindings.
journal-large-messages-table	STRING	false	true	LARGE_MESSAGES	Name of the JDBC table to store the large messages.
journal-max-io	INT	false	true		The maximum number of write requests that can be in the AIO queue at any one time.
journal-messages-table	STRING	false	true	MESSAGES	Name of the JDBC table to store the messages.
journal-min-files	INT	false	true	2	How many journal files to pre-create.
journal-node-manager-store-table	STRING	false	true	NODE_MANAGER_STORE	Name of the JDBC table to store the node manager.
journal-page-store-table	STRING	false	true	PAGE_STORE	Name of the JDBC table to store pages.
journal-pool-files	INT	false	true	10	The number of journal files that can be reused. ActiveMQ will create as many files as needed however when reclaiming files it will shrink back to the value (-1 means no limit).
journal-sync-non-transactional	BOOLEAN	false	true	true	Whether to wait for non transaction data to be synced to the journal before returning a response to the client.
journal-sync-transactional	BOOLEAN	false	true	true	Whether to wait for transaction data to be synchronized to the journal before returning a response to the client.
journal-type	STRING	false	true	ASYNCIO	The type of journal to use.
log-journal-write-rate	BOOLEAN	false	true	false	Whether to periodically log the journal's write rate and flush rate.
jmx-domain	STRING	false	true	org.apache.activemq.artemis	The JMX domain used to register internal ActiveMQ MBeans in the MBeanServer.
jmx-management-enabled	BOOLEAN	false	true	false	Whether ActiveMQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration.
management-address	STRING	false	true	activemq.management	Address to send management messages to.
management-notification-address	STRING	false	true	activemq.notifications	The name of the address that consumers bind to to receive management notifications.
message-expiry-scan-period	LONG	false	true	30000	How often (in ms) to scan for expired messages.
message-expiry-thread-priority	INT	false	true	3	The priority of the thread expiring messages.
elytron-domain	STRING	false	false		The name of the Elytron security domain used to verify user and role information.
override-in-vm-security	BOOLEAN	false	true	true	Whether the ActiveMQ server will override security credentials for in-vm connections.
security-domain	STRING	false	false	other	The security domain to use to verify user and role information.
security-enabled	BOOLEAN	false	true	true	Whether security is enabled.
security-invalidation-interval	LONG	false	true	10000	How long (in ms) to wait before invalidating the security cache.
message-counter-max-day-history	INT	false	true	10	How many days to keep message counter history.
message-counter-sample-period	LONG	false	true	10000	The sample period (in ms) to use for message counters.
statistics-enabled	BOOLEAN	false	true	false	Whether gathering of statistics such as message counters are enabled.
transaction-timeout	LONG	false	true	300000	Default duration before a transaction will be rolled back after create time. If a Transaction Manager is used, this value will be replaced by that of the TM.
transaction-timeout-scan-period	LONG	false	true	1000	How often (in ms) to scan for timeout transactions.

close-connections-for-address Closes all the connections of clients connected to this server whose remote address contains the specified IP address.

Request Parameter Type Required Expressions Allowed Default value Description

ip-address STRING true false An IP address in string format.

Reply properties

True if any connections were closed, false otherwise.

type

BOOLEAN
close-connections-for-user Closes all the connections of clients connected to this server under the specified user name.

Request Parameter Type Required Expressions Allowed Default value Description

user STRING true false An user name.

Reply properties

True if any connections were closed, false otherwise.

type

BOOLEAN
close-consumer-connections-for-address Closes all the connections of consumers that are consuming from queues bound to the specified address.

Request Parameter Type Required Expressions Allowed Default value Description

address-match STRING true false An ActiveMQ address match.

Reply properties

True if any connections were closed, false otherwise.

type

BOOLEAN
commit-prepared-transaction Heuristically commits a prepared transaction.

Request Parameter Type Required Expressions Allowed Default value Description

transaction-as-base-64 STRING true false The Base64 representation of a transaction XID.

Reply properties

True if the transaction was successfully committed, false otherwise.

type

BOOLEAN
export-journal Export the journal to a XML file
force-failover Force the messaging server to stop and notify clients to failover.
get-address-settings-as-json Returns the address settings as a JSON string for an address match.

Request Parameter Type Required Expressions Allowed Default value Description

address-match STRING true false An address match.

Reply properties

A JSON string containing an array of address settings details.

type

STRING
get-connectors-as-json Returns the connectors configured for this server in a JSON string containing the connectors information.

Reply properties

A JSON string containing the connectors information.

type

STRING
get-last-sent-message-id Returns the ID of the last message sent from the given session to the given address.

Request Parameter Type Required Expressions Allowed Default value Description

session-id STRING true false The session id.

address-name STRING true false The name of the address.

Reply properties

The message id.

type

STRING

get-roles Get the security roles for a specific address match.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
address-match	STRING	true	false		An address match.

Reply properties

A list, each element of which is a set of properties describing a security role.

type

LIST

Value Type

{
    "name" => {
        "type" => STRING,
        "description" => "The name of the role.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "send" => {
        "type" => BOOLEAN,
        "description" => "Whether the role has permission to send to the matching addresses.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "default" => false
    },
    "consume" => {
        "type" => BOOLEAN,
        "description" => "Whether the role has permission to consume from the matching addresses.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "default" => false
    },
    "create-durable-queue" => {
        "type" => BOOLEAN,
        "description" => "Whether the role has permission to create a durable queue for the matching addresses.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "default" => false
    },
    "delete-durable-queue" => {
        "type" => BOOLEAN,
        "description" => "Whether the role has permission to delete a durable queue for the matching addresses.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "default" => false
    },
    "create-non-durable-queue" => {
        "type" => BOOLEAN,
        "description" => "Whether the role has permission to create a non-durable queue for the matching addresses.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "default" => false
    },
    "delete-non-durable-queue" => {
        "type" => BOOLEAN,
        "description" => "Whether the role has permission to delete a non-durable queue for the matching addresses.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "default" => false
    },
    "manage" => {
        "type" => BOOLEAN,
        "description" => "Whether the role has permission to manage the matching addresses.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "default" => false
    }
}

get-roles-as-json Gets the roles (as a JSON string) for a specific address match.

Request Parameter Type Required Expressions Allowed Default value Description

address-match STRING true false An address match.

Reply properties

A JSON string containing a list, each element of which is a set of properties describing a security role.

type

STRING
get-session-creation-time Gets the session's creation time.

Request Parameter Type Required Expressions Allowed Default value Description

session-id STRING true false The session id.

Reply properties

The creation time, represented as a string showing the number of milliseconds since the epoch.

type

STRING

import-journal Import an XML file to the journal

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
file	STRING	true	false		The XML file to import in the journal
legacy-prefixes	BOOLEAN	false	false	true	Do not remove prefixes from legacy (Artemis 1.x) imports

list-all-consumers-as-json Lists all the consumers.
list-connection-ids Lists the IDs of all the connections connected to this server.
Reply properties
A list of strings, where each string is a connection ID.
type

LIST

Value Type

STRING
list-connections-as-json Lists all JMS connections.
list-consumers-as-json Lists all the consumers which belongs to the JMS Connection specified by the connection id.

Request Parameter Type Required Expressions Allowed Default value Description

connection-id STRING true false The connection id.
list-heuristic-committed-transactions Lists transactions which have been heuristically committed.
Reply properties
A list of strings. The Strings are Base-64 representation of the transaction XID.
type

LIST

Value Type

STRING
list-heuristic-rolled-back-transactions Lists transactions which have been heuristically rolled back.
Reply properties
A list of strings. The Strings are Base-64 representation of the transaction XID.
type

LIST

Value Type

STRING
list-prepared-transaction-details-as-html Lists all the prepared transaction, sorted by date, oldest first, with details, in HTML format.

Reply properties

A HTML string containing a table of transaction details.

type

STRING
list-prepared-transaction-details-as-json Lists all the prepared transaction, sorted by date, oldest first, with details, in JSON format.

Reply properties

A JSON string containing an array of transaction details.

type

STRING
list-prepared-transaction-jms-details-as-html Lists all the prepared transactions, sorted by date, oldest first, in a HTML format.

Reply properties

The returned String is an HTML string containing a table of transaction details.

type

STRING
list-prepared-transaction-jms-details-as-json Lists all the prepared transactions, sorted by date, oldest first, in a JSON format.

Reply properties

The returned String is a JSON string containing an array of transaction details.

type

STRING
list-prepared-transactions Lists all the prepared transaction, sorted by date, oldest first.
Reply properties
A list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions.
type

LIST

Value Type

STRING
list-producers-info-as-json For all sessions, lists information about message producers using JSON serialization.

Reply properties

A JSON string containing an array of producer details.

type

STRING
list-remote-addresses Lists the addresses of all the clients connected to the given address. If an ip-address argument is supplied, only those clients whose remote address string includes the given ip-address string will be returned.
Request Parameter Type Required Expressions Allowed Default value Description

ip-address STRING false false An IP address in string format.
Reply properties
A list of strings, where the strings are remote client addresses.
type

LIST

Value Type

STRING
list-sessions Lists all the sessions IDs for the specified connection ID.
Request Parameter Type Required Expressions Allowed Default value Description

connection-id STRING true false The connection id.
Reply properties
A list of strings, where each string is a session ID.
type

LIST

Value Type

STRING
list-sessions-as-json Lists all the sessions IDs for the specified connection id.

Request Parameter Type Required Expressions Allowed Default value Description

connection-id STRING true false The connection id.

Reply properties

A JSON string containing an array of session ids.

type

STRING
list-target-destinations Lists all addresses to which the designated session has sent messages.
Request Parameter Type Required Expressions Allowed Default value Description

session-id STRING true false The session id.
Reply properties
A JSON string containing an array of address names.
type

LIST

Value Type

STRING
remove Operation removing a ActiveMQ server.
reset-all-message-counter-histories Resets all message counters history.
reset-all-message-counters Resets all message counters.

resolve-address-setting Resolve the address settings using ActiveMQ hierarchy of address settings.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
activemq-address	STRING	true	false		The address to resolve.

Reply properties

type

LIST

Value Type

{
    "dead-letter-address" => {
        "type" => STRING,
        "description" => "The dead letter address",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "expiry-address" => {
        "type" => STRING,
        "description" => "Defines where to send a message that has expired.",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "expiry-delay" => {
        "type" => LONG,
        "description" => "Defines the expiration time that will be used for messages using the default expiration time",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => -1L,
        "unit" => "MILLISECONDS"
    },
    "redelivery-delay" => {
        "type" => LONG,
        "description" => "Defines how long to wait before attempting redelivery of a cancelled message",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => 0L,
        "unit" => "MILLISECONDS"
    },
    "redelivery-multiplier" => {
        "type" => DOUBLE,
        "description" => "Multiplier to apply to the redelivery-delay parameter",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => 1.0
    },
    "max-delivery-attempts" => {
        "type" => INT,
        "description" => "Defines how many time a cancelled message can be redelivered before sending to the dead-letter-address",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => 10
    },
    "max-redelivery-delay" => {
        "type" => LONG,
        "description" => "Maximum value for the redelivery-delay (in ms).",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => 0L,
        "unit" => "MILLISECONDS"
    },
    "max-size-bytes" => {
        "type" => LONG,
        "description" => "The max bytes size.",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => -1L,
        "unit" => "BYTES"
    },
    "page-size-bytes" => {
        "type" => LONG,
        "description" => "The paging size.",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => 10485760,
        "unit" => "BYTES"
    },
    "page-max-cache-size" => {
        "type" => INT,
        "description" => "The number of page files to keep in memory to optimize IO during paging navigation.",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => 5
    },
    "address-full-policy" => {
        "type" => STRING,
        "description" => "Determines what happens when an address where max-size-bytes is specified becomes full. (PAGE, DROP or BLOCK)",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => "PAGE",
        "allowed" => [
            "DROP",
            "PAGE",
            "BLOCK",
            "FAIL"
        ]
    },
    "message-counter-history-day-limit" => {
        "type" => INT,
        "description" => "Day limit for the message counter history.",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => 0,
        "unit" => "DAYS"
    },
    "last-value-queue" => {
        "type" => BOOLEAN,
        "description" => "Defines whether a queue only uses last values or not",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => false
    },
    "redistribution-delay" => {
        "type" => LONG,
        "description" => "Defines how long to wait when the last consumer is closed on a queue before redistributing any messages",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => -1L,
        "unit" => "MILLISECONDS"
    },
    "send-to-dla-on-no-route" => {
        "type" => BOOLEAN,
        "description" => "If this parameter is set to true for that address, if the message is not routed to any queues it will instead be sent to the dead letter address (DLA) for that address, if it exists.",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => false
    },
    "slow-consumer-check-period" => {
        "type" => LONG,
        "description" => "How often to check for slow consumers on a particular queue.",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => 5L,
        "unit" => "SECONDS"
    },
    "slow-consumer-policy" => {
        "type" => STRING,
        "description" => "Determine what happens when a slow consumer is identified.",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => "NOTIFY",
        "allowed" => [
            "KILL",
            "NOTIFY"
        ]
    },
    "slow-consumer-threshold" => {
        "type" => LONG,
        "description" => "The minimum rate of message consumption allowed before a consumer is considered slow.",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => -1L
    },
    "auto-create-jms-queues" => {
        "type" => BOOLEAN,
        "description" => "Determines whether ActiveMQ should automatically create a JMS queue corresponding to the address-settings match when a JMS producer or a consumer is tries to use such a queue.",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => false,
        "deprecated" => {
            "since" => "3.0.0",
            "reason" => "This attribute is no longer supported by ActiveMQ."
        }
    },
    "auto-delete-jms-queues" => {
        "type" => BOOLEAN,
        "description" => "Determines Whether ActiveMQ should automatically delete auto-created JMS queues when they have no consumers and no messages.",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => false,
        "deprecated" => {
            "since" => "3.0.0",
            "reason" => "This attribute is no longer supported by ActiveMQ."
        }
    },
    "auto-create-addresses" => {
        "type" => BOOLEAN,
        "description" => "Determines whether ActiveMQ should automatically create an addresses corresponding to the address-settings match when a producer or a consumer is tries to use such a queue.",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => true
    },
    "auto-delete-addresses" => {
        "type" => BOOLEAN,
        "description" => "Determines Whether ActiveMQ should automatically delete auto-created addresses when they have no consumers and no messages.",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => true
    },
    "auto-create-queues" => {
        "type" => BOOLEAN,
        "description" => "Determines whether ActiveMQ should automatically create a queue corresponding to the address-settings match when a producer or a consumer is tries to use such a queue.",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => false
    },
    "auto-delete-queues" => {
        "type" => BOOLEAN,
        "description" => "Determines Whether ActiveMQ should automatically delete auto-created queues when they have no consumers and no messages.",
        "expressions-allowed" => true,
        "required" => false,
        "nillable" => true,
        "default" => false
    }
}

rollback-prepared-transaction Heuristically rolls back a prepared transaction.

Request Parameter Type Required Expressions Allowed Default value Description

transaction-as-base-64 STRING true false The Base64 representation of a transaction XID.

Reply properties

True if the transaction was successfully rolled back, false otherwise.

type

BOOLEAN