Management API Reference for legacy-connection-factory

Defines a connection factory.

Attributes (37)

auto-group - Whether or not message grouping is automatically used

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 message grouping is automatically used", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

block-on-acknowledge - True to set block on acknowledge.

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" : "True to set block on acknowledge.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

block-on-durable-send - True to set block on durable send.

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" : "True to set block on durable send.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

block-on-non-durable-send - True to set block on non durable send.

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" : "True to set block on non durable send.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

cache-large-message-client - True to cache large messages.

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" : "True to cache large messages.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "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).

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).", "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 call time out.

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 call time out.", "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 }`

client-failure-check-period - The client failure check period.

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 client failure check period.", "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 }`

client-id - The client id.

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

compress-large-messages - Whether large messages should be compressed.

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 large messages should be compressed.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

confirmation-window-size - The confirmation window size.

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" : "The confirmation window size.", "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 }`

connection-load-balancing-policy-class-name - Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster.

Type	STRING
Default Value	org.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy
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" : "Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "org.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

connection-ttl - The connection ttl.

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

connectors - Defines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute.

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" : "Defines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute.", "expressions-allowed" : false, "required" : false, "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 }

consumer-max-rate - The consumer max rate.

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

consumer-window-size - The consumer window size.

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

discovery-group - The discovery group name.

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

dups-ok-batch-size - The dups ok batch size.

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

entries - The jndi names the connection factory should be bound to.

Type	LIST
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" : "LIST" }, "description" : "The jndi names the connection factory should be bound to.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

factory-type - The type of connection factory.

Type	STRING
Default Value	GENERIC
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	XA_GENERIC GENERIC XA_TOPIC TOPIC QUEUE XA_QUEUE
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of connection factory.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "GENERIC", "allowed" : [ "GENERIC", "TOPIC", "QUEUE", "XA_GENERIC", "XA_QUEUE", "XA_TOPIC" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

failover-on-initial-connection - True to fail over on initial connection.

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" : "True to fail over on initial connection.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

group-id - The group id.

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 group id.", "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 the connection factory supports High Availability.

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 the connection factory supports High Availability.", "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 for the initial connection to the server.

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 for the initial connection to the server.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 1, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

initial-message-packet-size - The initial size of messages created through this factory.

Type	INT
Default Value	1500
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 initial size of messages created through this factory.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 1500, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

max-retry-interval - The max retry interval.

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 max retry interval.", "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 min large message size.

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 min large message size.", "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 }`

pre-acknowledge - True to pre-acknowledge.

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" : "True to pre-acknowledge.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

producer-max-rate - The producer max rate.

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

producer-window-size - The producer window size.

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

reconnect-attempts - The reconnect attempts.

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

