Management API Reference for pooled-connection-factory

Provided Capabilities (1)

Attributes (60)

• allow-local-transactions - Allow local transactions for outbond Jakarta Messaging Sessions (it does not apply to JMSContext that explicitly disallows it).

  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" : "Allow local transactions for outbond Jakarta Messaging Sessions (it does not apply to JMSContext that explicitly disallows it).", "attribute-group" : "outbound-config", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• auto-group - The autogroup.

  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" : "The autogroup.", "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	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 timeout to use when fail over is in process (in ms).", "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 }

• 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.apache.activemq.artemis.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.apache.activemq.artemis.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" : true, "nillable" : true, "alternatives" : ["discovery-group"], "capability-reference" : "org.wildfly.messaging.activemq.connector.external", "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

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

• credential-reference - Credential (from Credential Store) to authenticate the pooled connection factory

  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 pooled connection factory", "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 }

• deserialization-allow-list - A list of class names (separated by whitespaces) that are allowed to be used in serialization of Jakarta Messaging ObjectMessage.

  Type	LIST
  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" : "LIST" }, "description" : "A list of class names (separated by whitespaces) that are allowed to be used in serialization of Jakarta Messaging ObjectMessage.", "expressions-allowed" : true, "required" : false, "nillable" : true, "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 }

• deserialization-black-list - A list of class names (separated by whitespaces) that are not allowed to be used in serialization of Jakarta Messaging ObjectMessage.
  Deprecated Since 13.0.0

  Deprecated. Use deserialization-block-list instead.

  Type	LIST
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of class names (separated by whitespaces) that are not allowed to be used in serialization of Jakarta Messaging ObjectMessage.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["deserialization-block-list"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "13.0.0", "reason" : "Deprecated. Use deserialization-block-list instead." }, "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• deserialization-block-list - A list of class names (separated by whitespaces) that are not allowed to be used in serialization of Jakarta Messaging ObjectMessage.

  Type	LIST
  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" : "LIST" }, "description" : "A list of class names (separated by whitespaces) that are not allowed to be used in serialization of Jakarta Messaging ObjectMessage.", "expressions-allowed" : true, "required" : false, "nillable" : true, "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 }

• deserialization-white-list - A list of class names (separated by whitespaces) that are allowed to be used in serialization of Jakarta Messaging ObjectMessage.
  Deprecated Since 13.0.0

  Deprecated. Use deserialization-allow-list instead.

  Type	LIST
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of class names (separated by whitespaces) that are allowed to be used in serialization of Jakarta Messaging ObjectMessage.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["deserialization-allow-list"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "13.0.0", "reason" : "Deprecated. Use deserialization-allow-list instead." }, "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-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 }

• enable-amq1-prefix - Enable the use of ActiveMQ 1.5.x prefixes in the addresses.

  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" : "Enable the use of ActiveMQ 1.5.x prefixes in the addresses.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• enlistment-trace - Enables IronJacamar to record enlistment traces for this pooled-connection-factory. This attribute is undefined by default and the behaviour is driven by the presence of the ironjacamar.disable_enlistment_trace system property.

  Type	BOOLEAN
  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" : "Enables IronJacamar to record enlistment traces for this pooled-connection-factory. This attribute is undefined by default and the behaviour is driven by the presence of the ironjacamar.disable_enlistment_trace system property.", "expressions-allowed" : true, "required" : false, "nillable" : true, "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 }

• 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	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 connection factory supports High Availability.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "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 factory.

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

• jndi-params - The JNDI params to use for locating the destination for incoming connections.

  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 JNDI params to use for locating the destination for incoming connections.", "attribute-group" : "inbound-config", "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 }

• managed-connection-pool - The class name of the managed connection pool used by this pooled-connection-factory.

  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 class name of the managed connection pool used by this pooled-connection-factory.", "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 }

• max-pool-size - The maximum size for the pool

  Type	INT
  Default Value	20
  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 size for the pool", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 20, "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 }

