WildFly Full 26.1 Model Reference

  1. home
  2. subsystem=messaging-activemq
  3. server
  4. cluster-connection

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

Attributes (25)

  • 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 true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • call-failover-timeout The timeout to use when fail over is in process (in ms) for remote calls made by the cluster connection.
    • Attribute Value
    Default Value -1
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    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 true
    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 true
    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 true
    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 10485760
    Type INT
    Nillable true
    Expressions Allowed true
    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 true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • connector-name The name of connector to use for live connection
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • discovery-group The discovery group used to obtain the list of other servers in the cluster to which this cluster connection will make connections. Must be undefined (null) if 'static-connectors' is defined.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • initial-connect-attempts The number of attempts to connect initially with this cluster connection.
    • Attribute Value
    Default Value -1
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • max-hops The maximum number of times a message can be forwarded. ActiveMQ can be configured to also load balance messages to nodes which might be connected to it only indirectly with other ActiveMQ servers as intermediates in a chain.
    • Attribute Value
    Default Value 1
    Type INT
    Nillable true
    Expressions Allowed true
    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 true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • message-load-balancing-type The type of message load balancing provided by the cluster connection.
    • Attribute Value
    Default Value ON_DEMAND
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Allowed Values OFF
    STRICT
    ON_DEMAND
  • 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 true
    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 runtime
    Access Type read-only
  • notification-attempts How many times the cluster connection will broadcast itself
    • Attribute Value
    Default Value 2
    Type INT
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • notification-interval How often the cluster connection will broadcast itself
    • Attribute Value
    Default Value 1000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • producer-window-size Producer flow control size on the cluster connection.
    • Attribute Value
    Default Value -1
    Type INT
    Nillable true
    Expressions Allowed true
    Unit BYTES
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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 true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • retry-interval The period in milliseconds between subsequent attempts to reconnect to a target server, if the connection to the target server has failed.
    • Attribute Value
    Default Value 500
    Type LONG
    Nillable true
    Expressions Allowed true
    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 DOUBLE
    Nillable true
    Expressions Allowed true
    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 runtime
    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 runtime
    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 true
    Storage configuration
    Access Type read-write
    Restart Required all-services

Operations (5)

  • add Operation adding a cluster connection
    Request Parameter Type Required Expressions Allowed Default value Description
    allow-direct-connections-only BOOLEAN false true 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.
    call-failover-timeout LONG false true -1 The timeout to use when fail over is in process (in ms) for remote calls made by the cluster connection.
    call-timeout LONG false true 30000 The timeout (in ms) for remote calls made by the cluster connection.
    check-period LONG false true 30000 The period (in milliseconds) between client failure check.
    cluster-connection-address STRING true true Each cluster connection only applies to messages sent to an address that starts with this value.
    confirmation-window-size INT false true 10485760 The confirmation-window-size to use for the connection used to forward messages to a target node.
    connection-ttl LONG false true 60000 The maximum time (in milliseconds) for which the connections used by the cluster connections are considered alive (in the absence of heartbeat).
    connector-name STRING true false The name of connector to use for live connection
    discovery-group STRING true 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.
    initial-connect-attempts INT false true -1 The number of attempts to connect initially with this cluster connection.
    max-hops INT false true 1 The maximum number of times a message can be forwarded. ActiveMQ can be configured to also load balance messages to nodes which might be connected to it only indirectly with other ActiveMQ servers as intermediates in a chain.
    max-retry-interval LONG false true 2000 The maximum interval of time used to retry connections
    message-load-balancing-type STRING false true ON_DEMAND The type of message load balancing provided by the cluster connection.
    min-large-message-size INT false true 102400 The minimum size (in bytes) for a message before it is considered as a large message.
    notification-attempts INT false true 2 How many times the cluster connection will broadcast itself
    notification-interval LONG false true 1000 How often the cluster connection will broadcast itself
    producer-window-size INT false true -1 Producer flow control size on the cluster connection.
    reconnect-attempts INT false true -1 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.
    retry-interval LONG false true 500 The period in milliseconds between subsequent attempts to reconnect to a target server, if the connection to the target server has failed.
    retry-interval-multiplier DOUBLE false true 1.0 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.
    static-connectors LIST true 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.
    use-duplicate-detection BOOLEAN false true true Whether the bridge will automatically insert a duplicate id property into each message that it forwards.
  • 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.

    Reply properties

    A map where keys are node IDs and values are the addresses used to connect to the nodes.
    type
    OBJECT
    Value Type
    STRING
  • remove Operation removing a cluster connection
  • start Starts the cluster connection.
  • stop Stops the cluster connection.