WildFly Full 19 Model Reference

  1. home
  2. subsystem=messaging-activemq
  3. server
  4. 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 ActiveMQ server.

Attributes (23)

  • 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
  • confirmation-window-size The confirmation-window-size to use for the connection used to forward messages to the target node.
    • Attribute Value
    Default Value 1048576
    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 bridges 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
  • credential-reference Credential (from Credential Store) to authenticate the bridge
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • discovery-group The name of the discovery group used by this bridge. 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
  • filter An optional filter string. If specified then only messages which match the filter expression specified will be forwarded. The filter string follows the ActiveMQ filter expression syntax described in the ActiveMQ documentation.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • initial-connect-attempts The number of attempts to connect initially with this bridge.
    • 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
  • 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
  • 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.
    • Attribute Value
    Default Value CHANGE ME!!
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • producer-window-size Producer flow control size on the bridge.
    • Attribute Value
    Default Value -1
    Type INT
    Nillable true
    Expressions Allowed true
    Unit BYTES
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • queue-name The unique name of the local queue that the bridge consumes from.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    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
  • reconnect-attempts-on-same-node The total number of reconnect attempts on the same node the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts.
    • Attribute Value
    Default Value 10
    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 reconnection attempts, if the connection to the target server has failed.
    • Attribute Value
    Default Value 2000
    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 bridge is started.
    • Attribute Value
    Type BOOLEAN
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • static-connectors A list of names of statically defined connectors used by this bridge. 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
  • transformer-class-name The name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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
  • 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.
    • Attribute Value
    Default Value ACTIVEMQ.CLUSTER.ADMIN.USER
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services

Operations (4)

  • add Operation adding a bridge.
    Request Parameter Type Required Expressions Allowed Default value Description
    check-period LONG false true 30000 The period (in milliseconds) between client failure check.
    confirmation-window-size INT false true 1048576 The confirmation-window-size to use for the connection used to forward messages to the target node.
    connection-ttl LONG false true 60000 The maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat).
    credential-reference OBJECT false false Credential (from Credential Store) to authenticate the bridge
    discovery-group STRING true false The name of the discovery group used by this bridge. Must be undefined (null) if 'static-connectors' is defined.
    filter STRING false true An optional filter string. If specified then only messages which match the filter expression specified will be forwarded. The filter string follows the ActiveMQ filter expression syntax described in the ActiveMQ documentation.
    forwarding-address STRING false true 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.
    ha BOOLEAN false true false Whether or not this bridge should support high availability. True means it will connect to any available server in a cluster and support failover.
    initial-connect-attempts INT false true -1 The number of attempts to connect initially with this bridge.
    max-retry-interval LONG false true 2000 The maximum interval of time used to retry connections
    min-large-message-size INT false true 102400 The minimum size (in bytes) for a message before it is considered as a large message.
    password STRING false true CHANGE ME!! 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.
    producer-window-size INT false true -1 Producer flow control size on the bridge.
    queue-name STRING true true The unique name of the local queue that the bridge consumes from.
    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.
    reconnect-attempts-on-same-node INT false true 10 The total number of reconnect attempts on the same node 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 2000 The period in milliseconds between subsequent reconnection attempts, 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 A list of names of statically defined connectors used by this bridge. Must be undefined (null) if 'discovery-group-name' is defined.
    transformer-class-name STRING false false The name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface.
    use-duplicate-detection BOOLEAN false true true Whether the bridge will automatically insert a duplicate id property into each message that it forwards.
    user STRING false true ACTIVEMQ.CLUSTER.ADMIN.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.
  • remove Operation removing a bridge.
  • start Starts the bridge.
  • stop Stops the bridge.