Management API Reference for cluster-connection

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

Attributes (25)

allow-direct-connections-only - Whether, if a node learns of the existence of a node that is more than 1 hop away, we do not create a bridge for direct cluster connection. Only relevant if 'static-connectors' is defined.

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, if a node learns of the existence of a node that is more than 1 hop away, we do not create a bridge for direct cluster connection. Only relevant if 'static-connectors' is defined.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "requires" : ["static-connectors"], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

call-failover-timeout - The timeout to use when fail over is in process (in ms) for remote calls made by the cluster connection.

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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The timeout to use when fail over is in process (in ms) for remote calls made by the cluster connection.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : -1, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

call-timeout - The timeout (in ms) for remote calls made by the cluster connection.

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 timeout (in ms) for remote calls made by the cluster connection.", "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 }`

cluster-connection-address - Each cluster connection only applies to messages sent to an address that starts with this value.

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" : "Each cluster connection only applies to messages sent to an address that starts with this value.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "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 a 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 a 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 cluster connections 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 cluster connections 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 }`

connector-name - The name of connector to use for live connection

Type	STRING
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 connector to use for live connection", "expressions-allowed" : false, "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 }`

discovery-group - The discovery group used to obtain the list of other servers in the cluster to which this cluster connection will make connections. Must be undefined (null) if 'static-connectors' is defined.

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 discovery group used to obtain the list of other servers in the cluster to which this cluster connection will make connections. Must be undefined (null) if 'static-connectors' is defined.", "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 }

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

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 cluster connection.", "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-hops - The maximum number of times a message can be forwarded. ActiveMQ can be configured to also load balance messages to nodes which might be connected to it only indirectly with other ActiveMQ servers as intermediates in a chain.

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 maximum number of times a message can be forwarded. ActiveMQ can be configured to also load balance messages to nodes which might be connected to it only indirectly with other ActiveMQ servers as intermediates in a chain.", "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 }`

message-load-balancing-type - The type of message load balancing provided by the cluster connection.

Type	STRING
Default Value	ON_DEMAND
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	STRICT ON_DEMAND OFF
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of message load balancing provided by the cluster connection.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "ON_DEMAND", "allowed" : [ "OFF", "STRICT", "ON_DEMAND" ], "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 }`

node-id - The node ID used by this cluster connection.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The node ID used by this cluster connection.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

notification-attempts - How many times the cluster connection will broadcast itself

Type	INT
Default Value	2
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" : "INT" }, "description" : "How many times the cluster connection will broadcast itself", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 2, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

notification-interval - How often the cluster connection will broadcast itself

Type	LONG
Default Value	1000
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" : "How often the cluster connection will broadcast itself", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 1000, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

producer-window-size - Producer flow control size on the cluster connection.

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

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 }`

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

Type	LONG
Default Value	500
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 attempts to reconnect to a target server, if the connection to the target server has failed.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 500, "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 }`

started - Whether the cluster connection 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 cluster connection 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 - The statically defined list of connectors to which this cluster connection will make connections. 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" : "The statically defined list of connectors to which this cluster connection will make connections. 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 }

topology - The topology of the nodes that this cluster connection is aware of.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The topology of the nodes that this cluster connection is aware of.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "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 }`

Operations (5)

