JBoss EAP 6.3 Model Reference

  1. JBoss EAP 6.3
  2. subsystem=messaging
  3. hornetq-server

A HornetQ server instance.

Children (22)

  • acceptor An acceptor defines a way in which connections can be made to the HornetQ server.
  • address-setting An address setting defines some attributes that are defined against an address wildcard rather than a specific queue.
  • bridge The function of a bridge is to consume messages from a source queue, and forward them to a target address, typically on a different HornetQ server.
  • broadcast-group A broadcast group is the means by which a server broadcasts connectors over the network.
  • cluster-connection Cluster connections group servers into clusters so that messages can be load balanced between the nodes of the cluster.
  • connection-factory Defines a connection factory.
  • connector A connector can be used by a client to define how it connects to a server.
  • connector-service TODO
  • discovery-group Multicast group to listen to receive broadcast from other servers announcing their connectors.
  • divert A messaging resource that allows you to transparently divert messages routed to one address to some other address, without making any changes to any client application logic.
  • grouping-handler Makes decisions about which node in a cluster should handle a message with a group id assigned.
  • in-vm-acceptor Defines a way in which in-VM connections can be made to the HornetQ server.
  • in-vm-connector Used by an in-VM client to define how it connects to a server.
  • jms-queue Defines a JMS queue.
  • jms-topic Defines a JMS topic.
  • path A filesystem path pointing to one of the locations where HornetQ stores persistent data.
    • bindings-directory The directory in which the bindings journal lives. The default is ${jboss.server.data.dir}/messagingbindings.
    • journal-directory The directory in which the message journal lives. The default is ${jboss.server.data.dir}/messagingjournal.
    • large-messages-directory The directory in which large messages are stored. The default is ${jboss.server.data.dir}/messaginglargemessages.
    • paging-directory The directory where page files are stored. The default is ${jboss.server.data.dir}/messagingpaging.
  • pooled-connection-factory Defines a managed connection factory.
  • queue A Queue.
  • remote-acceptor Defines a way in which remote connections can be made to the HornetQ server.
  • remote-connector Used by a remote client to define how it connects to a server.
  • runtime-queue A runtime queue.
  • security-setting A security setting allows sets of permissions to be defined against queues based on their address.

