PooledConnectionFactory (api 0.3.4 API)

java.lang.Object
- org.wildfly.swarm.config.messaging_activemq.server.PooledConnectionFactory

public class PooledConnectionFactory
extends Object

Defines a managed connection factory.

Constructor Summary

Constructors
Constructor and Description

PooledConnectionFactory(String key)

Constructors
Constructor and Description
`PooledConnectionFactory(String key)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`autoGroup()` The autogroup.
`PooledConnectionFactory`	`autoGroup(Boolean value)` The autogroup.
`Boolean`	`blockOnAcknowledge()` True to set block on acknowledge.
`PooledConnectionFactory`	`blockOnAcknowledge(Boolean value)` True to set block on acknowledge.
`Boolean`	`blockOnDurableSend()` True to set block on durable send.
`PooledConnectionFactory`	`blockOnDurableSend(Boolean value)` True to set block on durable send.
`Boolean`	`blockOnNonDurableSend()` True to set block on non durable send.
`PooledConnectionFactory`	`blockOnNonDurableSend(Boolean value)` True to set block on non durable send.
`Boolean`	`cacheLargeMessageClient()` True to cache large messages.
`PooledConnectionFactory`	`cacheLargeMessageClient(Boolean value)` True to cache large messages.
`Long`	`callFailoverTimeout()` The timeout to use when fail over is in process (in ms).
`PooledConnectionFactory`	`callFailoverTimeout(Long value)` The timeout to use when fail over is in process (in ms).
`Long`	`callTimeout()` The call time out.
`PooledConnectionFactory`	`callTimeout(Long value)` The call time out.
`Long`	`clientFailureCheckPeriod()` The client failure check period.
`PooledConnectionFactory`	`clientFailureCheckPeriod(Long value)` The client failure check period.
`String`	`clientId()` The client id.
`PooledConnectionFactory`	`clientId(String value)` The client id.
`Boolean`	`compressLargeMessages()` Whether large messages should be compressed.
`PooledConnectionFactory`	`compressLargeMessages(Boolean value)` Whether large messages should be compressed.
`Integer`	`confirmationWindowSize()` The confirmation window size.
`PooledConnectionFactory`	`confirmationWindowSize(Integer value)` The confirmation window size.
`String`	`connectionLoadBalancingPolicyClassName()` 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.
`PooledConnectionFactory`	`connectionLoadBalancingPolicyClassName(String value)` 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.
`Long`	`connectionTtl()` The connection ttl.
`PooledConnectionFactory`	`connectionTtl(Long value)` The connection ttl.
`List<String>`	`connectors()` Defines the connectors.
`PooledConnectionFactory`	`connectors(List<String> value)` Defines the connectors.
`Integer`	`consumerMaxRate()` The consumer max rate.
`PooledConnectionFactory`	`consumerMaxRate(Integer value)` The consumer max rate.
`Integer`	`consumerWindowSize()` The consumer window size.
`PooledConnectionFactory`	`consumerWindowSize(Integer value)` The consumer window size.
`String`	`discoveryGroup()` The discovery group name.
`PooledConnectionFactory`	`discoveryGroup(String value)` The discovery group name.
`Integer`	`dupsOkBatchSize()` The dups ok batch size.
`PooledConnectionFactory`	`dupsOkBatchSize(Integer value)` The dups ok batch size.
`List<String>`	`entries()` The jndi names the connection factory should be bound to.
`PooledConnectionFactory`	`entries(List<String> value)` The jndi names the connection factory should be bound to.
`Boolean`	`failoverOnInitialConnection()` True to fail over on initial connection.
`PooledConnectionFactory`	`failoverOnInitialConnection(Boolean value)` True to fail over on initial connection.
`String`	`getKey()`
`String`	`groupId()` The group id.
`PooledConnectionFactory`	`groupId(String value)` The group id.
`Boolean`	`ha()` Whether the connection factory supports High Availability.
`PooledConnectionFactory`	`ha(Boolean value)` Whether the connection factory supports High Availability.
`Integer`	`initialConnectAttempts()` The number of attempts to connect initially with this factory.
`PooledConnectionFactory`	`initialConnectAttempts(Integer value)` The number of attempts to connect initially with this factory.
`Integer`	`initialMessagePacketSize()` The initial size of messages created through this factory.
`PooledConnectionFactory`	`initialMessagePacketSize(Integer value)` The initial size of messages created through this factory.
`String`	`jndiParams()` The JNDI params to use for locating the destination for incoming connections.
`PooledConnectionFactory`	`jndiParams(String value)` The JNDI params to use for locating the destination for incoming connections.
`Integer`	`maxPoolSize()` The maximum size for the pool
`PooledConnectionFactory`	`maxPoolSize(Integer value)` The maximum size for the pool
`Long`	`maxRetryInterval()` The max retry interval.
`PooledConnectionFactory`	`maxRetryInterval(Long value)` The max retry interval.
`Integer`	`minLargeMessageSize()` The min large message size.
`PooledConnectionFactory`	`minLargeMessageSize(Integer value)` The min large message size.
`Integer`	`minPoolSize()` The minimum size for the pool
`PooledConnectionFactory`	`minPoolSize(Integer value)` The minimum size for the pool
`String`	`password()` The default password to use with this connection factory.
`PooledConnectionFactory`	`password(String value)` The default password to use with this connection factory.
`Boolean`	`preAcknowledge()` True to pre-acknowledge.
`PooledConnectionFactory`	`preAcknowledge(Boolean value)` True to pre-acknowledge.
`Integer`	`producerMaxRate()` The producer max rate.
`PooledConnectionFactory`	`producerMaxRate(Integer value)` The producer max rate.
`Integer`	`producerWindowSize()` The producer window size.
`PooledConnectionFactory`	`producerWindowSize(Integer value)` The producer window size.
`Integer`	`reconnectAttempts()` The reconnect attempts.
`PooledConnectionFactory`	`reconnectAttempts(Integer value)` The reconnect attempts.
`Long`	`retryInterval()` The retry interval.
`PooledConnectionFactory`	`retryInterval(Long value)` The retry interval.
`BigDecimal`	`retryIntervalMultiplier()` The retry interval multiplier.
`PooledConnectionFactory`	`retryIntervalMultiplier(BigDecimal value)` The retry interval multiplier.
`Integer`	`scheduledThreadPoolMaxSize()` The scheduled thread pool max size.
`PooledConnectionFactory`	`scheduledThreadPoolMaxSize(Integer value)` The scheduled thread pool max size.
`Integer`	`setupAttempts()` The number of times to set up an MDB endpoint
`PooledConnectionFactory`	`setupAttempts(Integer value)` The number of times to set up an MDB endpoint
`Long`	`setupInterval()` The interval between attempts at setting up an MDB endpoint.
`PooledConnectionFactory`	`setupInterval(Long value)` The interval between attempts at setting up an MDB endpoint.
`Integer`	`threadPoolMaxSize()` The thread pool max size.
`PooledConnectionFactory`	`threadPoolMaxSize(Integer value)` The thread pool max size.
`String`	`transaction()` TODO
`PooledConnectionFactory`	`transaction(String value)` TODO
`Integer`	`transactionBatchSize()` The transaction batch size.
`PooledConnectionFactory`	`transactionBatchSize(Integer value)` The transaction batch size.
`Boolean`	`useAutoRecovery()` True to use auto recovery.
`PooledConnectionFactory`	`useAutoRecovery(Boolean value)` True to use auto recovery.
`Boolean`	`useGlobalPools()` True to use global pools.
`PooledConnectionFactory`	`useGlobalPools(Boolean value)` True to use global pools.
`Boolean`	`useJndi()` Use JNDI to locate the destination for incoming connections
`PooledConnectionFactory`	`useJndi(Boolean value)` Use JNDI to locate the destination for incoming connections
`Boolean`	`useLocalTx()` Use a local transaction for incoming sessions
`PooledConnectionFactory`	`useLocalTx(Boolean value)` Use a local transaction for incoming sessions
`String`	`user()` The default username to use with this connection factory.
`PooledConnectionFactory`	`user(String value)` The default username to use with this connection factory.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PooledConnectionFactory
```
public PooledConnectionFactory(String key)
```
- Method Detail
  - getKey
```
public String getKey()
```
  - autoGroup
```
public Boolean autoGroup()
```
    The autogroup.
  - autoGroup
```
public PooledConnectionFactory autoGroup(Boolean value)
```
    The autogroup.
  - blockOnAcknowledge
```
public Boolean blockOnAcknowledge()
```
    True to set block on acknowledge.
  - blockOnAcknowledge
```
public PooledConnectionFactory blockOnAcknowledge(Boolean value)
```
    True to set block on acknowledge.
  - blockOnDurableSend
```
public Boolean blockOnDurableSend()
```
    True to set block on durable send.
  - blockOnDurableSend
```
public PooledConnectionFactory blockOnDurableSend(Boolean value)
```
    True to set block on durable send.
  - blockOnNonDurableSend
```
public Boolean blockOnNonDurableSend()
```
    True to set block on non durable send.
  - blockOnNonDurableSend
```
public PooledConnectionFactory blockOnNonDurableSend(Boolean value)
```
    True to set block on non durable send.
  - cacheLargeMessageClient
```
public Boolean cacheLargeMessageClient()
```
    True to cache large messages.
  - cacheLargeMessageClient
```
public PooledConnectionFactory cacheLargeMessageClient(Boolean value)
```
    True to cache large messages.
  - callFailoverTimeout
```
public Long callFailoverTimeout()
```
    The timeout to use when fail over is in process (in ms).
  - callFailoverTimeout
```
public PooledConnectionFactory callFailoverTimeout(Long value)
```
    The timeout to use when fail over is in process (in ms).
  - callTimeout
```
public Long callTimeout()
```
    The call time out.
  - callTimeout
```
public PooledConnectionFactory callTimeout(Long value)
```
    The call time out.
  - clientFailureCheckPeriod
```
public Long clientFailureCheckPeriod()
```
    The client failure check period.
  - clientFailureCheckPeriod
```
public PooledConnectionFactory clientFailureCheckPeriod(Long value)
```
    The client failure check period.
  - clientId
```
public String clientId()
```
    The client id.
  - clientId
```
public PooledConnectionFactory clientId(String value)
```
    The client id.
  - compressLargeMessages
```
public Boolean compressLargeMessages()
```
    Whether large messages should be compressed.
  - compressLargeMessages
```
public PooledConnectionFactory compressLargeMessages(Boolean value)
```
    Whether large messages should be compressed.
  - confirmationWindowSize
```
public Integer confirmationWindowSize()
```
    The confirmation window size.
  - confirmationWindowSize
```
public PooledConnectionFactory confirmationWindowSize(Integer value)
```
    The confirmation window size.
  - connectionLoadBalancingPolicyClassName
```
public String connectionLoadBalancingPolicyClassName()
```
    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.
  - connectionLoadBalancingPolicyClassName
```
public PooledConnectionFactory connectionLoadBalancingPolicyClassName(String value)
```
    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.
  - connectionTtl
```
public Long connectionTtl()
```
    The connection ttl.
  - connectionTtl
```
public PooledConnectionFactory connectionTtl(Long value)
```
    The connection ttl.
  - connectors
```
public List<String> 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.
  - connectors