retry-interval - The retry interval.

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 retry interval.", "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 - The retry interval multiplier.

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" : "The retry interval multiplier.", "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 }`

scheduled-thread-pool-max-size - The scheduled thread pool max size.

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

thread-pool-max-size - The thread pool max size.

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

transaction-batch-size - The transaction batch size.

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

use-global-pools - True to use global pools.

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" : "True to use global pools.", "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 (2)

add - Adds a connection factory.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
auto-group	BOOLEAN	false	true	false	Whether or not message grouping is automatically used
block-on-acknowledge	BOOLEAN	false	true	false	True to set block on acknowledge.
block-on-durable-send	BOOLEAN	false	true	true	True to set block on durable send.
block-on-non-durable-send	BOOLEAN	false	true	false	True to set block on non durable send.
cache-large-message-client	BOOLEAN	false	true	false	True to cache large messages.
call-failover-timeout	LONG	false	true	-1	The timeout to use when fail over is in process (in ms).
call-timeout	LONG	false	true	30000	The call time out.
client-failure-check-period	LONG	false	true	30000	The client failure check period.
client-id	STRING	false	true		The client id.
compress-large-messages	BOOLEAN	false	true	false	Whether large messages should be compressed.
confirmation-window-size	INT	false	true	-1	The confirmation window size.
connection-load-balancing-policy-class-name	STRING	false	false	org.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy	Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster.
connection-ttl	LONG	false	true	60000	The connection ttl.
connectors	LIST	false	false		Defines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute.
consumer-max-rate	INT	false	true	-1	The consumer max rate.
consumer-window-size	INT	false	true	1048576	The consumer window size.
discovery-group	STRING	false	false		The discovery group name.
dups-ok-batch-size	INT	false	true	1048576	The dups ok batch size.
entries	LIST	true	true		The jndi names the connection factory should be bound to.
factory-type	STRING	false	true	GENERIC	The type of connection factory.
failover-on-initial-connection	BOOLEAN	false	true	false	True to fail over on initial connection.
group-id	STRING	false	true		The group id.
ha	BOOLEAN	false	true	false	Whether the connection factory supports High Availability.
initial-connect-attempts	INT	false	true	1	The number of attempts for the initial connection to the server.
initial-message-packet-size	INT	false	true	1500	The initial size of messages created through this factory.
max-retry-interval	LONG	false	true	2000	The max retry interval.
min-large-message-size	INT	false	true	102400	The min large message size.
pre-acknowledge	BOOLEAN	false	true	false	True to pre-acknowledge.
producer-max-rate	INT	false	true	-1	The producer max rate.
producer-window-size	INT	false	true	65536	The producer window size.
reconnect-attempts	INT	false	true	0	The reconnect attempts.
retry-interval	LONG	false	true	2000	The retry interval.
retry-interval-multiplier	DOUBLE	false	true	1.0	The retry interval multiplier.
scheduled-thread-pool-max-size	INT	false	true	5	The scheduled thread pool max size.
thread-pool-max-size	INT	false	true	30	The thread pool max size.
transaction-batch-size	INT	false	true	1048576	The transaction batch size.
use-global-pools	BOOLEAN	false	true	true	True to use global pools.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a connection factory.",
    "request-properties" : {
        "auto-group" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether or not message grouping is automatically used",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "block-on-acknowledge" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "True to set block on acknowledge.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "block-on-durable-send" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "True to set block on durable send.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "block-on-non-durable-send" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "True to set block on non durable send.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "cache-large-message-client" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "True to cache large messages.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "call-failover-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The timeout to use when fail over is in process (in ms).",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "call-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The call time out.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 30000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "client-failure-check-period" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The client failure check period.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 30000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "client-id" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The client id.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "compress-large-messages" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether large messages should be compressed.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "confirmation-window-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The confirmation window size.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "unit" : "BYTES",
            "stability" : "default"
        },
        "connection-load-balancing-policy-class-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : "org.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "connection-ttl" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The connection ttl.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 60000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "connectors" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "Defines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["discovery-group"],
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "consumer-max-rate" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The consumer max rate.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "unit" : "PER_SECOND",
            "stability" : "default"
        },
        "consumer-window-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The consumer window size.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1048576,
            "unit" : "BYTES",
            "stability" : "default"
        },
        "discovery-group" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The discovery group name.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["connectors"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "dups-ok-batch-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The dups ok batch size.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1048576,
            "stability" : "default"
        },
        "entries" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The jndi names the connection factory should be bound to.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "factory-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The type of connection factory.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "GENERIC",
            "allowed" : [
                "GENERIC",
                "TOPIC",
                "QUEUE",
                "XA_GENERIC",
                "XA_QUEUE",
                "XA_TOPIC"
            ],
            "stability" : "default"
        },
        "failover-on-initial-connection" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "True to fail over on initial connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "group-id" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The group id.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "ha" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether the connection factory supports High Availability.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "initial-connect-attempts" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The number of attempts for the initial connection to the server.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1,
            "stability" : "default"
        },
        "initial-message-packet-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The initial size of messages created through this factory.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1500,
            "stability" : "default"
        },
        "max-retry-interval" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The max retry interval.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 2000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "min-large-message-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The min large message size.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 102400,
            "unit" : "BYTES",
            "stability" : "default"
        },
        "pre-acknowledge" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "True to pre-acknowledge.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "producer-max-rate" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The producer max rate.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "unit" : "PER_SECOND",
            "stability" : "default"
        },
        "producer-window-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The producer window size.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 65536,
            "unit" : "BYTES",
            "stability" : "default"
        },
        "reconnect-attempts" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The reconnect attempts.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 0,
            "stability" : "default"
        },
        "retry-interval" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The retry interval.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 2000,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "retry-interval-multiplier" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "The retry interval multiplier.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1.0,
            "stability" : "default"
        },
        "scheduled-thread-pool-max-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The scheduled thread pool max size.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 5,
            "stability" : "default"
        },
        "thread-pool-max-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The thread pool max size.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 30,
            "stability" : "default"
        },
        "transaction-batch-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The transaction batch size.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1048576,
            "stability" : "default"
        },
        "use-global-pools" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "True to use global pools.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes a connection factory.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a connection factory.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

Galleon Features

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

subsystem.messaging-activemq.server.legacy-connection-factory

        
<feature spec="subsystem.messaging-activemq.server.legacy-connection-factory">
  <param name="legacy-connection-factory" value="{resource name}"/>
  <param name="server" value="{resource name}"/>
  <param name="auto-group" value="{value}"/>
  <param name="block-on-acknowledge" value="{value}"/>
  <param name="block-on-durable-send" value="{value}"/>
  <param name="block-on-non-durable-send" value="{value}"/>
  <param name="cache-large-message-client" value="{value}"/>
  <param name="call-failover-timeout" value="{value}"/>
  <param name="call-timeout" value="{value}"/>
  <param name="client-failure-check-period" value="{value}"/>
  <param name="client-id" value="{value}"/>
  <param name="compress-large-messages" value="{value}"/>
  <param name="confirmation-window-size" value="{value}"/>
  <param name="connection-load-balancing-policy-class-name" value="{value}"/>
  <param name="connection-ttl" value="{value}"/>
  <param name="connectors" value="{value}"/>
  <param name="consumer-max-rate" value="{value}"/>
  <param name="consumer-window-size" value="{value}"/>
  <param name="discovery-group" value="{value}"/>
  <param name="dups-ok-batch-size" value="{value}"/>
  <param name="entries" value="{value}"/>
  <param name="factory-type" value="{value}"/>
  <param name="failover-on-initial-connection" value="{value}"/>
  <param name="group-id" value="{value}"/>
  <param name="ha" value="{value}"/>
  <param name="initial-connect-attempts" value="{value}"/>
  <param name="initial-message-packet-size" value="{value}"/>
  <param name="max-retry-interval" value="{value}"/>
  <param name="min-large-message-size" value="{value}"/>
  <param name="pre-acknowledge" value="{value}"/>
  <param name="producer-max-rate" 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="scheduled-thread-pool-max-size" value="{value}"/>
  <param name="thread-pool-max-size" value="{value}"/>
  <param name="transaction-batch-size" value="{value}"/>
  <param name="use-global-pools" value="{value}"/>
<feature/>