Management API Reference for jms-bridge

A Jakarta Messaging bridge instance.

Attributes (26)

aborted-message-count - The number of messages aborted/rolled back.

Type	LONG
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The number of messages aborted/rolled back.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

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.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

client-id - The Jakarta Messaging client ID to use when creating/looking up the subscription if it is durable and the source destination is a topic.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Jakarta Messaging client ID to use when creating/looking up the subscription if it is durable and the source destination is a topic.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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.

Type	LONG
Default Value	5000
Unit	MILLISECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 5000, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

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.

Type	INT
Default Value	1
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Min	0
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 1, "min" : 0, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

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.

Type	LONG
Default Value	-1
Unit	MILLISECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : -1, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

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'.

Type	INT
Default Value	-1
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "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'.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : -1, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

message-count - The number of messages successfully committed.

Type	LONG
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The number of messages successfully committed.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

module - The name of AS7 module containing the resources required to lookup source and target Jakarta Messaging resources.

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of AS7 module containing the resources required to lookup source and target Jakarta Messaging resources.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

paused - Whether the Jakarta Messaging bridge is paused.

Type	BOOLEAN
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether the Jakarta Messaging bridge is paused.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

quality-of-service - The desired quality of service mode (AT_MOST_ONCE, DUPLICATES_OK or ONCE_AND_ONLY_ONCE).

Type	STRING
Default Value	AT_MOST_ONCE
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Allowed Values	DUPLICATES_OK ONCE_AND_ONLY_ONCE AT_MOST_ONCE
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The desired quality of service mode (AT_MOST_ONCE, DUPLICATES_OK or ONCE_AND_ONLY_ONCE).", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "AT_MOST_ONCE", "allowed" : [ "AT_MOST_ONCE", "DUPLICATES_OK", "ONCE_AND_ONLY_ONCE" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

selector - A Jakarta Messaging 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.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A Jakarta Messaging 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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

source-connection-factory - The name of the source connection factory to lookup on the source messaging server.

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the source connection factory to lookup on the source messaging server.", "attribute-group" : "source", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

source-context - The properties used to configure the source JNDI initial context.

Type	OBJECT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The properties used to configure the source JNDI initial context.", "attribute-group" : "source", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

