Management API Reference for 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 (25)

call-timeout - Timeout for blocking calls.

Type	LONG
Default Value	30000
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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Timeout for blocking calls.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 30000, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

check-period - The period (in milliseconds) between client failure check.

Type	LONG
Default Value	30000
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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The period (in milliseconds) between client failure check.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 30000, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

confirmation-window-size - The confirmation-window-size to use for the connection used to forward messages to the target node.

Type	INT
Default Value	10485760
Unit	BYTES
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" : "INT" }, "description" : "The confirmation-window-size to use for the connection used to forward messages to the target node.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 10485760, "unit" : "BYTES", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

connection-ttl - The maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat).

Type	LONG
Default Value	60000
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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat).", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 60000, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

credential-reference - Credential (from Credential Store) to authenticate the bridge

Type	OBJECT
Is the attribute nillable?	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" : "OBJECT" }, "description" : "Credential (from Credential Store) to authenticate the bridge", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["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" : "all-services", "capability-reference" : null }

discovery-group - The name of the discovery group used by this bridge. Must be undefined (null) if 'static-connectors' is defined.

Type	STRING
Is the attribute nillable?	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 name of the discovery group used by this bridge. Must be undefined (null) if 'static-connectors' is defined.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : ["static-connectors"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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.

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" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

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.

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 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.", "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 }

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.

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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether or not this bridge should support high availability. True means it will connect to any available server in a cluster and support failover.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

initial-connect-attempts - The number of attempts to connect initially with this bridge.

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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of attempts to connect initially with this bridge.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : -1, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

max-retry-interval - The maximum interval of time used to retry connections

Type	LONG
Default Value	2000
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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The maximum interval of time used to retry connections", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 2000, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

min-large-message-size - The minimum size (in bytes) for a message before it is considered as a large message.

Type	INT
Default Value	102400
Unit	BYTES
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" : "INT" }, "description" : "The minimum size (in bytes) for a message before it is considered as a large message.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 102400, "unit" : "BYTES", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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.

Type	STRING
Default Value	CHANGE ME!!
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 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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "CHANGE ME!!", "alternatives" : ["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" : "all-services", "capability-reference" : null }

producer-window-size - Producer flow control size on the bridge.

Type	INT
Default Value	-1
Unit	BYTES
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" : "INT" }, "description" : "Producer flow control size on the bridge.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : -1, "unit" : "BYTES", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

queue-name - The unique name of the local queue that the bridge consumes from.

Type	STRING
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 unique name of the local queue that the bridge consumes from.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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.

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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : -1, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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.

Type	INT
Default Value	10
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" : "INT" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 10, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

retry-interval - The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed.

Type	LONG
Default Value	2000
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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 2000, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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.

Type	DOUBLE
Default Value	1.0
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" : "DOUBLE" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 1.0, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

routing-type - Pass or strip the routing type from the messages the bridge forwards.

