WildFly 16.0 Model Reference

  1. WildFly 16.0
  2. subsystem=messaging-activemq
  3. jms-bridge

A JMS bridge instance.

Attributes (24)

  • add-messageID-in-header If true, then the original message's message ID will be appended in the message sent to the destination in the header AMQ_BRIDGE_MSG_ID_LIST. If the message is bridged more than once, each message ID will be appended.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • client-id The JMS client ID to use when creating/looking up the subscription if it is durable and the source destination is a topic.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • failure-retry-interval The amount of time in milliseconds to wait between trying to recreate connections to the source or target servers when the bridge has detected they have failed.
    • Attribute Value
    Default Value 5000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • max-batch-size The maximum number of messages to consume from the source destination before sending them in a batch to the target destination. Its value must >= 1.
    • Attribute Value
    Default Value 1
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • max-batch-time The maximum number of milliseconds to wait before sending a batch to target, even if the number of messages consumed has not reached max-batch-size. Its value must be -1 to represent 'wait forever', or >= 1 to specify an actual time.
    • Attribute Value
    Default Value -1
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • max-retries The number of times to attempt to recreate connections to the source or target servers when the bridge has detected they have failed. The bridge will give up after trying this number of times. -1 represents 'try forever'.
    • Attribute Value
    Default Value -1
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • module The name of AS7 module containing the resources required to lookup source and target JMS resources.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • paused Whether the JMS bridge is paused.
    • Attribute Value
    Type BOOLEAN
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • quality-of-service The desired quality of service mode (AT_MOST_ONCE, DUPLICATES_OK or ONCE_AND_ONLY_ONCE).
    • Attribute Value
    Default Value AT_MOST_ONCE
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values AT_MOST_ONCE
    DUPLICATES_OK
    ONCE_AND_ONLY_ONCE
  • selector A JMS selector expression used for consuming messages from the source destination. Only messages that match the selector expression will be bridged from the source to the target destination.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • source-connection-factory The name of the source connection factory to lookup on the source messaging server.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • source-context The properties used to configure the source JNDI initial context.
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • source-credential-reference Credential (from Credential Store) to authenticate source connection
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • source-destination The name of the source destination to lookup on the source messaging server.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • source-password The password for creating the source connection.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • source-user The name of the user for creating the source connection.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • started Whether the JMS bridge is started.
    • Attribute Value
    Type BOOLEAN
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • subscription-name The name of the subscription if it is durable and the source destination is a topic.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • target-connection-factory The name of the target connection factory to lookup on the target messaging server.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • target-context The properties used to configure the target JNDI initial context.
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • target-credential-reference Credential (from Credential Store) to authenticate target connection
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • target-destination The name of the target destination to lookup on the target messaging server.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • target-password The password for creating the target connection.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • target-user The name of the user for creating the target connection.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services

Operations (6)

  • add Add a new JMS bridge.
    Request Parameter Type Required Expressions Allowed Default value Description
    add-messageID-in-header BOOLEAN false true false If true, then the original message's message ID will be appended in the message sent to the destination in the header AMQ_BRIDGE_MSG_ID_LIST. If the message is bridged more than once, each message ID will be appended.
    client-id STRING false true The JMS client ID to use when creating/looking up the subscription if it is durable and the source destination is a topic.
    failure-retry-interval LONG false true 5000 The amount of time in milliseconds to wait between trying to recreate connections to the source or target servers when the bridge has detected they have failed.
    max-batch-size INT false true 1 The maximum number of messages to consume from the source destination before sending them in a batch to the target destination. Its value must >= 1.
    max-batch-time LONG false true -1 The maximum number of milliseconds to wait before sending a batch to target, even if the number of messages consumed has not reached max-batch-size. Its value must be -1 to represent 'wait forever', or >= 1 to specify an actual time.
    max-retries INT false true -1 The number of times to attempt to recreate connections to the source or target servers when the bridge has detected they have failed. The bridge will give up after trying this number of times. -1 represents 'try forever'.
    module STRING true false The name of AS7 module containing the resources required to lookup source and target JMS resources.
    quality-of-service STRING false true AT_MOST_ONCE The desired quality of service mode (AT_MOST_ONCE, DUPLICATES_OK or ONCE_AND_ONLY_ONCE).
    selector STRING false true A JMS selector expression used for consuming messages from the source destination. Only messages that match the selector expression will be bridged from the source to the target destination.
    subscription-name STRING false true The name of the subscription if it is durable and the source destination is a topic.
    source-connection-factory STRING true false The name of the source connection factory to lookup on the source messaging server.
    source-context OBJECT false true The properties used to configure the source JNDI initial context.
    source-credential-reference OBJECT false false Credential (from Credential Store) to authenticate source connection
    source-destination STRING true false The name of the source destination to lookup on the source messaging server.
    source-password STRING false true The password for creating the source connection.
    source-user STRING false true The name of the user for creating the source connection.
    target-connection-factory STRING true false The name of the target connection factory to lookup on the target messaging server.
    target-context OBJECT false true The properties used to configure the target JNDI initial context.
    target-credential-reference OBJECT false false Credential (from Credential Store) to authenticate target connection
    target-destination STRING true false The name of the target destination to lookup on the target messaging server.
    target-password STRING false true The password for creating the target connection.
    target-user STRING false true The name of the user for creating the target connection.
  • pause Pause the JMS bridge.
  • remove Remove an existing JMS bridge.
  • resume Resume the JMS bridge.
  • start Start the JMS bridge.
  • stop Stop the JMS bridge.