source-credential-reference - Credential (from Credential Store) to authenticate source connection

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Credential (from Credential Store) to authenticate source connection", "attribute-group" : "source", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["source-password"], "stability" : "default", "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "messaging-security" : {"type" : "messaging-activemq"} }}, "value-type" : { "store" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the credential store holding the alias to credential", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "alias" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The alias which denotes stored secret or credential in the store", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["store"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of credential this reference is denoting", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "clear-text" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Secret specified using clear text (check credential store way of supplying credential/secrets to services)", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

source-destination - The name of the source destination to lookup on the source messaging server.

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the source destination to lookup on the source messaging server.", "attribute-group" : "source", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

source-password - The password for creating the source connection.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The password for creating the source connection.", "attribute-group" : "source", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["source-credential-reference"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "messaging-security" : {"type" : "messaging-activemq"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

source-user - The name of the user for creating the source connection.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the user for creating the source connection.", "attribute-group" : "source", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "messaging-security" : {"type" : "messaging-activemq"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

started - Whether the Jakarta Messaging bridge is started.

Type	BOOLEAN
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether the Jakarta Messaging bridge is started.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

subscription-name - The name of the subscription if it is durable and the source destination is a topic.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the subscription if it is durable and the source destination is a topic.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

target-connection-factory - The name of the target connection factory to lookup on the target messaging server.

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the target connection factory to lookup on the target messaging server.", "attribute-group" : "target", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

target-context - The properties used to configure the target JNDI initial context.

Type	OBJECT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The properties used to configure the target JNDI initial context.", "attribute-group" : "target", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

target-credential-reference - Credential (from Credential Store) to authenticate target connection

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Credential (from Credential Store) to authenticate target connection", "attribute-group" : "target", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["target-password"], "stability" : "default", "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "messaging-security" : {"type" : "messaging-activemq"} }}, "value-type" : { "store" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the credential store holding the alias to credential", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "alias" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The alias which denotes stored secret or credential in the store", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["store"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of credential this reference is denoting", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "clear-text" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Secret specified using clear text (check credential store way of supplying credential/secrets to services)", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

target-destination - The name of the target destination to lookup on the target messaging server.

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the target destination to lookup on the target messaging server.", "attribute-group" : "target", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

target-password - The password for creating the target connection.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The password for creating the target connection.", "attribute-group" : "target", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["target-credential-reference"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "messaging-security" : {"type" : "messaging-activemq"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

target-user - The name of the user for creating the target connection.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the user for creating the target connection.", "attribute-group" : "target", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "messaging-security" : {"type" : "messaging-activemq"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

Operations (6)

add - Add a new Jakarta Messaging 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 Jakarta Messaging 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 Jakarta Messaging 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 Jakarta Messaging 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.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new Jakarta Messaging bridge.",
    "request-properties" : {
        "add-messageID-in-header" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "client-id" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The Jakarta Messaging client ID to use when creating/looking up the subscription if it is durable and the source destination is a topic.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "failure-retry-interval" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 5000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "max-batch-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1,
            "min" : 0,
            "max" : 2147483647,
            "stability" : "default"
        },
        "max-batch-time" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "max-retries" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "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'.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "stability" : "default"
        },
        "module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of AS7 module containing the resources required to lookup source and target Jakarta Messaging resources.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "quality-of-service" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The desired quality of service mode (AT_MOST_ONCE, DUPLICATES_OK or ONCE_AND_ONLY_ONCE).",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "AT_MOST_ONCE",
            "allowed" : [
                "AT_MOST_ONCE",
                "DUPLICATES_OK",
                "ONCE_AND_ONLY_ONCE"
            ],
            "stability" : "default"
        },
        "selector" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "A Jakarta Messaging 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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "subscription-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the subscription if it is durable and the source destination is a topic.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "source-connection-factory" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the source connection factory to lookup on the source messaging server.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "source-context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The properties used to configure the source JNDI initial context.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "source-credential-reference" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Credential (from Credential Store) to authenticate source connection",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["source-password"],
            "stability" : "default",
            "value-type" : {
                "store" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The name of the credential store holding the alias to credential",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "alias" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The alias which denotes stored secret or credential in the store",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "requires" : ["store"],
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "type" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The type of credential this reference is denoting",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "clear-text" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Secret specified using clear text (check credential store way of supplying credential/secrets to services)",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "source-destination" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the source destination to lookup on the source messaging server.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "source-password" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The password for creating the source connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["source-credential-reference"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "source-user" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the user for creating the source connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "target-connection-factory" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the target connection factory to lookup on the target messaging server.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "target-context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The properties used to configure the target JNDI initial context.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "target-credential-reference" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Credential (from Credential Store) to authenticate target connection",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["target-password"],
            "stability" : "default",
            "value-type" : {
                "store" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The name of the credential store holding the alias to credential",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "alias" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The alias which denotes stored secret or credential in the store",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "requires" : ["store"],
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "type" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The type of credential this reference is denoting",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "clear-text" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Secret specified using clear text (check credential store way of supplying credential/secrets to services)",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "target-destination" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the target destination to lookup on the target messaging server.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "target-password" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The password for creating the target connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["target-credential-reference"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "target-user" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the user for creating the target connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

pause - Pause the Jakarta Messaging bridge.

Raw DMR model


{
    "operation-name" : "pause",
    "description" : "Pause the Jakarta Messaging bridge.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove an existing Jakarta Messaging bridge.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove an existing Jakarta Messaging bridge.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

resume - Resume the Jakarta Messaging bridge.

Raw DMR model


{
    "operation-name" : "resume",
    "description" : "Resume the Jakarta Messaging bridge.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

start - Start the Jakarta Messaging bridge.

Raw DMR model


{
    "operation-name" : "start",
    "description" : "Start the Jakarta Messaging bridge.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

stop - Stop the Jakarta Messaging bridge.

Raw DMR model


{
    "operation-name" : "stop",
    "description" : "Stop the Jakarta Messaging bridge.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.messaging-activemq.jms-bridge

        
<feature spec="subsystem.messaging-activemq.jms-bridge">
  <param name="jms-bridge" value="{resource name}"/>
  <param name="add-messageID-in-header" value="{value}"/>
  <param name="client-id" value="{value}"/>
  <param name="failure-retry-interval" value="{value}"/>
  <param name="max-batch-size" value="{value}"/>
  <param name="max-batch-time" value="{value}"/>
  <param name="max-retries" value="{value}"/>
  <param name="module" value="{value}"/>
  <param name="quality-of-service" value="{value}"/>
  <param name="selector" value="{value}"/>
  <param name="source-connection-factory" value="{value}"/>
  <param name="source-context" value="{value}"/>
  <param name="source-credential-reference" value="{value}"/>
  <param name="source-destination" value="{value}"/>
  <param name="source-password" value="{value}"/>
  <param name="source-user" value="{value}"/>
  <param name="subscription-name" value="{value}"/>
  <param name="target-connection-factory" value="{value}"/>
  <param name="target-context" value="{value}"/>
  <param name="target-credential-reference" value="{value}"/>
  <param name="target-destination" value="{value}"/>
  <param name="target-password" value="{value}"/>
  <param name="target-user" value="{value}"/>
<feature/>