```
public PooledConnectionFactory connectors(List<String> value)
```
    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.
  - consumerMaxRate
```
public Integer consumerMaxRate()
```
    The consumer max rate.
  - consumerMaxRate
```
public PooledConnectionFactory consumerMaxRate(Integer value)
```
    The consumer max rate.
  - consumerWindowSize
```
public Integer consumerWindowSize()
```
    The consumer window size.
  - consumerWindowSize
```
public PooledConnectionFactory consumerWindowSize(Integer value)
```
    The consumer window size.
  - discoveryGroup
```
public String discoveryGroup()
```
    The discovery group name.
  - discoveryGroup
```
public PooledConnectionFactory discoveryGroup(String value)
```
    The discovery group name.
  - dupsOkBatchSize
```
public Integer dupsOkBatchSize()
```
    The dups ok batch size.
  - dupsOkBatchSize
```
public PooledConnectionFactory dupsOkBatchSize(Integer value)
```
    The dups ok batch size.
  - entries
```
public List<String> entries()
```
    The jndi names the connection factory should be bound to.
  - entries
```
public PooledConnectionFactory entries(List<String> value)
```
    The jndi names the connection factory should be bound to.
  - failoverOnInitialConnection
```
public Boolean failoverOnInitialConnection()
```
    True to fail over on initial connection.
  - failoverOnInitialConnection
