Red Hat Training

A Red Hat training course is available for Red Hat JBoss Operations Network

3.3.12.4. JBoss AS 7 and EAP 6 - Messaging Runtime Service

Overview

Table 3.507. Overview

Description: Runtime resources exposed by messaging resources included in this deployment.
Singleton: yes
Plugin: JBossAS7
Child Resource Types
Connection Properties

Table 3.508. 

Name Description Required Internal Name
Path yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.12.4.1. JBoss AS 7 and EAP 6 - HornetQ Server Runtime Service
Overview

Table 3.509. Overview

Description: A HornetQ server instance.
Singleton: no
Plugin: JBossAS7
Child Resource Types
Connection Properties

Table 3.510. 

Name Description Required Internal Name
Path yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 3.511. Metrics

Name Type Description Internal Name
Started trait Whether this server is started. started
Version trait The server's version. version

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties

Table 3.512. 

Name Description Required Internal Name
Allow Failback Whether this server will automatically shutdown if the original live server comes back up. The default value is true. no allow-failback
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. The default value is true. no async-connection-execution-enabled
Backup Whether this server is a backup server. The default value is false. no backup
Cluster Password The password used by cluster connections to communicate between the clustered nodes. The default value is CHANGE ME!!. no cluster-password
Cluster User The user used by cluster connections to communicate between the clustered nodes. The default value is HORNETQ.CLUSTER.ADMIN.USER. no cluster-user
Clustered Whether the server is clustered. The default value is false. no clustered
Connection Ttl Override If set, this will override how long (in ms) to keep a connection alive without receiving a ping. The default value is -1. no connection-ttl-override
Create Bindings Dir Whether the server should create the bindings directory on start up. The default value is true. no create-bindings-dir
Create Journal Dir Whether the server should create the journal directory on start up. The default value is true. no create-journal-dir
Failback Delay How long to wait before failback occurs on live server restart. The default value is 5000. no failback-delay
Failover On Shutdown Whether this backup server (if it is a backup server) should come live on a normal server shutdown. The default value is false. no failover-on-shutdown
Id Cache Size The size of the cache for pre-creating message IDs. The default value is 2000. no id-cache-size
Jmx Domain The JMX domain used to register internal HornetQ MBeans in the MBeanServer. The default value is org.hornetq. no jmx-domain
Jmx Management Enabled Whether HornetQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration. The default value is false. no jmx-management-enabled
Journal Buffer Size The size of the internal buffer on the journal. no journal-buffer-size
Journal Buffer Timeout The timeout (in nanoseconds) used to flush internal buffers on the journal. no journal-buffer-timeout
Journal Compact Min Files The minimal number of journal data files before we can start compacting. The default value is 10. no journal-compact-min-files
Journal Compact Percentage The percentage of live data on which we consider compacting the journal. The default value is 30. no journal-compact-percentage
Journal File Size The size (in bytes) of each journal file. The default value is 10485760. no journal-file-size
Journal Max Io The maximum number of write requests that can be in the AIO queue at any one time. no journal-max-io
Journal Min Files How many journal files to pre-create. The default value is 2. no journal-min-files
Journal Sync Non Transactional Whether to wait for non transaction data to be synced to the journal before returning a response to the client. The default value is true. no journal-sync-non-transactional
Journal Sync Transactional Whether to wait for transaction data to be synchronized to the journal before returning a response to the client. The default value is true. no journal-sync-transactional
Journal Type The type of journal to use. The default value is ASYNCIO. no journal-type
Live Connector Ref The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is 'undefined'. no live-connector-ref
Log Journal Write Rate Whether to periodically log the journal's write rate and flush rate. The default value is false. no log-journal-write-rate
Management Address Address to send management messages to. The default value is jms.queue.hornetq.management. no management-address
Management Notification Address The name of the address that consumers bind to to receive management notifications. The default value is hornetq.notifications. no management-notification-address
Memory Measure Interval Frequency to sample JVM memory in ms (or -1 to disable memory sampling). The default value is -1. no memory-measure-interval:expr
Memory Warning Threshold Percentage of available memory which if exceeded results in a warning log. The default value is 25. no memory-warning-threshold:expr
Message Counter Enabled Whether message counters are enabled. The default value is false. no message-counter-enabled
Message Counter Max Day History How many days to keep message counter history. The default value is 10. no message-counter-max-day-history
Message Counter Sample Period The sample period (in ms) to use for message counters. The default value is 10000. no message-counter-sample-period
Message Expiry Scan Period How often (in ms) to scan for expired messages. The default value is 30000. no message-expiry-scan-period
Message Expiry Thread Priority The priority of the thread expiring messages. The default value is 3. no message-expiry-thread-priority
Page Max Concurrent Io The maximum number of concurrent reads allowed on paging. The default value is 5. no page-max-concurrent-io
Perf Blast Pages TODO. The default value is -1. no perf-blast-pages
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. The default value is false. no persist-delivery-count-before-delivery
Persist Id Cache Whether IDs are persisted to the journal. The default value is true. no persist-id-cache
Persistence Enabled Whether the server will use the file based journal for persistence. The default value is true. no persistence-enabled
Remoting Interceptors The list of interceptor classes used by this server. no remoting-interceptors
Run Sync Speed Test Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues. The default value is false. no run-sync-speed-test
Scheduled Thread Pool Max Size The number of threads that the main scheduled thread pool has. The default value is 5. no scheduled-thread-pool-max-size:expr
Security Domain The security domain to use to verify user and role information. The default value is other. no security-domain
Security Enabled Whether security is enabled. The default value is true. no security-enabled
Security Invalidation Interval How long (in ms) to wait before invalidating the security cache. The default value is 10000. no security-invalidation-interval
Server Dump Interval How often to dump basic runtime information to the server log. A value less than 1 disables this feature. The default value is -1. no server-dump-interval
Shared Store Whether this server is using a shared store for failover. The default value is true. no shared-store
Thread Pool Max Size The number of threads that the main thread pool has. -1 means no limit. The default value is 30. no thread-pool-max-size:expr
Transaction Timeout How long (in ms) before a transaction can be removed from the resource manager after create time. The default value is 300000. no transaction-timeout
Transaction Timeout Scan Period How often (in ms) to scan for timeout transactions. The default value is 1000. no transaction-timeout-scan-period
Wild Card Routing Enabled Whether the server supports wild card routing. The default value is true. no wild-card-routing-enabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations

