Appendix A. Reference Material A.1. Address Setting Attributes Table A.1. Address Setting Attributes Name Description address-full-policy Determines what happens when an address where max-size-bytes is specified becomes full. Accepted values are PAGE , DROP , FAIL or BLOCK . If the value is PAGE then further messages will be paged to disk. If the value is DROP then further messages will be silently dropped. If the value is FAIL then the messages will be dropped and the client message producers will receive an exception. If the value is BLOCK then client message producers will block when they try and send further messages. PAGE is the default. See About Paging for details on paging. auto-create-jms-queues Determines whether JBoss EAP should automatically create a Jakarta Messaging queue corresponding to the address settings match when a Jakarta Messaging producer or a consumer tries to use such a queue. The default is false . Deprecated: Use auto-create-queues instead . auto-create-jms-topics Determines whether JBoss EAP should automatically create a Jakarta Messaging topic corresponding to the address settings match when a Jakarta Messaging producer or a consumer tries to use such a queue. The default is false . Deprecated: Use auto-create-addresses instead . auto-create-addresses Determines whether the broker should automatically create an address when a message is sent or a consumer tries to connect to a queue whose name fits the address match . Queues that are auto-created are durable, non-temporary, and non-transient. The default is true . auto-create-queues Determines whether the broker should automatically create a queue when a message is sent or a consumer tries to connect to a queue whose name fits the address match . Queues that are auto-created are durable, non-temporary, and non-transient. The default is true . auto-delete-jms-queues Determines whether JBoss EAP should automatically delete auto-created Jakarta Messaging queues when they have no consumers and no messages. The default is false . Deprecated: Use auto-delete-queues instead . auto-delete-jms-topics Determines whether JBoss EAP should automatically delete auto-created Jakarta Messaging topics when they have no consumers and no messages. The default is false . Deprecated: Use auto-delete-addresses instead . auto-delete-addresses Determines whether or not the broker should automatically delete auto-created addresses once the address no longer has any queues. The default is true . auto-delete-queues Determines whether or not the broker should automatically delete auto-created queues when they have both 0 consumers and 0 messages. The default is true . dead-letter-address The address to send dead messages to. See Configuring Dead Letter Addresses for more information. expiry-address The address that will receive expired messages. See Configuring Message Expiry for details. expiry-delay Defines the expiration time, in milliseconds, that will be used for messages using the default expiration time. Default is -1 . last-value-queue Defines whether a queue only uses last values or not. See Last-value Queues for more information. max-delivery-attempts Defines how many time a canceled message can be redelivered before sending to the dead-letter-address. Default is 10 . max-redelivery-delay Maximum value for the redelivery-delay, in milliseconds. Default is 0 . max-size-bytes The maximum size for this address, in bytes. Default is -1 . message-counter-history-day-limit Day limit for the message counter history. Default is 0 . page-max-cache-size The number of page files to keep in memory to optimize IO during paging navigation. Default is 5 . page-size-bytes The paging size, in bytes. Default is 10485760 . redelivery-delay Defines how long to wait before attempting redelivery of a canceled message, in milliseconds. Default is 0 . See Configuring Delayed Redelivery for more information. redelivery-multiplier Multiplier to apply to the redelivery-delay parameter. Default is 1.0 . redistribution-delay Defines how long to wait, in milliseconds, after the last consumer is closed on a queue before redistributing any messages. Default is -1 . send-to-dla-on-no-route When set to true , a message will be sent to the configured dead letter address if it cannot be routed to any queues. Default is false . slow-consumer-check-period How often to check, in seconds, for slow consumers. Default is 5 . slow-consumer-policy Determines what happens when a slow consumer is identified. Valid options are KILL or NOTIFY . KILL will kill the consumer's connection, which will impact any client threads using that same connection. NOTIFY will send a CONSUMER_SLOW management notification to the client. Default is NOTIFY . slow-consumer-threshold The minimum rate of message consumption allowed before a consumer is considered slow. Default is -1 . A.2. Connection Factory Attributes Table A.2. Connection Factory Attributes Attribute Description auto-group Whether message grouping is automatically used. block-on-acknowledge Whether to block on acknowledge. block-on-durable-send Whether to block on durable send. block-on-non-durable-send Whether to block on non durable send. cache-large-message-client Whether to cache large messages. call-failover-timeout The timeout, in milliseconds, to use when failover is in process. call-timeout The call timeout, in milliseconds. client-failure-check-period The client failure check period, in milliseconds. client-id The client ID. compress-large-messages Whether large messages should be compressed. confirmation-window-size The confirmation window size, in bytes. connection-load-balancing-policy-class-name Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. connection-ttl The connection time to live, in milliseconds. connectors Defines the connectors, which are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute. consumer-max-rate The consumer maximum rate, per second. consumer-window-size The consumer window size, in bytes. deserialization-black-list Defines the list of classes or packages that are not allowed to be deserialized. deserialization-white-list Defines the list of classes or packages that are allowed to be deserialized. discovery-group The discovery group name. dups-ok-batch-size The dups ok batch size. enable-amq1-prefix Specifies whether to include a prefix on the Jakarta Messaging destination name. If the value is false, the prefix is not included. entries The JNDI names the connection factory should be bound to. factory-type The type of connection factory. Valid values are: GENERIC TOPIC QUEUE XA_GENERIC XA_QUEUE XA_TOPIC Use GENERIC for a general connection to a broker, while TOPIC and QUEUE should be used for connections to their respective Jakarta Messaging types. The XA counterparts should be used for transactional messaging. failover-on-initial-connection Whether to failover on initial connection. group-id The group ID. ha Whether the connection factory supports high availability. max-retry-interval The maximum retry interval, in milliseconds. min-large-message-size The minimum large message size, in bytes. pre-acknowledge Whether to pre-acknowledge. producer-max-rate The producer maximum rate, per second. producer-window-size The producer window size, in bytes. protocol-manager-factory The protocol manager factory used by this connection factory. reconnect-attempts The reconnect attempts. retry-interval The retry interval, in milliseconds. retry-interval-multiplier The retry interval multiplier. scheduled-thread-pool-max-size The scheduled thread pool maximum size. thread-pool-max-size The thread pool maximum size. transaction-batch-size The transaction batch size. use-global-pools Whether to use global pools. use-topology-for-load-balancing Specifies whether the messaging client will use the cluster topology to connect to a cluster, or will use the initial connector for all connections. A.3. Pooled Connection Factory Attributes Table A.3. Pooled Connection Factory Attributes Attribute Description allow-local-transactions Whether to allow local transactions for outbound Jakarta Messaging Sessions. When set to true , this enables a Jakarta Messaging producer to send messages in the following situations: From a servlet in a transacted session. From an MDB in a transacted session with the transaction type attribute set to NOT_SUPPORTED . This attribute does not apply to the JMSContext , which explicitly disallows it. auto-group Whether message grouping is automatically used. block-on-acknowledge Whether to block on acknowledge. block-on-durable-send Whether to block on durable send. block-on-non-durable-send Whether to block on non durable send. cache-large-message-client Whether to cache large messages. call-failover-timeout The timeout, in milliseconds, to use when failover is in process. call-timeout The call timeout, in milliseconds. client-failure-check-period The client failure check period, in milliseconds. client-id The client id. compress-large-messages Whether large messages should be compressed. confirmation-window-size The confirmation window size, in bytes. connection-load-balancing-policy-class-name Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. connection-ttl The connection time to live, in milliseconds. connectors Defines the connectors, which are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute. consumer-max-rate The consumer max rate, per second. consumer-window-size The consumer window size, in bytes. credential-reference Credential, from a credential store, to authenticate the pooled connection factory. deserialization-black-list Defines the list of classes or packages that are not allowed to be deserialized. deserialization-white-list Defines the list of classes or packages that are allowed to be deserialized. discovery-group The discovery group name. dups-ok-batch-size The dups ok batch size. enable-amq1-prefix Specifies whether to include a prefix on the Jakarta Messaging destination name. If the value is false, the prefix is not included. enlistment-trace Enables IronJacamar to record enlistment traces for this pooled connection factory. This attribute is undefined by default and the behavior is driven by the presence of the ironjacamar.disable_enlistment_trace system property. entries The JNDI names that the connection factory should be bound to. failover-on-initial-connection Whether to failover on initial connection. group-id The group id. ha Whether the connection factory supports high availability. initial-connect-attempts The number of attempts to connect initially with this factory. initial-message-packet-size The initial size of messages created through this factory. jndi-params The JNDI params to use for locating the destination for incoming connections. managed-connection-pool The class name of the managed connection pool used by this pooled connection factory. max-pool-size The maximum size for the pool. max-retry-interval The max retry interval, in milliseconds. min-large-message-size The min large message size, in bytes. min-pool-size The minimum size for the pool. password The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host. pre-acknowledge Whether to pre-acknowledge. producer-max-rate The producer max rate, per second. producer-window-size The producer window size, in bytes. protocol-manager-factory The protocol manager factory used by this pooled connection factory. reconnect-attempts The reconnect attempts. By default, a pooled connection factory will try to reconnect infinitely to the messaging servers. retry-interval The retry interval, in milliseconds. retry-interval-multiplier The retry interval multiplier. scheduled-thread-pool-max-size The scheduled thread pool max size. setup-attempts The number of times to set up an MDB endpoint. setup-interval The interval, in milliseconds, between attempts at setting up an MDB endpoint. statistics-enabled Whether runtime statistics are enabled. thread-pool-max-size The thread pool max size. transaction The transaction mode. transaction-batch-size The transaction batch size. use-auto-recovery Whether to use auto recovery. use-global-pools Whether to use global pools. use-jndi Use JNDI to locate the destination for incoming connections. use-local-tx Use a local transaction for incoming sessions. use-topology-for-load-balancing Specifies whether the messaging client will use the cluster topology to connect to a cluster, or will use the initial connector for all connections. user The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host. A.4. Core Bridge Attributes Table A.4. Core Bridge Attributes Attribute Description call-timeout The period of time, in milliseconds, to wait for a response for blocking calls that are made by the core bridge. The core bridge uses blocking calls when duplicate detection is not configured. The default value is 30000 , or 30 seconds. check-period The period, in milliseconds, between client failure checks. confirmation-window-size The size to use for the connection used to forward messages to the target node. connection-ttl The maximum time, in milliseconds, for which the connections used by the bridges are considered alive, in the absence of heartbeat. credential-reference Credential, from a credential store, to authenticate the bridge. discovery-group The name of the discovery group used by this bridge. This attribute may not be set if static-connectors is defined. filter An optional filter string. If specified, then only messages that match the filter expression specified will be forwarded. forwarding-address The address on the target server that the message will be forwarded to. If a forwarding address is not specified, then the original destination of the message will be retained. ha Whether or not this bridge should support high availability. If true , then it will connect to any available server in a cluster and support failover. The default value is false . initial-connect-attempts The number of attempts to connect initially with this bridge. max-retry-interval The maximum interval of time used to retry connections. min-large-message-size The minimum size, in bytes, for a message before it is considered as a large message. password The password to use when creating the bridge connection to the remote server. If it is not specified, then the default cluster password specified by the cluster-password attribute in the messaging-activemq subsystem resource will be used. cluster-credential-reference Credential store reference used to authenticate to the cluster. This may be used instead of password . queue-name The unique name of the local queue that the bridge consumes from. The queue must already exist by the time the bridge is instantiated at startup. reconnect-attempts The total number of reconnect attempts that the bridge will make before giving up and shutting down. The default value is -1 , which signifies an unlimited number of attempts. reconnect-attempts-on-same-node The total number of reconnect attempts on the same node that the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts. The default is 10 . retry-interval The period, in milliseconds, between subsequent reconnection attempts, if the connection to the target server has failed. retry-interval-multiplier A multiplier to apply to the time since the last retry to compute the time to the retry. This allows you to implement an exponential backoff between retry attempts. static-connectors A list of statically defined connectors used by this bridge. This attribute may not be set if discovery-group is defined. transformer-class-name The name of a user-defined class that implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface. use-duplicate-detection Whether the bridge will automatically insert a duplicate ID property into each message that it forwards. user The user name to use when creating the bridge connection to the remote server. If not specified, the default cluster user specified by the cluster-user attribute in the messaging-activemq subsystem resource will be used. A.5. Jakarta Messaging Bridge Attributes Table A.5. Jakarta Messaging bridge Attributes Attribute Description add-messageID-in-header If this is set to true , then the original message's message ID will be appended in the message sent to the destination in the header AMQ_BRIDGE_MSG_ID_LIST . If the message is bridged more than once, each message ID will be appended. client-id The Jakarta Messaging client ID to use when creating and looking up the subscription if it is durable and the source destination is a topic. failure-retry-interval The amount of time, in milliseconds, to wait between trying to recreate connections to the source or target servers when the bridge has detected they have failed. max-batch-size The maximum number of messages to consume from the source destination before sending them in a batch to the target destination. The value must greater than or equal to 1 . max-batch-time The maximum number of milliseconds to wait before sending a batch of messages to a target, even if the number of messages consumed has not reached max-batch-size. A value of -1 means to wait forever. max-retries The number of times to attempt to recreate connections to the source or target servers when the bridge has detected they have failed. The bridge will give up after trying this number of times. A value of -1 means to try forever. module The name of the JBoss EAP module containing the resources required to look up source and target Jakarta Messaging resources. paused A read-only property that reports whether the Jakarta Messaging bridge is paused. quality-of-service The desired quality of service mode. Possible values are AT_MOST_ONCE , DUPLICATES_OK , or ONCE_AND_ONLY_ONCE . See Quality of Service for details on the different modes. selector A Jakarta Messaging selector expression used for consuming messages from the source destination. Only messages that match the selector expression will be bridged from the source to the target destination. subscription-name The name of the subscription if it is durable and the source destination is a topic. source-connection-factory The name of the source connection factory to look up on the source messaging server. source-context The properties used to configure the source JNDI initial context. source-credential-reference Credential store reference used to authenticate the source connection. This may be used instead of source-password . source-destination The name of the source destination to look up on the source messaging server. source-password The password for creating the source connection. source-user The name of the user for creating the source connection. target-connection-factory The name of the target connection factory to look up on the target messaging server. target-context The properties used to configure the target JNDI initial context. target-credential-reference Credential store reference used to authenticate the target connection. This may be used instead of target-password . target-destination The name of the target destination to look up on the target messaging server. target-password The password for creating the target connection. target-user The name of the user for creating the target connection. A.6. Cluster Connection Attributes Table A.6. Cluster Connection Attributes Attribute Description allow-direct-connections-only If set to true , this node will not create a connection to another node in the cluster if it resides more than 1 hop away. Used only when the attribute static-connectors is defined. The default is false . call-failover-timeout The timeout, in milliseconds, to use when failover is in process for remote calls made by the cluster connection. The default is -1 , which is unbounded. call-timeout The timeout, in milliseconds, for remote calls made by the cluster connection. The default is 30000 , or 30 seconds. check-period The period, in milliseconds, between client failure check. The default is 30000 , or 30 seconds. cluster-connection-address Each cluster connection only applies to messages sent to an address that starts with this value. confirmation-window-size The window size, in bytes, for the connection used to forward messages to a target node. The default is 1048576 . connection-ttl The maximum time, in milliseconds, for which the connections used by the cluster connections are considered alive in the absence of heartbeat. The default is 60000 , or 60 seconds. connector-name The name of the connector to use for the cluster connection. discovery-group The discovery group used to obtain the list of other servers in the cluster to which this cluster connection will make connections. Must be undefined (null) if static-connectors is defined. initial-connect-attempts The number of attempts to connect initially with this cluster connection. The default is -1 , which is unbounded. max-hops The maximum number of times a message can be forwarded. JBoss EAP can be configured to also load balance messages to nodes that might be connected to it only indirectly with other ActiveMQ Artemis messaging servers as intermediates in a chain. The default is 1 . max-retry-interval The maximum interval of time, in milliseconds, used to retry connections. The default is 2000 , or two seconds. message-load-balancing-type This parameter determines how messages will be distributed between other nodes in the cluster. Replaces the deprecated forward-when-no-consumers . Valid values are OFF , STRICT , or ON_DEMAND . OFF Messages will never be forwarded to another node in the cluster. STRICT Messages will be distributed in a round robin fashion even though the same queues on the other nodes of the cluster may have no consumers at all, or they may have consumers that have nonmatching message filters or selectors. Note that JBoss EAP will not forward messages to other nodes if there are no queues of the same name on the other nodes, even if this parameter is set to STRICT . Using STRICT is like setting the legacy forward-when-no-consumers parameter to true . ON_DEMAND Messages are forwarded to other nodes of the cluster if the forwarding address has queues that have consumers. If those consumers have message filters or selectors, at least one of those selectors must match the message. Using ON_DEMAND is like setting the legacy forward-when-no-consumers parameter to false . The default is ON_DEMAND . min-large-message-size The minimum size, in bytes, for a message before it is considered as a large message. The default is 102400 . node-id The node ID used by this cluster connection. This attribute is read only. notification-attempts How many times the cluster connection will broadcast itself. The default is 2 . notification-interval The interval, in milliseconds, between notifications. The default is 10000 , or 10 seconds. reconnect-attempts The total number of reconnect attempts the bridge will make before giving up and shutting down. The default is -1 , which signifies an unlimited number of attempts. retry-interval The period, in milliseconds, between subsequent attempts to reconnect to a target server, if the connection to the target server has failed. The default is 500 . retry-interval-multiplier A multiplier to apply to the time since the last retry to compute the time to the retry. This allows you to implement an exponential backoff between retry attempts. The default is 1.0 . static-connectors The statically defined list of connectors to which this cluster connection will make connections. Must be undefined if discovery-group-name is defined. topology The topology of the nodes that this cluster connection is aware of. This attribute is read only. use-duplicate-detection Whether the bridge will automatically insert a duplicate ID property into each message that it forwards. The default is true . A.7. Messaging Statistics Queue Statistics Table A.7. Queue Statistics Statistic Description Consumer Count The number of consumers consuming messages from this queue. Message Count The number of messages currently in this queue. Messages Added Count The number of messages added to this queue since it was created. Scheduled Count The number of scheduled messages in this queue. Topic Statistics Table A.8. Topic Statistics Statistic Description Delivering Count The number of messages that this topic is currently delivering to its consumers. Durable Message Count The number of messages for all durable subscribers for this topic. Durable Subscription Count The number of durable subscribers for this topic. Message Count The number of messages currently in this topic. Messages Added The number of messages added to this topic since it was created. Subscription Count The number of durable and non-durable subscribers for this topic. Pooled Connection Factory Statistics Note Statistics collection for pooled connection factories are enabled separately from the other statistics collected for a messaging server. Use the following management CLI command to enable statistics collection for a pooled connection factory. Table A.9. Pooled Connection Factory Statistics Statistic Description ActiveCount The active count. AvailableCount The available count. AverageBlockingTime Average blocking time for pool. AverageCreationTime The average time spent creating a physical connection. AverageGetTime The average time spent obtaining a physical connection. AveragePoolTime The average time spent by physical connections in the pool. AverageUsageTime The average time spent using a physical connection. BlockingFailureCount The number of failures trying to obtain a physical connection. CreatedCount The created count. DestroyedCount The destroyed count. IdleCount The number of physical connections currently idle. InUseCount The number of physical connections currently in use. MaxCreationTime The maximum time for creating a physical connection. MaxGetTime The maximum time for obtaining a physical connection. MaxPoolTime The maximum time for a physical connection in the pool. MaxUsageTime The maximum time using a physical connection. MaxUsedCount The maximum number of connections used. MaxWaitCount The maximum number of threads waiting for a connection. MaxWaitTime The maximum wait time for a connection. TimedOut The timed out count. TotalBlockingTime The total blocking time. TotalCreationTime The total time spent creating physical connections. TotalGetTime The total time spent obtaining physical connections. TotalPoolTime The total time spent by physical connections in the pool. TotalUsageTime The total time spent using physical connections. WaitCount The number of requests that had to wait to obtain a physical connection. XACommitAverageTime The average time for an XAResource commit invocation. XACommitCount The number of XAResource commit invocations. XACommitMaxTime The maximum time for an XAResource commit invocation. XACommitTotalTime The total time for all XAResource commit invocations. XAEndAverageTime The average time for an XAResource end invocation. XAEndCount The number of XAResource end invocations. XAEndMaxTime The maximum time for an XAResource end invocation. XAEndTotalTime The total time for all XAResource end invocations. XAForgetAverageTime The average time for an XAResource forget invocation. XAForgetCount The number of XAResource forget invocations. XAForgetMaxTime The maximum time for an XAResource forget invocation. XAForgetTotalTime The total time for all XAResource forget invocations. XAPrepareAverageTime The average time for an XAResource prepare invocation. XAPrepareCount The number of XAResource prepare invocations. XAPrepareMaxTime The maximum time for an XAResource prepare invocation. XAPrepareTotalTime The total time for all XAResource prepare invocations. XARecoverAverageTime The average time for an XAResource recover invocation. XARecoverCount The number of XAResource recover invocations. XARecoverMaxTime The maximum time for an XAResource recover invocation. XARecoverTotalTime The total time for all XAResource recover invocations. XARollbackAverageTime The average time for an XAResource rollback invocation. XARollbackCount The number of XAResource rollback invocations. XARollbackMaxTime The maximum time for an XAResource rollback invocation. XARollbackTotalTime The total time for all XAResource rollback invocations. XAStartAverageTime The average time for an XAResource start invocation. XAStartCount The number of XAResource start invocations. XAStartMaxTime The maximum time for an XAResource start invocation. XAStartTotalTime The total time for all XAResource start invocations. Revised on 2024-01-17 05:24:52 UTC

Commands:
/subsystem=messaging-activemq/server=default/pooled-connection-factory=activemq-ra:write-attribute(name=statistics-enabled,value=true)