```
public PooledConnectionFactory failoverOnInitialConnection(Boolean value)
```
    True to fail over on initial connection.
  - groupId
```
public String groupId()
```
    The group id.
  - groupId
```
public PooledConnectionFactory groupId(String value)
```
    The group id.
  - ha
```
public Boolean ha()
```
    Whether the connection factory supports High Availability.
  - ha
```
public PooledConnectionFactory ha(Boolean value)
```
    Whether the connection factory supports High Availability.
  - initialConnectAttempts
```
public Integer initialConnectAttempts()
```
    The number of attempts to connect initially with this factory.
  - initialConnectAttempts
```
public PooledConnectionFactory initialConnectAttempts(Integer value)
```
    The number of attempts to connect initially with this factory.
  - initialMessagePacketSize
```
public Integer initialMessagePacketSize()
```
    The initial size of messages created through this factory.
  - initialMessagePacketSize
```
public PooledConnectionFactory initialMessagePacketSize(Integer value)
```
    The initial size of messages created through this factory.
  - maxPoolSize
```
public Integer maxPoolSize()
```
    The maximum size for the pool
  - maxPoolSize
```
public PooledConnectionFactory maxPoolSize(Integer value)
```
    The maximum size for the pool
  - maxRetryInterval
```
public Long maxRetryInterval()
```
    The max retry interval.
  - maxRetryInterval