Type	STRING
Default Value	PASS
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
Allowed Values	STRIP PASS
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Pass or strip the routing type from the messages the bridge forwards.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "PASS", "allowed" : [ "STRIP", "PASS" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

started - Whether the 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 bridge is started.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

static-connectors - A list of names of statically defined connectors used by this bridge. Must be undefined (null) if 'discovery-group-name' is defined.

Type	LIST
Is the attribute nillable?	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" : "LIST" }, "description" : "A list of names of statically defined connectors used by this bridge. Must be undefined (null) if 'discovery-group-name' is defined.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : ["discovery-group"], "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

transformer-class-name - The name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface.

Type	STRING
Is the attribute nillable?	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 name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface.", "expressions-allowed" : false, "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 }`

use-duplicate-detection - Whether the bridge will automatically insert a duplicate id property into each message that it forwards.

Type	BOOLEAN
Default Value	true
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" : "BOOLEAN" }, "description" : "Whether the bridge will automatically insert a duplicate id property into each message that it forwards.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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.

Type	STRING
Default Value	ACTIVEMQ.CLUSTER.ADMIN.USER
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 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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "ACTIVEMQ.CLUSTER.ADMIN.USER", "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" : "all-services", "capability-reference" : null }

Operations (4)

add - Operation adding a bridge.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
call-timeout	LONG	false	true	30000	Timeout for blocking calls.
check-period	LONG	false	true	30000	The period (in milliseconds) between client failure check.
confirmation-window-size	INT	false	true	10485760	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.
routing-type	STRING	false	true	PASS	Pass or strip the routing type from the messages the bridge forwards.
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.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Operation adding a bridge.",
    "request-properties" : {
        "call-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "Timeout for blocking calls.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 30000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "check-period" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The period (in milliseconds) between client failure check.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 30000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "confirmation-window-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The confirmation-window-size to use for the connection used to forward messages to the target node.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 10485760,
            "unit" : "BYTES",
            "stability" : "default"
        },
        "connection-ttl" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat).",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 60000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "credential-reference" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Credential (from Credential Store) to authenticate the bridge",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["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"
                }
            }
        },
        "discovery-group" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the discovery group used by this bridge. Must be undefined (null) if 'static-connectors' is defined.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : true,
            "alternatives" : ["static-connectors"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "filter" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "forwarding-address" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "ha" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether or not this bridge should support high availability. True means it will connect to any available server in a cluster and support failover.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "initial-connect-attempts" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The number of attempts to connect initially with this bridge.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "stability" : "default"
        },
        "max-retry-interval" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The maximum interval of time used to retry connections",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 2000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "min-large-message-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The minimum size (in bytes) for a message before it is considered as a large message.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 102400,
            "unit" : "BYTES",
            "stability" : "default"
        },
        "password" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "CHANGE ME!!",
            "alternatives" : ["credential-reference"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "producer-window-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Producer flow control size on the bridge.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "unit" : "BYTES",
            "stability" : "default"
        },
        "queue-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The unique name of the local queue that the bridge consumes from.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "reconnect-attempts" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "stability" : "default"
        },
        "reconnect-attempts-on-same-node" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 10,
            "stability" : "default"
        },
        "retry-interval" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 2000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "retry-interval-multiplier" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1.0,
            "stability" : "default"
        },
        "routing-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Pass or strip the routing type from the messages the bridge forwards.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "PASS",
            "allowed" : [
                "STRIP",
                "PASS"
            ],
            "stability" : "default"
        },
        "static-connectors" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "A list of names of statically defined connectors used by this bridge. Must be undefined (null) if 'discovery-group-name' is defined.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : true,
            "alternatives" : ["discovery-group"],
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "transformer-class-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "use-duplicate-detection" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether the bridge will automatically insert a duplicate id property into each message that it forwards.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "user" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "ACTIVEMQ.CLUSTER.ADMIN.USER",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Operation removing a bridge.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Operation removing a bridge.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

start - Starts the bridge.

Raw DMR model


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

stop - Stops the bridge.

Raw DMR model


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

Galleon Features

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

subsystem.messaging-activemq.server.bridge

        
<feature spec="subsystem.messaging-activemq.server.bridge">
  <param name="bridge" value="{resource name}"/>
  <param name="server" value="{resource name}"/>
  <param name="call-timeout" value="{value}"/>
  <param name="check-period" value="{value}"/>
  <param name="confirmation-window-size" value="{value}"/>
  <param name="connection-ttl" value="{value}"/>
  <param name="credential-reference" value="{value}"/>
  <param name="discovery-group" value="{value}"/>
  <param name="filter" value="{value}"/>
  <param name="forwarding-address" value="{value}"/>
  <param name="ha" value="{value}"/>
  <param name="initial-connect-attempts" value="{value}"/>
  <param name="max-retry-interval" value="{value}"/>
  <param name="min-large-message-size" value="{value}"/>
  <param name="password" value="{value}"/>
  <param name="producer-window-size" value="{value}"/>
  <param name="queue-name" value="{value}"/>
  <param name="reconnect-attempts" value="{value}"/>
  <param name="reconnect-attempts-on-same-node" value="{value}"/>
  <param name="retry-interval" value="{value}"/>
  <param name="retry-interval-multiplier" value="{value}"/>
  <param name="routing-type" value="{value}"/>
  <param name="static-connectors" value="{value}"/>
  <param name="transformer-class-name" value="{value}"/>
  <param name="use-duplicate-detection" value="{value}"/>
  <param name="user" value="{value}"/>
<feature/>