Attributes (58)

  • allow-failback Whether this server will automatically shutdown if the original live server comes back up.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • async-connection-execution-enabled Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • backup Whether this server is a backup server.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • backup-group-name The name of a set of live/backups that should replicate with each other
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • check-for-live-server If a replicated live server should check the current cluster to see if there is already a live server with the same node id
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • cluster-password The password used by cluster connections to communicate between the clustered nodes.
    • Attribute Value
    Default Value CHANGE ME!!
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • cluster-user The user used by cluster connections to communicate between the clustered nodes.
    • Attribute Value
    Default Value HORNETQ.CLUSTER.ADMIN.USER
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • clustered Whether the server is clustered.
    • Deprecated Since 1.2.0
    To create a clustered HornetQ server, define at least one cluster-connection.
    Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • connection-ttl-override If set, this will override how long (in ms) to keep a connection alive without receiving a ping.
    • Attribute Value
    Default Value -1
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • create-bindings-dir Whether the server should create the bindings directory on start up.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • create-journal-dir Whether the server should create the journal directory on start up.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • failback-delay How long to wait before failback occurs on live server restart.
    • Attribute Value
    Default Value 5000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • failover-on-shutdown Whether this backup server (if it is a backup server) should come live on a normal server shutdown.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • id-cache-size The size of the cache for pre-creating message IDs.
    • Attribute Value
    Default Value 20000
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • jmx-domain The JMX domain used to register internal HornetQ MBeans in the MBeanServer.
    • Attribute Value
    Default Value org.hornetq
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • journal-buffer-size The size of the internal buffer on the journal.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit BYTES
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • journal-buffer-timeout The timeout (in nanoseconds) used to flush internal buffers on the journal.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • journal-compact-min-files The minimal number of journal data files before we can start compacting.
    • Attribute Value
    Default Value 10
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • journal-compact-percentage The percentage of live data on which we consider compacting the journal.
    • Attribute Value
    Default Value 30
    Type INT
    Nillable true
    Expressions Allowed true
    Unit PERCENTAGE
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • journal-file-size The size (in bytes) of each journal file.
    • Attribute Value
    Default Value 10485760
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit BYTES
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • journal-max-io The maximum number of write requests that can be in the AIO queue at any one time.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • journal-min-files How many journal files to pre-create.
    • Attribute Value
    Default Value 2
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • journal-sync-non-transactional Whether to wait for non transaction data to be synced to the journal before returning a response to the client.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • journal-sync-transactional Whether to wait for transaction data to be synchronized to the journal before returning a response to the client.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • journal-type The type of journal to use.
    • Attribute Value
    Default Value ASYNCIO
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Allowed Values NIO
    ASYNCIO
  • 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".
    • Deprecated Since 1.2.0
    Has no runtime effect and a warning will be issued if an attempt is made to set the value of this attribute.
    Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • log-journal-write-rate Whether to periodically log the journal's write rate and flush rate.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • management-address Address to send management messages to.
    • Attribute Value
    Default Value jms.queue.hornetq.management
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • management-notification-address The name of the address that consumers bind to to receive management notifications.
    • Attribute Value
    Default Value hornetq.notifications
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • max-saved-replicated-journal-size The maximum number of backup journals to keep after failback occurs.
    • Attribute Value
    Default Value 2
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • memory-measure-interval Frequency to sample JVM memory in ms (or -1 to disable memory sampling)
    • Attribute Value
    Default Value -1
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • memory-warning-threshold Percentage of available memory which if exceeded results in a warning log
    • Attribute Value
    Default Value 25
    Type INT
    Nillable true
    Expressions Allowed true
    Unit PERCENTAGE
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • message-counter-enabled Whether message counters are enabled.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • message-counter-max-day-history How many days to keep message counter history.
    • Attribute Value
    Default Value 10
    Type INT
    Nillable true
    Expressions Allowed true
    Unit DAYS
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • message-counter-sample-period The sample period (in ms) to use for message counters.
    • Attribute Value
    Default Value 10000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • message-expiry-scan-period How often (in ms) to scan for expired messages.
    • Attribute Value
    Default Value 30000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • message-expiry-thread-priority The priority of the thread expiring messages.
    • Attribute Value
    Default Value 3
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • page-max-concurrent-io The maximum number of concurrent reads allowed on paging
    • Attribute Value
    Default Value 5
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • perf-blast-pages TODO
    • Attribute Value
    Default Value -1
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • persist-delivery-count-before-delivery Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • persist-id-cache Whether IDs are persisted to the journal.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • persistence-enabled Whether the server will use the file based journal for persistence.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • remoting-incoming-interceptors The list of incoming interceptor classes used by this server.
    • Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • remoting-interceptors The list of interceptor classes used by this server.
    • Deprecated Since 1.2.0
    Deprecated. Use remoting-incoming-interceptors instead.
    Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • remoting-outgoing-interceptors The list of outgoing interceptor classes used by this server.
    • Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • replication-clustername The name of the cluster connection to replicate from if more than one cluster connection is configured
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • run-sync-speed-test Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • scheduled-thread-pool-max-size The number of threads that the main scheduled thread pool has.
    • Attribute Value
    Default Value 5
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • security-domain The security domain to use to verify user and role information
    • Attribute Value
    Default Value other
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • security-enabled Whether security is enabled.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • security-invalidation-interval How long (in ms) to wait before invalidating the security cache.
    • Attribute Value
    Default Value 10000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • server-dump-interval How often to dump basic runtime information to the server log. A value less than 1 disables this feature.
    • Attribute Value
    Default Value -1
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • shared-store Whether this server is using a shared store for failover.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • thread-pool-max-size The number of threads that the main thread pool has. -1 means no limit.
    • Attribute Value
    Default Value 30
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • transaction-timeout How long (in ms) before a transaction can be removed from the resource manager after create time.
    • Attribute Value
    Default Value 300000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • transaction-timeout-scan-period How often (in ms) to scan for timeout transactions.
    • Attribute Value
    Default Value 1000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • wild-card-routing-enabled Whether the server supports wild card routing.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services