```
public PooledConnectionFactory maxRetryInterval(Long value)
```
    The max retry interval.
  - minLargeMessageSize
```
public Integer minLargeMessageSize()
```
    The min large message size.
  - minLargeMessageSize
```
public PooledConnectionFactory minLargeMessageSize(Integer value)
```
    The min large message size.
  - minPoolSize
```
public Integer minPoolSize()
```
    The minimum size for the pool
  - minPoolSize
```
public PooledConnectionFactory minPoolSize(Integer value)
```
    The minimum size for the pool
  - password
```
public String password()
```
    The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host.
  - password
```
public PooledConnectionFactory password(String value)
```
    The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host.
  - preAcknowledge
```
public Boolean preAcknowledge()
```
    True to pre-acknowledge.
  - preAcknowledge
```
public PooledConnectionFactory preAcknowledge(Boolean value)
```
    True to pre-acknowledge.
  - producerMaxRate
```
public Integer producerMaxRate()
```
    The producer max rate.
  - producerMaxRate
```
public PooledConnectionFactory producerMaxRate(Integer value)
```
    The producer max rate.
  - producerWindowSize
```
public Integer producerWindowSize()
```
    The producer window size.
  - producerWindowSize
```
public PooledConnectionFactory producerWindowSize(Integer value)
```
    The producer window size.
  - reconnectAttempts
```
public Integer reconnectAttempts()
```
    The reconnect attempts. By default, a pooled connection factory will try to reconnect infinitely to the messaging server(s).
  - reconnectAttempts
```
public PooledConnectionFactory reconnectAttempts(Integer value)
```
    The reconnect attempts. By default, a pooled connection factory will try to reconnect infinitely to the messaging server(s).
  - retryInterval
```
public Long retryInterval()
```
    The retry interval.
  - retryInterval
```
public PooledConnectionFactory retryInterval(Long value)
```
    The retry interval.
  - retryIntervalMultiplier
```
public BigDecimal retryIntervalMultiplier()
```
    The retry interval multiplier.
  - retryIntervalMultiplier
```
public PooledConnectionFactory retryIntervalMultiplier(BigDecimal value)
```
    The retry interval multiplier.
  - scheduledThreadPoolMaxSize
```
public Integer scheduledThreadPoolMaxSize()
```
    The scheduled thread pool max size.
  - scheduledThreadPoolMaxSize