add - Operation adding a cluster connection

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
allow-direct-connections-only	BOOLEAN	false	true	false	Whether, if a node learns of the existence of a node that is more than 1 hop away, we do not create a bridge for direct cluster connection. Only relevant if 'static-connectors' is defined.
call-failover-timeout	LONG	false	true	-1	The timeout to use when fail over is in process (in ms) for remote calls made by the cluster connection.
call-timeout	LONG	false	true	30000	The timeout (in ms) for remote calls made by the cluster connection.
check-period	LONG	false	true	30000	The period (in milliseconds) between client failure check.
cluster-connection-address	STRING	true	true		Each cluster connection only applies to messages sent to an address that starts with this value.
confirmation-window-size	INT	false	true	10485760	The confirmation-window-size to use for the connection used to forward messages to a target node.
connection-ttl	LONG	false	true	60000	The maximum time (in milliseconds) for which the connections used by the cluster connections are considered alive (in the absence of heartbeat).
connector-name	STRING	true	false		The name of connector to use for live connection
discovery-group	STRING	true	false		The discovery group used to obtain the list of other servers in the cluster to which this cluster connection will make connections. Must be undefined (null) if 'static-connectors' is defined.
initial-connect-attempts	INT	false	true	-1	The number of attempts to connect initially with this cluster connection.
max-hops	INT	false	true	1	The maximum number of times a message can be forwarded. ActiveMQ can be configured to also load balance messages to nodes which might be connected to it only indirectly with other ActiveMQ servers as intermediates in a chain.
max-retry-interval	LONG	false	true	2000	The maximum interval of time used to retry connections
message-load-balancing-type	STRING	false	true	ON_DEMAND	The type of message load balancing provided by the cluster connection.
min-large-message-size	INT	false	true	102400	The minimum size (in bytes) for a message before it is considered as a large message.
notification-attempts	INT	false	true	2	How many times the cluster connection will broadcast itself
notification-interval	LONG	false	true	1000	How often the cluster connection will broadcast itself
producer-window-size	INT	false	true	-1	Producer flow control size on the cluster connection.
reconnect-attempts	INT	false	true	-1	The total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts.
retry-interval	LONG	false	true	500	The period in milliseconds between subsequent attempts to reconnect to a target server, if the connection to the target server has failed.
retry-interval-multiplier	DOUBLE	false	true	1.0	A multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts.
static-connectors	LIST	true	false		The statically defined list of connectors to which this cluster connection will make connections. Must be undefined (null) if 'discovery-group-name' is defined.
use-duplicate-detection	BOOLEAN	false	true	true	Whether the bridge will automatically insert a duplicate id property into each message that it forwards.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Operation adding a cluster connection",
    "request-properties" : {
        "allow-direct-connections-only" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether, if a node learns of the existence of a node that is more than 1 hop away, we do not create a bridge for direct cluster connection. Only relevant if 'static-connectors' is defined.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "requires" : ["static-connectors"],
            "stability" : "default"
        },
        "call-failover-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The timeout to use when fail over is in process (in ms) for remote calls made by the cluster connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "call-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The timeout (in ms) for remote calls made by the cluster connection.",
            "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"
        },
        "cluster-connection-address" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Each cluster connection only applies to messages sent to an address that starts with this value.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 0,
            "max-length" : 2147483647,
            "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 a 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 cluster connections are considered alive (in the absence of heartbeat).",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 60000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "connector-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of connector to use for live connection",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "discovery-group" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The discovery group used to obtain the list of other servers in the cluster to which this cluster connection will make connections. Must be undefined (null) if 'static-connectors' is defined.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : true,
            "alternatives" : ["static-connectors"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "initial-connect-attempts" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The number of attempts to connect initially with this cluster connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "stability" : "default"
        },
        "max-hops" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum number of times a message can be forwarded. ActiveMQ can be configured to also load balance messages to nodes which might be connected to it only indirectly with other ActiveMQ servers as intermediates in a chain.",
            "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"
        },
        "message-load-balancing-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The type of message load balancing provided by the cluster connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "ON_DEMAND",
            "allowed" : [
                "OFF",
                "STRICT",
                "ON_DEMAND"
            ],
            "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"
        },
        "notification-attempts" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "How many times the cluster connection will broadcast itself",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 2,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "notification-interval" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "How often the cluster connection will broadcast itself",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "producer-window-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Producer flow control size on the cluster connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "unit" : "BYTES",
            "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"
        },
        "retry-interval" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The period in milliseconds between subsequent attempts to reconnect to a target server, if the connection to the target server has failed.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 500,
            "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"
        },
        "static-connectors" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The statically defined list of connectors to which this cluster connection will make connections. 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"
            }
        },
        "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"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

get-nodes - Returns a map of the nodes connected to this cluster connection, where keys are node IDs and values are the addresses used to connect to the nodes.

Reply properties

A map where keys are node IDs and values are the addresses used to connect to the nodes.

Type

OBJECT

Value Type


STRING

Raw DMR model


{
    "operation-name" : "get-nodes",
    "description" : "Returns a map of the nodes connected to this cluster connection, where keys are node IDs and values are the addresses used to connect to the nodes.",
    "request-properties" : {},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "OBJECT"
        },
        "value-type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "A map where keys are node IDs and values are the addresses used to connect to the nodes."
    },
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

remove - Operation removing a cluster connection

Raw DMR model


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

start - Starts the cluster connection.

Raw DMR model


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

stop - Stops the cluster connection.

Raw DMR model


{
    "operation-name" : "stop",
    "description" : "Stops the cluster connection.",
    "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.cluster-connection

        
<feature spec="subsystem.messaging-activemq.server.cluster-connection">
  <param name="cluster-connection" value="{resource name}"/>
  <param name="server" value="{resource name}"/>
  <param name="allow-direct-connections-only" value="{value}"/>
  <param name="call-failover-timeout" value="{value}"/>
  <param name="call-timeout" value="{value}"/>
  <param name="check-period" value="{value}"/>
  <param name="cluster-connection-address" value="{value}"/>
  <param name="confirmation-window-size" value="{value}"/>
  <param name="connection-ttl" value="{value}"/>
  <param name="connector-name" value="{value}"/>
  <param name="discovery-group" value="{value}"/>
  <param name="initial-connect-attempts" value="{value}"/>
  <param name="max-hops" value="{value}"/>
  <param name="max-retry-interval" value="{value}"/>
  <param name="message-load-balancing-type" value="{value}"/>
  <param name="min-large-message-size" value="{value}"/>
  <param name="notification-attempts" value="{value}"/>
  <param name="notification-interval" value="{value}"/>
  <param name="producer-window-size" value="{value}"/>
  <param name="reconnect-attempts" value="{value}"/>
  <param name="retry-interval" value="{value}"/>
  <param name="retry-interval-multiplier" value="{value}"/>
  <param name="static-connectors" value="{value}"/>
  <param name="use-duplicate-detection" value="{value}"/>
<feature/>