Table 3.513. Metrics

Name Description
Close Connections for Address Closes all the connections of clients connected to this server whose remote address contains the specified IP address. Returns true if any connections were closed, false otherwise.
Commit Prepared Transaction Heuristically commits a prepared transaction.
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. The returned String is a JSON string containing an array of address settings details.
Get Connectors as JSON Returns the connectors configured for this server using JSON serialization.
Get Last Sent Message ID Returns the ID of the last message sent from the given session to the given address.
Get Session Creation Time Gets the session's creation time. Returns the creation time, represented as a string showing the number of milliseconds since the epoch.
List All Consumers as JSON Lists all the consumers.
List Connection IDs Lists the IDs of all the connections connected to this server.
List Connections as JSON List all JMS connections.
List Consumers as JSON Lists all the consumers which belongs to the JMS Connection specified by the connection-id.
List Heuristic Committed Transactions Lists transactions which have been heuristically committed. Returns a list of strings. The Strings are Base-64 representation of the transaction XID.
List Heuristic Rolled Back Transactions Lists transactions which have been heuristically rolled back. Returns a list of strings. The Strings are Base-64 representation of the transaction XID.
List Prepared Transaction Details as HTML List all the prepared transaction, sorted by date, oldest first, with details, in HTML format.
List Prepared Transaction Details as JSON List all the prepared transaction, sorted by date, oldest first, with details, in JSON format.
List Prepared Transaction JMS Details as HTML List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format
List Prepared Transaction JMS details as JSON List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format
List Prepared Transactions List all the prepared transaction, sorted by date, oldest first. Returns 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.
List Producers Info as JSON For all sessions, lists information about message producers using JSON serialization.
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.
List Sessions Lists all the sessions IDs for the specified connection ID.
List Sessions as JSON Lists all the sessions IDs for the specified connection ID. The returned String is a JSON string containing an array of session ids.
List Target Destinations Lists all addresses to which the designated session has sent messages. The returned String is a JSON string containing an array of address names.
Reset All Message Counter Histories Reset all message counters history.
Reset All Message Counters Reset all message counters.
Rollback Prepared Transaction Heuristically rolls back a prepared transaction. Returns true if the transaction was successfully rolled back, false otherwise.
Package Types
none
3.3.12.4.1.1. JBoss AS 7 and EAP 6 - JMS Queue Runtime Service
Overview

Table 3.514. Overview