```
public PooledConnectionFactory scheduledThreadPoolMaxSize(Integer value)
```
    The scheduled thread pool max size.
  - threadPoolMaxSize
```
public Integer threadPoolMaxSize()
```
    The thread pool max size.
  - threadPoolMaxSize
```
public PooledConnectionFactory threadPoolMaxSize(Integer value)
```
    The thread pool max size.
  - transaction
```
public String transaction()
```
    TODO
  - transaction
```
public PooledConnectionFactory transaction(String value)
```
    TODO
  - transactionBatchSize
```
public Integer transactionBatchSize()
```
    The transaction batch size.
  - transactionBatchSize
```
public PooledConnectionFactory transactionBatchSize(Integer value)
```
    The transaction batch size.
  - useAutoRecovery
```
public Boolean useAutoRecovery()
```
    True to use auto recovery.
  - useAutoRecovery
```
public PooledConnectionFactory useAutoRecovery(Boolean value)
```
    True to use auto recovery.
  - useGlobalPools
```
public Boolean useGlobalPools()
```
    True to use global pools.
  - useGlobalPools
```
public PooledConnectionFactory useGlobalPools(Boolean value)
```
    True to use global pools.
  - user
```
public String user()
```
    The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host.
  - user
```
public PooledConnectionFactory user(String value)
```
    The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host.
  - jndiParams
```
public String jndiParams()
```
    The JNDI params to use for locating the destination for incoming connections.
  - jndiParams
```
public PooledConnectionFactory jndiParams(String value)
```
    The JNDI params to use for locating the destination for incoming connections.
  - setupAttempts
```
public Integer setupAttempts()
```
    The number of times to set up an MDB endpoint
  - setupAttempts
```
public PooledConnectionFactory setupAttempts(Integer value)
```
    The number of times to set up an MDB endpoint
  - setupInterval
```
public Long setupInterval()
```
    The interval between attempts at setting up an MDB endpoint.
  - setupInterval
```
public PooledConnectionFactory setupInterval(Long value)
```
    The interval between attempts at setting up an MDB endpoint.
  - useJndi
```
public Boolean useJndi()
```
    Use JNDI to locate the destination for incoming connections
  - useJndi
```
public PooledConnectionFactory useJndi(Boolean value)
```
    Use JNDI to locate the destination for incoming connections
  - useLocalTx
```
public Boolean useLocalTx()
```
    Use a local transaction for incoming sessions
  - useLocalTx
```
public PooledConnectionFactory useLocalTx(Boolean value)
```
    Use a local transaction for incoming sessions

Class PooledConnectionFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PooledConnectionFactory

Method Detail

getKey

autoGroup

autoGroup

blockOnAcknowledge

blockOnAcknowledge

blockOnDurableSend

blockOnDurableSend

blockOnNonDurableSend

blockOnNonDurableSend

cacheLargeMessageClient

cacheLargeMessageClient

callFailoverTimeout

callFailoverTimeout

callTimeout

callTimeout

clientFailureCheckPeriod

clientFailureCheckPeriod

clientId

clientId

compressLargeMessages

compressLargeMessages

confirmationWindowSize

confirmationWindowSize

connectionLoadBalancingPolicyClassName

connectionLoadBalancingPolicyClassName

connectionTtl

connectionTtl

connectors

connectors

consumerMaxRate

consumerMaxRate

consumerWindowSize

consumerWindowSize

discoveryGroup

discoveryGroup

dupsOkBatchSize

dupsOkBatchSize

entries

entries

failoverOnInitialConnection

failoverOnInitialConnection

groupId

groupId

ha

ha

initialConnectAttempts

initialConnectAttempts

initialMessagePacketSize

initialMessagePacketSize

maxPoolSize

maxPoolSize

maxRetryInterval

maxRetryInterval

minLargeMessageSize

minLargeMessageSize

minPoolSize

minPoolSize

password

password

preAcknowledge

preAcknowledge

producerMaxRate

producerMaxRate

producerWindowSize

producerWindowSize

reconnectAttempts

reconnectAttempts

retryInterval

retryInterval

retryIntervalMultiplier

retryIntervalMultiplier

scheduledThreadPoolMaxSize

scheduledThreadPoolMaxSize