Operations (2)

  • add Operation adding a HornetQ server.
    Request Parameter Type Required Expressions Allowed Default value Description
    shared-store BOOLEAN false true true Whether this server is using a shared store for failover.
    thread-pool-max-size INT false true 30 The number of threads that the main thread pool has. -1 means no limit.
    clustered BOOLEAN false false false Whether the server is clustered.
    remoting-interceptors LIST false false The list of interceptor classes used by this server.
    create-bindings-dir BOOLEAN false true true Whether the server should create the bindings directory on start up.
    journal-buffer-size LONG false true The size of the internal buffer on the journal.
    security-invalidation-interval LONG false true 10000 How long (in ms) to wait before invalidating the security cache.
    message-counter-enabled BOOLEAN false true false Whether message counters are enabled.
    journal-type STRING false true ASYNCIO The type of journal to use.
    journal-sync-transactional BOOLEAN false true true Whether to wait for transaction data to be synchronized to the journal before returning a response to the client.
    journal-compact-min-files INT false true 10 The minimal number of journal data files before we can start compacting.
    max-saved-replicated-journal-size INT false true 2 The maximum number of backup journals to keep after failback occurs.
    log-journal-write-rate BOOLEAN false true false Whether to periodically log the journal's write rate and flush rate.
    journal-max-io INT false true The maximum number of write requests that can be in the AIO queue at any one time.
    scheduled-thread-pool-max-size INT false true 5 The number of threads that the main scheduled thread pool has.
    security-enabled BOOLEAN false true true Whether security is enabled.
    memory-warning-threshold INT false true 25 Percentage of available memory which if exceeded results in a warning log
    journal-compact-percentage INT false true 30 The percentage of live data on which we consider compacting the journal.
    failover-on-shutdown BOOLEAN false true false Whether this backup server (if it is a backup server) should come live on a normal server shutdown.
    backup-group-name STRING false true The name of a set of live/backups that should replicate with each other
    cluster-user STRING false true HORNETQ.CLUSTER.ADMIN.USER The user used by cluster connections to communicate between the clustered nodes.
    run-sync-speed-test BOOLEAN false true false Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues.
    jmx-domain STRING false true org.hornetq The JMX domain used to register internal HornetQ MBeans in the MBeanServer.
    transaction-timeout LONG false true 300000 How long (in ms) before a transaction can be removed from the resource manager after create time.
    cluster-password STRING false true CHANGE ME!! The password used by cluster connections to communicate between the clustered nodes.
    create-journal-dir BOOLEAN false true true Whether the server should create the journal directory on start up.
    message-counter-sample-period LONG false true 10000 The sample period (in ms) to use for message counters.
    connection-ttl-override LONG false true -1 If set, this will override how long (in ms) to keep a connection alive without receiving a ping.
    persistence-enabled BOOLEAN false true true Whether the server will use the file based journal for persistence.
    allow-failback BOOLEAN false true true Whether this server will automatically shutdown if the original live server comes back up.
    remoting-outgoing-interceptors LIST false false The list of outgoing interceptor classes used by this server.
    transaction-timeout-scan-period LONG false true 1000 How often (in ms) to scan for timeout transactions.
    persist-delivery-count-before-delivery BOOLEAN false true false Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled.
    page-max-concurrent-io INT false true 5 The maximum number of concurrent reads allowed on paging
    journal-min-files INT false true 2 How many journal files to pre-create.
    check-for-live-server BOOLEAN false true false If a replicated live server should check the current cluster to see if there is already a live server with the same node id
    management-notification-address STRING false true hornetq.notifications The name of the address that consumers bind to to receive management notifications.
    journal-buffer-timeout LONG false true The timeout (in nanoseconds) used to flush internal buffers on the journal.
    management-address STRING false true jms.queue.hornetq.management Address to send management messages to.
    journal-file-size LONG false true 10485760 The size (in bytes) of each journal file.
    journal-sync-non-transactional BOOLEAN false true true Whether to wait for non transaction data to be synced to the journal before returning a response to the client.
    persist-id-cache BOOLEAN false true true Whether IDs are persisted to the journal.
    backup BOOLEAN false true false Whether this server is a backup server.
    jmx-management-enabled BOOLEAN false true false Whether HornetQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration.
    async-connection-execution-enabled BOOLEAN false true true Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread.
    perf-blast-pages INT false true -1 TODO
    memory-measure-interval LONG false true -1 Frequency to sample JVM memory in ms (or -1 to disable memory sampling)
    server-dump-interval LONG false true -1 How often to dump basic runtime information to the server log. A value less than 1 disables this feature.
    message-expiry-thread-priority INT false true 3 The priority of the thread expiring messages.
    live-connector-ref STRING false false 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".
    replication-clustername STRING false true The name of the cluster connection to replicate from if more than one cluster connection is configured
    failback-delay LONG false true 5000 How long to wait before failback occurs on live server restart.
    id-cache-size INT false true 20000 The size of the cache for pre-creating message IDs.
    security-domain STRING false false other The security domain to use to verify user and role information
    message-expiry-scan-period LONG false true 30000 How often (in ms) to scan for expired messages.
    remoting-incoming-interceptors LIST false false The list of incoming interceptor classes used by this server.
    wild-card-routing-enabled BOOLEAN false true true Whether the server supports wild card routing.
    message-counter-max-day-history INT false true 10 How many days to keep message counter history.
  • remove Operation removing a HornetQ server.