Description: Defines a JMS queue.
Singleton: no
Plugin: JBossAS7
Child Resource Types
none
Connection Properties

Table 3.515. 

Name Description Required Internal Name
Path yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 3.516. Metrics

Name Type Description Internal Name
Consumer Count measurement The number of consumers consuming messages from this queue. consumer-count
Dead Letter Address trait The address to send dead messages to. dead-letter-address
Delivering Count measurement The number of messages that this queue is currently delivering to its consumers. delivering-count
Durable trait Whether the queue is durable or not. The default value is true. durable
Expiry Address trait The address to send expired messages to. expiry-address
Message Count measurement The number of messages currently in this queue. message-count
Messages Added measurement The number of messages added to this queue since it was created. messages-added
Paused trait Whether the queue is paused. paused
Queue Address trait The queue address defines what address is used for routing messages. queue-address
Scheduled Count measurement The number of scheduled messages in this queue. scheduled-count
Selector trait The queue selector. selector
Temporary trait Whether the queue is temporary. temporary

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties

Table 3.517. 

Name Description Required Internal Name
Entries The jndi names the queue will be bound to. yes entries

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations

Table 3.518. Metrics

Name Description
Change Message Priority Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages Priority Change the priority of the messages corresponding to the given filter. Returns the number of removed messages.
Count Messages Returns the number of the messages in the queue matching the given filter.
Expire Message Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire Messages Expire the messages matching the given filter.
List Consumers as JSON A string in JSON format.
List Message Counter as HTML List the message counter as a string in HTML format.
List Message Counter as JSON List the message counter as a string in JSON format.
List Message Counter History as HTML List the message counter history.
List Message Counter History as JSON List the message counter history as a string in JSON format.
List Messages List all messages in the queue that match the filter
List Messages as JSON List all messages in the queue that match the filter and return them as a string in JSON format.
Move Message Move the message corresponding to the given message-id to another queue
Move Messages Move the messages corresponding to the given filter to another queue.
Pause Pause the queue.
Remove Message Remove the message corresponding to the given message-id.
Remove Messages Remove messages matching the given filter from the destination.
Reset Message Counter Reset the message counters.
Resume Resume the queue.
Send Message to Dead Letter Address Send the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter Address Send the messages corresponding to the given filter to this queue's Dead Letter Address.
Package Types
none
3.3.12.4.1.2. JBoss AS 7 and EAP 6 - JMS Topic Runtime Service
Overview

Table 3.519. Overview

Description: Defines a JMS queue.
Singleton: no
Plugin: JBossAS7
Child Resource Types
none
Connection Properties

Table 3.520. 

Name Description Required Internal Name
Path yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 3.521. Metrics

Name Type Description Internal Name
Delivering Count measurement The number of messages that this queue is currently delivering to its consumers. delivering-count
Durable Message Count measurement The number of messages for all durable subscribers for this topic. durable-message-count
Durable Subscription Count measurement The number of durable subscribers for this topic. durable-subscription-count
Message Count measurement The number of messages currently in this queue. message-count
Messages Added measurement The number of messages added to this queue since it was created. messages-added
Non Durable Message Count measurement The number of messages for all non-durable subscribers for this topic. non-durable-message-count
Non Durable Subscription Count measurement The number of non-durable subscribers for this topic. non-durable-subscription-count
Subscription Count measurement The number of (durable and non-durable) subscribers for this topic. subscription-count
Temporary trait Whether the topic is temporary. temporary
Topic Address trait The address the topic points to. topic-address

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties

Table 3.522. 

Name Description Required Internal Name
JNDI Names The jndi names the queue will be bound to. yes entries

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations

Table 3.523. Metrics

Name Description
Count Messages for Subscription Count the number of messages matching the filter for the given subscription.
Drop All Subscriptions Drop all subscriptions from this topic.
Drop Durable Subscription Drop a durable subscription
List All Subscriptions List all subscriptions.
List All Subscriptions as JSON List all subscriptions as a string in JSON format.
List Durable Subscriptions List only the durable subscriptions.
List Durable Subscriptions as JSON List only the durable subscriptions, as a string in JSON format.
List Messages for Subscription List all the messages for the given subscription.
List Messages for Subscription as JSON List all the messages for the given subscription as a string in JSON format.
List Non-Durable Subscriptions List only the non-durable subscriptions.
List Non-Durable Subscriptions as JSON List only the non-durable subscriptions, as a string in JSON format.
Remove Messages Remove messages matching the given filter from the destination.
Package Types
none