• min-pool-size - The minimum size for the pool

  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 minimum size for the pool", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 0, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• password - The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host.

  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 default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host.", "expressions-allowed" : true, "required" : false, "nillable" : true, "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 }

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

• protocol-manager-factory - The protocol manager factory used by this pooled connection factory.

  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 protocol manager factory used by this pooled connection factory.", "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 }

• rebalance-connections - Rebalance inbound connections when cluster topology changes.

  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" : "Rebalance inbound connections when cluster topology changes.", "attribute-group" : "inbound-config", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• reconnect-attempts - The reconnect attempts. By default, a pooled connection factory will try to reconnect infinitely to the messaging server(s).

  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 reconnect attempts. By default, a pooled connection factory will try to reconnect infinitely to the messaging server(s).", "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 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 }

• setup-attempts - The number of times to set up an MDB endpoint

  Type	INT
  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 times to set up an MDB endpoint", "attribute-group" : "inbound-config", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• setup-interval - The interval between attempts at setting up an MDB endpoint.

  Type	LONG
  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 interval between attempts at setting up an MDB endpoint.", "attribute-group" : "inbound-config", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• statistics-enabled - Define whether runtime statistics are enabled.

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Define whether runtime statistics are enabled.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-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 - The type of transaction supported by this pooled connection factory (can be LOCAL, NONE or XA, default is XA).

  Type	STRING
  Default Value	xa
  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 none local
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of transaction supported by this pooled connection factory (can be LOCAL, NONE or XA, default is XA).", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "xa", "allowed" : [ "local", "none", "xa" ], "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-auto-recovery - True to use auto recovery.

  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 auto recovery.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "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 }

