JBoss EAP 6.0 Model Reference

  1. JBoss EAP 6.0
  2. subsystem=messaging
  3. hornetq-server
  4. cluster-connection

Cluster connections group servers into clusters so that messages can be load balanced between the nodes of the cluster.

Attributes (20)

  • allow-direct-connections-only Whether, if a node learns of the existence of a node that is more than 1 hop away, we do not create a bridge for direct cluster connection. Only relevant if 'static-connectors' is defined.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • call-timeout The timeout (in ms) for remote calls made by the cluster connection.
    • Attribute Value
    Default Value 30000
    Type LONG
    Nillable true
    Expressions Allowed false
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • check-period The period (in milliseconds) between client failure check.
    • Attribute Value
    Default Value 30000
    Type LONG
    Nillable true
    Expressions Allowed false
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • cluster-connection-address Each cluster connection only applies to messages sent to an address that starts with this value.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • confirmation-window-size The confirmation-window-size to use for the connection used to forward messages to a target node.
    • Attribute Value
    Default Value 1048576
    Type INT
    Nillable true
    Expressions Allowed false
    Unit BYTES
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • connection-ttl The maximum time (in milliseconds) for which the connections used by the cluster connections are considered alive (in the absence of heartbeat).
    • Attribute Value
    Default Value 60000
    Type LONG
    Nillable true
    Expressions Allowed false
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • connector-ref The confirmation-window-size to use for the connection used to forward messages to a target node.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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.
    • Attribute Value
    Default Value 1
    Type INT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • max-retry-interval The maximum interval of time used to retry connections
    • Attribute Value
    Default Value 2000
    Type LONG
    Nillable true
    Expressions Allowed false
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • min-large-message-size The minimum size (in bytes) for a message before it is considered as a large message.
    • Attribute Value
    Default Value 102400
    Type INT
    Nillable true
    Expressions Allowed false
    Unit BYTES
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • node-id The node ID used by this cluster connection.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-only
  • 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.
    • Attribute Value
    Default Value -1
    Type INT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • retry-interval The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed.
    • Attribute Value
    Default Value 500
    Type LONG
    Nillable true
    Expressions Allowed false
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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.
    • Attribute Value
    Default Value 1.0
    Type BIG_DECIMAL
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • started Whether the cluster connection is started.
    • Attribute Value
    Type BOOLEAN
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-only
  • 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.
    • Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • topology The topology of the nodes that this cluster connection is aware of.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-only
  • use-duplicate-detection Whether the bridge will automatically insert a duplicate id property into each message that it forwards.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services

Operations (2)

  • add Operation adding a cluster connection
    Request Parameter Type Required Expressions Allowed Default value Description
    cluster-connection-address STRING true false Each cluster connection only applies to messages sent to an address that starts with this value.
    connector-ref STRING true false The confirmation-window-size to use for the connection used to forward messages to a target node.
    min-large-message-size INT false false The minimum size (in bytes) for a message before it is considered as a large message.
    connection-ttl LONG false false The maximum time (in milliseconds) for which the connections used by the cluster connections are considered alive (in the absence of heartbeat).
    retry-interval LONG false false The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed.
    retry-interval-multiplier BIG_DECIMAL false false 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.
    max-retry-interval LONG false false The maximum interval of time used to retry connections
    reconnect-attempts INT false false 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.
    use-duplicate-detection BOOLEAN false false Whether the bridge will automatically insert a duplicate id property into each message that it forwards.
    check-period LONG false false The period (in milliseconds) between client failure check.
    call-timeout LONG false false The timeout (in ms) for remote calls made by the cluster connection.
    forward-when-no-consumers BOOLEAN false false 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.
    max-hops INT false false 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.
    confirmation-window-size INT false false The confirmation-window-size to use for the connection used to forward messages to a target node.
    static-connectors LIST false false The statically defined list of connectors to which this cluster connection will make connections. Must be undefined (null) if 'discovery-group-name' is defined.
    discovery-group-name STRING false false 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.
    allow-direct-connections-only BOOLEAN false false Whether, if a node learns of the existence of a node that is more than 1 hop away, we do not create a bridge for direct cluster connection. Only relevant if 'static-connectors' is defined.
  • remove Operation removing a cluster connection