-
Language:
English
-
Language:
English
Red Hat Training
A Red Hat training course is available for Red Hat JBoss Operations Network
3.3.31. JBoss AS 7 and EAP 6 - Messaging Service
Overview
Table 3.810. Overview
| Description: | The messaging subsystems |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.811.
| 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.31.1. JBoss AS 7 and EAP 6 - HornetQ Service
Overview
Table 3.812. Overview
| Description: | The HornetQ based messaging subsystem |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.813.
| 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.814. 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.815.
| 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:nullable |
| 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.816. 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.31.1.1. JBoss AS 7 and EAP 6 - JMS Queue Service
Overview
Table 3.817. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.818.
| 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.819. 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 |
| 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 |
| Scheduled Count | measurement | The number of scheduled messages in this queue. | scheduled-count |
| Temporary | trait | Whether the queue is temporary. | temporary |
| Queue Address | trait | The queue address defines what address is used for routing messages. | queue-address |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.820.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Durable | Whether the queue is durable or not. The default value is true. | no | durable |
| Entries | The jndi names the queue will be bound to. | yes | entries |
| Selector | The queue selector. | no | selector |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.821. 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.31.1.2. JBoss AS 7 and EAP 6 - JMS Topic Service
Overview
Table 3.822. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.823.
| 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.824. 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.825.
| 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.826. 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
3.3.31.1.3. JBoss AS 7 and EAP 6 - Connection Factory Service
Overview
Table 3.827. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.828.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.829.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connector | Defines the connector to be used. This is mutually exclusive with discovery-group-name | no | connector:collapsed |
| JNDI Names | The jndi names the connection factory should be bound to. | yes | entries |
| Auto Group | Whether or not message grouping is automatically used. The default value is false. | no | auto-group |
| Block On Acknowledge | True to set block on acknowledge. The default value is false. | no | block-on-acknowledge |
| Block On Durable Send | True to set block on durable send. The default value is true. | no | block-on-durable-send |
| Block On Non Durable Send | True to set block on non durable send. The default value is false. | no | block-on-non-durable-send |
| Cache Large Message Client | True to cache large messages. The default value is false. | no | cache-large-message-client |
| Call Timeout | The call time out. The default value is 30000. | no | call-timeout |
| Client Failure Check Period | The client failure check period. The default value is 30000. | no | client-failure-check-period |
| Client Id | The client id. | no | client-id |
| Compress Large Messages | Whether large messages should be compressed. The default value is false. | no | compress-large-messages |
| Confirmation Window Size | The confirmation window size. The default value is -1. | no | confirmation-window-size |
| 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. The default value is org.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. | no | connection-load-balancing-policy-class-name |
| Connection Ttl | The connection ttl. The default value is 60000. | no | connection-ttl |
| Consumer Max Rate | The consumer max rate. The default value is -1. | no | consumer-max-rate |
| Consumer Window Size | The consumer window size. The default value is 1048576. | no | consumer-window-size |
| Discovery Group Name | The discovery group name. | no | discovery-group-name |
| Discovery Initial Wait Timeout | The discovery initial wait time out. | no | discovery-initial-wait-timeout |
| Dups Ok Batch Size | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size |
| Factory Type | The type of connection factory. | no | factory-type |
| Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
| Failover On Server Shutdown | True to fail over on server shutdown. | no | failover-on-server-shutdown |
| Group Id | The group id. | no | group-id |
| Ha | Whether the connection factory supports High Availability. The default value is false. | yes | ha |
| Initial Message Packet Size | The initial size of messages created through this factory. | yes | initial-message-packet-size |
| Max Retry Interval | The max retry interval. The default value is 2000. | no | max-retry-interval |
| Min Large Message Size | The min large message size. The default value is 102400. | no | min-large-message-size |
| Pre Acknowledge | True to pre-acknowledge. The default value is false. | no | pre-acknowledge |
| Producer Max Rate | The producer max rate. The default value is -1. | no | producer-max-rate |
| Producer Window Size | The producer window size. The default value is 65536. | no | producer-window-size |
| Reconnect Attempts | The reconnect attempts. The default value is 0. | no | reconnect-attempts |
| Retry Interval | The retry interval. The default value is 2000. | no | retry-interval |
| Retry Interval Multiplier | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier |
| Scheduled Thread Pool Max Size | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
| Thread Pool Max Size | The thread pool max size. The default value is 30. | no | thread-pool-max-size:expr |
| Transaction Batch Size | The transaction batch size. The default value is 1048576. | no | transaction-batch-size |
| Use Global Pools | True to use global pools. The default value is true. | no | use-global-pools |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.4. JBoss AS 7 and EAP 6 - Pooled Connection Factory Service
Overview
Table 3.830. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.831.
| 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
Table 3.832.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connector | Defines the connectors. These are stored in a map by connector name, with the backup connectors stored as the value, or an undefined value if there is no backup connector. | no | connector:collapsed |
| JNDI Names | The jndi names the connection factory should be bound to. | yes | entries |
| Auto Group | The autogroup. The default value is false. | no | auto-group |
| Block On Acknowledge | True to set block on acknowledge. The default value is false. | no | block-on-acknowledge |
| Block On Durable Send | True to set block on durable send. The default value is true. | no | block-on-durable-send |
| Block On Non Durable Send | True to set block on non durable send. The default value is false. | no | block-on-non-durable-send |
| Cache Large Message Client | True to cache large messages. The default value is false. | no | cache-large-message-client |
| Call Timeout | The call time out. The default value is 30000. | no | call-timeout |
| Client Failure Check Period | The client failure check period. The default value is 30000. | no | client-failure-check-period |
| Client Id | The client id. | no | client-id |
| Confirmation Window Size | The confirmation window size. The default value is -1. | no | confirmation-window-size |
| 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. The default value is org.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. | no | connection-load-balancing-policy-class-name |
| Connection Ttl | The connection ttl. The default value is 60000. | no | connection-ttl |
| Consumer Max Rate | The consumer max rate. The default value is -1. | no | consumer-max-rate |
| Consumer Window Size | The consumer window size. The default value is 1048576. | no | consumer-window-size |
| Discovery Group Name | The discovery group name. | no | discovery-group-name |
| Discovery Initial Wait Timeout | The discovery initial wait time out. | no | discovery-initial-wait-timeout |
| Dups Ok Batch Size | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size |
| Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
| Failover On Server Shutdown | True to fail over on server shutdown. | no | failover-on-server-shutdown |
| Group Id | The group id. | no | group-id |
| Ha | Whether the connection factory supports High Availability. The default value is false. | no | ha |
| Jndi Params | The JNDI params to use for locating the destination for incoming connections. | no | jndi-params |
| Max Pool Size | The maximum size for the pool. The default value is -1. | no | max-pool-size:expr |
| Max Retry Interval | The max retry interval. The default value is 2000. | no | max-retry-interval |
| Min Large Message Size | The min large message size. The default value is 102400. | no | min-large-message-size |
| Min Pool Size | The minimum size for the pool. The default value is -1. | no | min-pool-size:expr |
| Password | The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host. | no | password |
| Pre Acknowledge | True to pre-acknowledge. The default value is false. | no | pre-acknowledge |
| Producer Max Rate | The producer max rate. The default value is -1. | no | producer-max-rate |
| Producer Window Size | The producer window size. The default value is 65536. | no | producer-window-size |
| Reconnect Attempts | The reconnect attempts. The default value is 0. | no | reconnect-attempts |
| Retry Interval | The retry interval. The default value is 2000. | no | retry-interval |
| Retry Interval Multiplier | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier |
| Scheduled Thread Pool Max Size | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
| Setup Attempts | The number of times to set up an MDB endpoint | no | setup-attempts |
| Setup Interval | The interval between attempts at setting up an MDB endpoint. | no | setup-interval |
| Thread Pool Max Size | The thread pool max size. The default value is 30. | no | thread-pool-max-size:expr |
| Transaction | TODO. The default value is transaction. | no | transaction |
| Transaction Batch Size | The transaction batch size. The default value is 1048576. | no | transaction-batch-size |
| Use Global Pools | True to use global pools. The default value is true. | no | use-global-pools |
| Use Jndi | Use JNDI to locate the destination for incoming connections | no | use-jndi |
| Use Local Tx | Use a local transaction for incoming sessions | no | use-local-tx |
| User | The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host. | no | user |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.5. JBoss AS 7 and EAP 6 - Security Setting Service
Overview
Table 3.833. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.834.
| 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.31.1.5.1. JBoss AS 7 and EAP 6 - Role Service
Table 3.835. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.836.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.837.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Consume | his permission allows the user to consume a message from a queue bound to matching addresses. The default value is false. | yes | consume |
| Create Durable Queue | This permission allows the user to create a durable queue. The default value is false. | yes | create-durable-queue |
| Create Non Durable Queue | This permission allows the user to create a temporary queue. The default value is false. | yes | create-non-durable-queue |
| Delete Durable Queue | This permission allows the user to delete a durable queue. The default value is false. | yes | delete-durable-queue |
| Delete Non Durable Queue | This permission allows the user to delete a temporary queue. The default value is false. | yes | delete-non-durable-queue |
| Manage | This permission allows the user to invoke management operations by sending management messages to the management address. The default value is false. | yes | manage |
| Send | This permission allows the user to send a message to matching addresses. The default value is false. | yes | send |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.31.1.6. JBoss AS 7 and EAP 6 - Address Setting Service
Overview
Table 3.838. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.839.
| 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
Table 3.840.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Address Full Policy | Determines what happens when an address where max-size-bytes is specified becomes full. (PAGE, DROP or BLOCK). The default value is PAGE. | no | address-full-policy |
| Dead Letter Address | The dead letter address | no | dead-letter-address |
| Expiry Address | Defines where to send a message that has expired. | no | expiry-address |
| Last Value Queue | Defines whether a queue only uses last values or not. The default value is false. | no | last-value-queue |
| Max Delivery Attempts | Defines how many time a cancelled message can be redelivered before sending to the dead-letter-address. The default value is 10. | no | max-delivery-attempts |
| Max Size Bytes | The max bytes size. The default value is -1. | no | max-size-bytes |
| Message Counter History Day Limit | Day limit for the message counter history. The default value is 0. | no | message-counter-history-day-limit |
| Page Max Cache Size | The number of page files to keep in memory to optimize IO during paging navigation. The default value is 5. | no | page-max-cache-size |
| Page Size Bytes | The paging size. The default value is 10485760. | no | page-size-bytes |
| Redelivery Delay | Defines how long to wait before attempting redelivery of a cancelled message. The default value is 0. | no | redelivery-delay |
| Redistribution Delay | Defines how long to wait when the last consumer is closed on a queue before redistributing any messages. The default value is -1. | no | redistribution-delay |
| Send To Dla On No Route | 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. The default value is false. | no | send-to-dla-on-no-route |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.7. JBoss AS 7 and EAP 6 - Grouping Handler Service
Overview
Table 3.841. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.842.
| 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
Table 3.843.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Grouping Handler Address | A reference to a cluster connection and the address it uses. | yes | grouping-handler-address |
| Timeout | How long to wait for a handling decision to be made; an exception will be thrown during the send if this timeout is reached, ensuring that strict ordering is kept. The default value is 5000. | no | timeout |
| Type | Whether the handler is the single 'Local' handler for the cluster, which makes handling decisions, or a 'Remote' handler which converses with the local handler. | no | type |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.8. JBoss AS 7 and EAP 6 - Acceptor Service
Overview
Table 3.844. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.845.
| 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.846. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether this acceptor is started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.847.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Factory Class | The factory class. | yes | factory-class |
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.848. Metrics
| Name | Description |
|---|---|
| Start | Starts the acceptor. |
| Stop | Stops the acceptor. |
Package Types
none
3.3.31.1.8.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.849. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.850.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.851.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.31.1.9. JBoss AS 7 and EAP 6 - Connector (HornetQ) Service
Overview
Table 3.852. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.853.
| 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
Table 3.854.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Factory Class | The factory class. | yes | factory-class |
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.9.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.855. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.856.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.857.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.31.1.10. JBoss AS 7 and EAP 6 - In VM Acceptor Service
Overview
Table 3.858. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.859.
| 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.860. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether it's stopped or started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.861.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Server Id | The server id. | yes | server-id |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.862. Metrics
| Name | Description |
|---|---|
| Start | Starts the acceptor. |
| Stop | Stops the acceptor. |
Package Types
none
3.3.31.1.10.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.863. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.864.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.865.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.31.1.11. JBoss AS 7 and EAP 6 - In VM Connector Service
Overview
Table 3.866. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.867.
| 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
Table 3.868.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Server Id | The server id. | yes | server-id |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.11.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.869. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.870.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.871.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.31.1.12. JBoss AS 7 and EAP 6 - Remote Acceptor Service
Overview
Table 3.872. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.873.
| 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.874. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether this acceptor is started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.875.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.876. Metrics
| Name | Description |
|---|---|
| Start | Starts the acceptor. |
| Stop | Stops the acceptor. |
Package Types
none
3.3.31.1.12.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.877. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.878.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.879.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.31.1.13. JBoss AS 7 and EAP 6 - Remote Connector Service
Overview
Table 3.880. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.881.
| 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
Table 3.882.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.13.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.883. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.884.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.885.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.31.1.14. JBoss AS 7 and EAP 6 - Divert Service
Overview
Table 3.886. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.887.
| 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
Table 3.888.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Divert Address | Address to divert from | yes | divert-address |
| Exclusive | Whether the divert is exclusive, meaning that the message is diverted to the new address, and does not go to the old address at all. The default value is false. | no | exclusive |
| Filter | An optional filter string. If specified then only messages which match the filter expression specified will be diverted. The filter string follows the HornetQ filter expression syntax described in the HornetQ documentation. | no | filter |
| Forwarding Address | Address to divert to | yes | forwarding-address |
| Routing Name | Routing name of the divert | no | routing-name |
| Transformer Class Name | The name of a class used to transform the message's body or properties before it is diverted. | no | transformer-class-name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.15. JBoss AS 7 and EAP 6 - Queue Service
Overview
Table 3.889. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.890.
| 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.891. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Id | trait | The id of the queue. | id |
| Paused | trait | Whether the queue is paused. | paused |
| 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.892.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Durable | Defines whether the queue is durable. The default value is true. | no | durable |
| Filter | A queue message filter definition. An undefined or empty filter will match all messages. | no | filter |
| Queue Address | The queue address defines what address is used for routing messages. | yes | queue-address |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.893. 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. |
| 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. |
| List Scheduled Messages | List the messages scheduled for delivery. |
| List Scheduled Messages as JSON | List the messages scheduled for delivery 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.31.1.16. JBoss AS 7 and EAP 6 - Core Address Service
Overview
Table 3.894. Overview
| Description: | A runtime-only resource representing a HornetQ 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. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.895.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.896.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Binding Names | The names of all bindings (both queues and diverts) bound to this address. | yes | binding-names |
| Number Of Bytes Per Page | The number of bytes used by each page for this address. | yes | number-of-bytes-per-page |
| Number Of Pages | The number of pages used by this address. | yes | number-of-pages |
| Queue Names | The names of the queues associated with the address. | yes | queue-names |
| Roles | A list of the security roles (name and permissions) associated with the address. | yes | roles |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.17. JBoss AS 7 and EAP 6 - Cluster Connection Service
Overview
Table 3.897. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.898.
| 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.899. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Node Id | trait | The node ID used by this cluster connection. | node-id |
| Started | trait | Whether the cluster connection is started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.900.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Call Timeout | The timeout (in ms) for remote calls made by the cluster connection. The default value is 30000. | no | call-timeout |
| Check Period | The period (in milliseconds) between client failure check. The default value is 30000. | no | check-period |
| Cluster Connection Address | Each cluster connection only applies to messages sent to an address that starts with this value. | yes | cluster-connection-address |
| Confirmation Window Size | The confirmation-window-size to use for the connection used to forward messages to a target node. The default value is 1048576. | no | confirmation-window-size |
| 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 value is 60000. | no | connection-ttl |
| Connector Ref | The confirmation-window-size to use for the connection used to forward messages to a target node. | yes | connector-ref |
| Discovery Group Name | 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. | no | discovery-group-name |
| Forward When No Consumers | Whether messages will be distributed round robin between other nodes of the cluster irrespective of whether there are matching or indeed any consumers on other nodes. If this is set to false (the default) then HornetQ will only forward messages to other nodes of the cluster if the address to which they are being forwarded has queues which have consumers, and if those consumers have message filters (selectors) at least one of those selectors must match the message. The default value is false. | no | forward-when-no-consumers |
| Max Hops | The maximum number of times a message can be forwarded. HornetQ can be configured to also load balance messages to nodes which might be connected to it only indirectly with other HornetQ servers as intermediates in a chain. The default value is 1. | no | max-hops |
| Max Retry Interval | The maximum interval of time used to retry connections. The default value is 2000. | no | max-retry-interval |
| Min Large Message Size | The minimum size (in bytes) for a message before it is considered as a large message. The default value is 102400. | no | min-large-message-size |
| Reconnect Attempts | The total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts. The default value is -1. | no | reconnect-attempts |
| Retry Interval | The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed. The default value is 500. | no | retry-interval |
| Retry Interval Multiplier | A multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts. The default value is 1.0. | no | retry-interval-multiplier |
| Static Connectors | The statically defined list of connectors to which this cluster connection will make connections. Must be undefined (null) if 'discovery-group-name' is defined. | no | static-connectors:nullable |
| Use Duplicate Detection | Whether the bridge will automatically insert a duplicate id property into each message that it forwards. The default value is true. | no | use-duplicate-detection |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.901. Metrics
| Name | Description |
|---|---|
| Get Nodes | Returns a map of the nodes connected to this cluster connection, where keys are node IDs and values are the addresses used to connect to the nodes. |
| Start | Starts the cluster connection. |
| Stop | Stops the cluster connection. |
Package Types
none
3.3.31.1.18. JBoss AS 7 and EAP 6 - Broadcast Group Service
Overview
Table 3.902. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.903.
| 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.904. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether the broadcast group is started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.905.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Broadcast Period | The period in milliseconds between consecutive broadcasts. The default value is 2000. | no | broadcast-period |
| Connectors | Specifies the names of connectors that will be broadcast. | no | connectors |
| Socket Binding | The broadcast group socket binding. | yes | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.906. Metrics
| Name | Description |
|---|---|
| Get Connector Pairs as JSON | Returns the pairs of live-backup connectors that are broadcasted by this broadcast group using JSON serialization. |
| Start | Starts the broadcast group. |
| Stop | Stops the broadcast group. |
Package Types
none
3.3.31.1.19. JBoss AS 7 and EAP 6 - Path Service
Overview
Table 3.907. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.908.
| 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
Table 3.909.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.
If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:
If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory. | yes | path |
| Relative To | The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:
| no | relative-to |
| Path Type | Path Type | yes | __name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.20. JBoss AS 7 and EAP 6 - Bridge Service
Overview
Table 3.910. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.911.
| 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.912. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether the bridge is started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.913.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Check Period | The period (in milliseconds) between client failure check. The default value is 30000. | no | check-period |
| Confirmation Window Size | The confirmation-window-size to use for the connection used to forward messages to the target node. The default value is 1048576. | no | confirmation-window-size |
| Connection Ttl | The maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat). The default value is 60000. | no | connection-ttl |
| Discovery Group Name | The name of the discovery group used by this bridge. Must be undefined (null) if 'static-connectors' is defined. | no | discovery-group-name |
| Failover On Server Shutdown | Whether the bridge will attempt to failover onto a backup server (if specified) when the target server is cleanly shutdown rather than crashed. | no | failover-on-server-shutdown |
| Filter | An optional filter string. If specified then only messages which match the filter expression specified will be forwarded. The filter string follows the HornetQ filter expression syntax described in the HornetQ documentation. | no | filter |
| 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. | no | forwarding-address |
| Ha | Whether or not this bridge should support high availability. True means it will connect to any available server in a cluster and support failover. The default value is false. | no | ha |
| Max Retry Interval | The maximum interval of time used to retry connections. The default value is 2000. | no | max-retry-interval |
| Min Large Message Size | The minimum size (in bytes) for a message before it is considered as a large message. The default value is 102400. | no | min-large-message-size |
| Password | The password to use when creating the bridge connection to the remote server. If it is not specified the default cluster password specified by the cluster-password attribute in the root messaging subsystem resource will be used. The default value is CHANGE ME!!. | no | password |
| Queue Name | The unique name of the local queue that the bridge consumes from. | yes | queue-name |
| Reconnect Attempts | The total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts. The default value is -1. | no | reconnect-attempts |
| Retry Interval | The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed. The default value is 2000. | no | retry-interval |
| Retry Interval Multiplier | A multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts. The default value is 1.0. | no | retry-interval-multiplier |
| Static Connectors | A list of names of statically defined connectors used by this bridge. Must be undefined (null) if 'discovery-group-name' is defined. | no | static-connectors:nullable |
| Transformer Class Name | The name of a user-defined class which implements the org.hornetq.core.server.cluster.Transformer interface. | no | transformer-class-name |
| Use Duplicate Detection | Whether the bridge will automatically insert a duplicate id property into each message that it forwards. The default value is true. | no | use-duplicate-detection |
| User | The user name to use when creating the bridge connection to the remote server. If it is not specified the default cluster user specified by the cluster-user attribute in the root messaging subsystem resource will be used. The default value is HORNETQ.CLUSTER.ADMIN.USER. | no | user |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.914. Metrics
| Name | Description |
|---|---|
| Start | Starts the bridge. |
| Stop | Stops the bridge. |
Package Types
none
3.3.31.1.21. JBoss AS 7 and EAP 6 - Discovery Group Service
Overview
Table 3.915. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.916.
| 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
Table 3.917.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Initial Wait Timeout | Period, in ms, to wait for an initial broadcast to give us at least one node in the cluster. The default value is 10000. | no | initial-wait-timeout |
| Refresh Timeout | Period the discovery group waits after receiving the last broadcast from a particular server before removing that server's connector pair entry from its list. The default value is 10000. | no | refresh-timeout |
| Socket Binding | The discovery group socket binding. | yes | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.22. JBoss AS 7 and EAP 6 - Connector Service
Overview
Table 3.918. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.919.
| 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
Table 3.920.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Factory Class | Class name of the factory class that can instantiate the connector service. | yes | factory-class |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.22.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.921. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.922.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.923.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
