WildFly Full 27 Model Reference

  1. home
  2. deployment
  3. subdeployment
  4. subsystem=messaging-activemq
  5. connection-factory

Defines a connection factory.

Provided capabilities(1)

Attributes (43)

  • auto-group Whether or not message grouping is automatically used
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • block-on-acknowledge True to set block on acknowledge.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • block-on-durable-send True to set block on durable send.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • block-on-non-durable-send True to set block on non durable send.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • cache-large-message-client True to cache large messages.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • call-failover-timeout The timeout to use when fail over is in process (in ms).
    • Attribute Value
    Default Value 60000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • call-timeout The call time out.
    • Attribute Value
    Default Value 30000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • client-failure-check-period The client failure check period.
    • Attribute Value
    Default Value 30000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • client-id The client id.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • compress-large-messages Whether large messages should be compressed.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • confirmation-window-size The confirmation window size.
    • Attribute Value
    Default Value -1
    Type INT
    Nillable true
    Expressions Allowed true
    Unit BYTES
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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.
    • Attribute Value
    Default Value org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • connection-ttl The connection ttl.
    • Attribute Value
    Default Value 60000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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.
    • Attribute Value
    Capability reference org.wildfly.messaging.activemq.connector.external
    Type LIST
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • consumer-max-rate The consumer max rate.
    • Attribute Value
    Default Value -1
    Type INT
    Nillable true
    Expressions Allowed true
    Unit PER_SECOND
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • consumer-window-size The consumer window size.
    • Attribute Value
    Default Value 1048576
    Type INT
    Nillable true
    Expressions Allowed true
    Unit BYTES
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • deserialization-allow-list A list of class names (separated by whitespaces) that are allowed to be used in serialization of Jakarta Messaging ObjectMessage.
    • Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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.
    Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • deserialization-block-list A list of class names (separated by whitespaces) that are not allowed to be used in serialization of Jakarta Messaging ObjectMessage.
    • Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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.
    Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • discovery-group The discovery group name.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • dups-ok-batch-size The dups ok batch size.
    • Attribute Value
    Default Value 1048576
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • enable-amq1-prefix Enable the use of ActiveMQ 1.5.x prefixes in the addresses.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • entries The jndi names the connection factory should be bound to.
    • Attribute Value
    Type LIST
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • factory-type The type of connection factory.
    • Attribute Value
    Default Value GENERIC
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Allowed Values GENERIC
    TOPIC
    QUEUE
    XA_GENERIC
    XA_QUEUE
    XA_TOPIC
  • failover-on-initial-connection True to fail over on initial connection.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • group-id The group id.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • ha Whether the connection factory supports High Availability.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • initial-message-packet-size The initial size of messages created through this factory.
    • Attribute Value
    Default Value 1500
    Type INT
    Nillable true
    Expressions Allowed true
    Unit BYTES
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • max-retry-interval The max retry interval.
    • Attribute Value
    Default Value 2000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • min-large-message-size The min large message size.
    • Attribute Value
    Default Value 102400
    Type INT
    Nillable true
    Expressions Allowed true
    Unit BYTES
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • pre-acknowledge True to pre-acknowledge.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • producer-max-rate The producer max rate.
    • Attribute Value
    Default Value -1
    Type INT
    Nillable true
    Expressions Allowed true
    Unit PER_SECOND
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • producer-window-size The producer window size.
    • Attribute Value
    Default Value 65536
    Type INT
    Nillable true
    Expressions Allowed true
    Unit BYTES
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • protocol-manager-factory The protocol manager factory used by this connection factory (it must implement org.apache.activemq.artemis.spi.core.remoting.ClientProtocolManagerFactory).
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • reconnect-attempts The reconnect attempts.
    • Attribute Value
    Default Value 0
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • retry-interval The retry interval.
    • Attribute Value
    Default Value 2000
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • retry-interval-multiplier The retry interval multiplier.
    • Attribute Value
    Default Value 1.0
    Type DOUBLE
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • scheduled-thread-pool-max-size The scheduled thread pool max size.
    • Attribute Value
    Default Value 5
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • thread-pool-max-size The thread pool max size.
    • Attribute Value
    Default Value 30
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • transaction-batch-size The transaction batch size.
    • Attribute Value
    Default Value 1048576
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • use-global-pools True to use global pools.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services

Operations (4)

  • 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 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.
    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 true 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.
    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-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.
    protocol-manager-factory STRING false false The protocol manager factory used by this connection factory (it must implement org.apache.activemq.artemis.spi.core.remoting.ClientProtocolManagerFactory).
    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.
    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.
  • add-jndi Adds the factory to another JNDI binding
    Request Parameter Type Required Expressions Allowed Default value Description
    jndi-binding STRING true false Jndi binding
  • remove Removes a connection factory.
  • remove-jndi Removes the JNDI binding
    Request Parameter Type Required Expressions Allowed Default value Description
    jndi-binding STRING true false Jndi binding