• use-jndi - Use JNDI to locate the destination for incoming connections

  Type	BOOLEAN
  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" : "Use JNDI to locate the destination for incoming connections", "attribute-group" : "inbound-config", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• use-local-tx - Use a local transaction for incoming sessions

  Type	BOOLEAN
  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" : "Use a local transaction for incoming sessions", "attribute-group" : "inbound-config", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• use-topology-for-load-balancing - Whether to use topology information from the cluster to connect to it. If set to 'false', only the initial connector will be used.

  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 to use topology information from the cluster to connect to it. If set to 'false', only the initial connector will be used.", "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 default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host.

  Type	STRING
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "messaging-security" : {"type" : "messaging-activemq"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

Operations (2)

• add - Adds a managed connection factory.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  auto-group	BOOLEAN	false	true	false	The autogroup.
  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	60000	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.apache.activemq.artemis.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	true	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.
  credential-reference	OBJECT	false	false		Credential (from Credential Store) to authenticate the pooled connection factory
  deserialization-allow-list	LIST	false	true		A list of class names (separated by whitespaces) that are allowed to be used in serialization of Jakarta Messaging ObjectMessage.
  deserialization-black-list	LIST	false	true		A list of class names (separated by whitespaces) that are not allowed to be used in serialization of Jakarta Messaging ObjectMessage.
  deserialization-block-list	LIST	false	true		A list of class names (separated by whitespaces) that are not allowed to be used in serialization of Jakarta Messaging ObjectMessage.
  deserialization-white-list	LIST	false	true		A list of class names (separated by whitespaces) that are allowed to be used in serialization of Jakarta Messaging ObjectMessage.
  discovery-group	STRING	false	false		The discovery group name.
  dups-ok-batch-size	INT	false	true	1048576	The dups ok batch size.
  enable-amq1-prefix	BOOLEAN	false	true	true	Enable the use of ActiveMQ 1.5.x prefixes in the addresses.
  enlistment-trace	BOOLEAN	false	true		Enables IronJacamar to record enlistment traces for this pooled-connection-factory. This attribute is undefined by default and the behaviour is driven by the presence of the ironjacamar.disable_enlistment_trace system property.
  entries	LIST	true	true		The jndi names the connection factory should be bound to.
  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	true	Whether the connection factory supports High Availability.
  initial-connect-attempts	INT	false	true	-1	The number of attempts to connect initially with this factory.
  initial-message-packet-size	INT	false	true	1500	The initial size of messages created through this factory.
  managed-connection-pool	STRING	false	true		The class name of the managed connection pool used by this pooled-connection-factory.
  max-pool-size	INT	false	true	20	The maximum size for the pool
  max-retry-interval	LONG	false	true	2000	The max retry interval.
  min-large-message-size	INT	false	true	102400	The min large message size.
  min-pool-size	INT	false	true	0	The minimum size for the pool
  password	STRING	false	true		The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host.
  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.
  protocol-manager-factory	STRING	false	false		The protocol manager factory used by this pooled connection factory.
  reconnect-attempts	INT	false	true	-1	The reconnect attempts. By default, a pooled connection factory will try to reconnect infinitely to the messaging server(s).
  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.
  statistics-enabled	BOOLEAN	false	true	false	Define whether runtime statistics are enabled.
  thread-pool-max-size	INT	false	true	30	The thread pool max size.
  transaction	STRING	false	true	xa	The type of transaction supported by this pooled connection factory (can be LOCAL, NONE or XA, default is XA).
  transaction-batch-size	INT	false	true	1048576	The transaction batch size.
  use-auto-recovery	BOOLEAN	false	true	true	True to use auto recovery.
  use-global-pools	BOOLEAN	false	true	true	True to use global pools.
  use-topology-for-load-balancing	BOOLEAN	false	true	true	Whether to use topology information from the cluster to connect to it. If set to 'false', only the initial connector will be used.
  user	STRING	false	true		The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host.
  jndi-params	STRING	false	true		The JNDI params to use for locating the destination for incoming connections.
  rebalance-connections	BOOLEAN	false	true	false	Rebalance inbound connections when cluster topology changes.
  setup-attempts	INT	false	true		The number of times to set up an MDB endpoint
  setup-interval	LONG	false	true		The interval between attempts at setting up an MDB endpoint.
  use-jndi	BOOLEAN	false	true		Use JNDI to locate the destination for incoming connections
  use-local-tx	BOOLEAN	false	true		Use a local transaction for incoming sessions
  allow-local-transactions	BOOLEAN	false	true	false	Allow local transactions for outbond Jakarta Messaging Sessions (it does not apply to JMSContext that explicitly disallows it).

  Raw DMR model

  { "operation-name" : "add", "description" : "Adds a managed connection factory.", "request-properties" : { "auto-group" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "The autogroup.", "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" : 60000, "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.apache.activemq.artemis.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" : true, "nillable" : true, "alternatives" : ["discovery-group"], "capability-reference" : "org.wildfly.messaging.activemq.connector.external", "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" }, "credential-reference" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Credential (from Credential Store) to authenticate the pooled connection factory", "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" } } }, "deserialization-allow-list" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of class names (separated by whitespaces) that are allowed to be used in serialization of Jakarta Messaging ObjectMessage.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "deserialization-black-list" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of class names (separated by whitespaces) that are not allowed to be used in serialization of Jakarta Messaging ObjectMessage.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["deserialization-block-list"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "13.0.0", "reason" : "Deprecated. Use deserialization-block-list instead." }, "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "deserialization-block-list" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of class names (separated by whitespaces) that are not allowed to be used in serialization of Jakarta Messaging ObjectMessage.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "deserialization-white-list" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of class names (separated by whitespaces) that are allowed to be used in serialization of Jakarta Messaging ObjectMessage.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["deserialization-allow-list"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "13.0.0", "reason" : "Deprecated. Use deserialization-allow-list instead." }, "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "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" }, "enable-amq1-prefix" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enable the use of ActiveMQ 1.5.x prefixes in the addresses.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "enlistment-trace" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enables IronJacamar to record enlistment traces for this pooled-connection-factory. This attribute is undefined by default and the behaviour is driven by the presence of the ironjacamar.disable_enlistment_trace system property.", "expressions-allowed" : true, "required" : false, "nillable" : true, "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" } }, "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" : true, "stability" : "default" }, "initial-connect-attempts" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of attempts to connect initially with this factory.", "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, "unit" : "BYTES", "stability" : "default" }, "managed-connection-pool" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The class name of the managed connection pool used by this pooled-connection-factory.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "max-pool-size" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum size for the pool", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 20, "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" }, "min-pool-size" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The minimum size for the pool", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 0, "stability" : "default" }, "password" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["credential-reference"], "min-length" : 1, "max-length" : 2147483647, "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" }, "protocol-manager-factory" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The protocol manager factory used by this pooled connection factory.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "reconnect-attempts" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The reconnect attempts. By default, a pooled connection factory will try to reconnect infinitely to the messaging server(s).", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : -1, "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" }, "statistics-enabled" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Define whether runtime statistics are enabled.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "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" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of transaction supported by this pooled connection factory (can be LOCAL, NONE or XA, default is XA).", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "xa", "allowed" : [ "local", "none", "xa" ], "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-auto-recovery" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "True to use auto recovery.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "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" }, "use-topology-for-load-balancing" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to use topology information from the cluster to connect to it. If set to 'false', only the initial connector will be used.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "user" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "jndi-params" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The JNDI params to use for locating the destination for incoming connections.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "rebalance-connections" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Rebalance inbound connections when cluster topology changes.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "setup-attempts" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of times to set up an MDB endpoint", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "setup-interval" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The interval between attempts at setting up an MDB endpoint.", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "MILLISECONDS", "stability" : "default" }, "use-jndi" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Use JNDI to locate the destination for incoming connections", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "use-local-tx" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Use a local transaction for incoming sessions", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "allow-local-transactions" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Allow local transactions for outbond Jakarta Messaging Sessions (it does not apply to JMSContext that explicitly disallows it).", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - Removes managed connection factory.

  Raw DMR model

  { "operation-name" : "remove", "description" : "Removes managed 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.pooled-connection-factory

          
  <feature spec="subsystem.messaging-activemq.pooled-connection-factory">
    <param name="pooled-connection-factory" value="{resource name}"/>
    <param name="allow-local-transactions" value="{value}"/>
    <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="credential-reference" value="{value}"/>
    <param name="deserialization-allow-list" value="{value}"/>
    <param name="deserialization-black-list" value="{value}"/>
    <param name="deserialization-block-list" value="{value}"/>
    <param name="deserialization-white-list" value="{value}"/>
    <param name="discovery-group" value="{value}"/>
    <param name="dups-ok-batch-size" value="{value}"/>
    <param name="enable-amq1-prefix" value="{value}"/>
    <param name="enlistment-trace" value="{value}"/>
    <param name="entries" 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="jndi-params" value="{value}"/>
    <param name="managed-connection-pool" value="{value}"/>
    <param name="max-pool-size" value="{value}"/>
    <param name="max-retry-interval" value="{value}"/>
    <param name="min-large-message-size" value="{value}"/>
    <param name="min-pool-size" value="{value}"/>
    <param name="password" value="{value}"/>
    <param name="pre-acknowledge" value="{value}"/>
    <param name="producer-max-rate" value="{value}"/>
    <param name="producer-window-size" value="{value}"/>
    <param name="protocol-manager-factory" value="{value}"/>
    <param name="rebalance-connections" 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="setup-attempts" value="{value}"/>
    <param name="setup-interval" value="{value}"/>
    <param name="statistics-enabled" value="{value}"/>
    <param name="thread-pool-max-size" value="{value}"/>
    <param name="transaction" value="{value}"/>
    <param name="transaction-batch-size" value="{value}"/>
    <param name="use-auto-recovery" value="{value}"/>
    <param name="use-global-pools" value="{value}"/>
    <param name="use-jndi" value="{value}"/>
    <param name="use-local-tx" value="{value}"/>
    <param name="use-topology-for-load-balancing" value="{value}"/>
    <param name="user" value="{value}"/>
  <feature/>
          
        

  📋