JMSConnectionFactory

This class represents a JMS connection factory. Connection factories are objects that enable JMS clients to create JMS connections.

Table 24-1 JMSConnectionFactory attributes

Attribute	Description	Range of Values and Default
AcknowledgePolicy	Return the value of the AcknowledgePolicy attribute for the connection factory. Note: This attribute only applies to implementations that use the CLIENT_ACKNOWLEDGE acknowledge mode for a non-transacted session. This attribute works around a change in the JMS specification. Specifically, the specification allowed users to acknowledge all messages before and including the message geing acknowledged. The specification was changed so that acknowledging any message acknowledges all messages ever received (even those received after the message being acknowledge), as follows: An acknowledge policy of ACKNOWLEDGE_PREVIOUS retains the old behavior (acknowledge all message up to and including the message being acknowledged). An acknowledge policy of ACKNOWLEDGE_ALL yields the new behavior, where all messages received by the given session are acknowledged regardless of which message is being used to effect the acknowledge.	Admin Console field label: Acknowledge Policy Required: no Default: All
AllowCloseInOnMessage	Return the value of the AllowCloseInOnMessage attribute for the connection factory. Indicates whether or not a connection factory creates message consumers that allow a close() method to be issued within its onMessage() method call. If selected (true), a close() method call from within an onMessage() method call will succeed instead of blocking forever. If the acknowledge mode of the session is set to AUTO_ACKNOWLEDGE, the current message will still be acknowledged automatically when the onMessage() call completes. If not selected (false), it will cause the stop() and close() methods to hang if called from onMessage(). This attribute is dynamic and can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.	Admin Console field label: Allow Close In On Message Required: no Default: false
ClientId	Return the client ID for a durable subscriber that uses this connection factory.	Admin Console field label: Client Id Required: no
DefaultDeliveryMode	Return the value of the DefaultDeliveryMode attribute for the connection factory. The default delivery mode used for messages for which a delivery mode is not explicitly defined. All messages with a DefaultDeliveryMode of null that are produced on a connection created with this factory will receive this value.	Admin Console field label: Default Delivery Mode Required: no Default: Persistent
DefaultPriority	Return the defaultPriority attribute for the connection factory. The default priority used for messages for which a priority is not explicitly defined. All messages with a DefaultPriority of -1 that are produced on a connection created with this factory will receive this value.	Admin Console field label: Default Priority Required: no Default: 4 Minimum: 0 Maximum: 9
DefaultRedeliveryDelay	Return the value of the defaultRedeliveryDelay attribute for the connection factory. A redelivery delay defines the delay, in milliseconds, before rolled back or recovered messages are redelivered. All messages consumed by a consumer created with this factory that have a DefaultRedeliveryDelay of -1 will use this value.	Admin Console field label: Default Redelivery Delay Required: no Default: 0 Minimum: 0 Maximum: 2⁶³-1
DefaultTimeToDeliver	Return the value of the DefaultTimeToDeliver attribute for the connection factory. A time-to-deliver defines the delay, in milliseconds, between when a message is produced and when it is made visible on its destination. All messages produced by a producer created with this factory that have a DefaultTimeToDeliver of -1 will use this value.	Admin Console field label: Default Time To Deliver Required: no Default: 0 Minimum: 0 Maximum: 2⁶³-1
DefaultTimeToLive	Return the value of the DefaultTimeToLive attribute for the connection factory. The default maximum length of time, in milliseconds, that a message will exist. Used for messages for which a priority was not explicitly defined. A value of 0 indicates that the message has an infinite amount time to live. All messages with a DefaultTimeToLive of -1 that are produced on a connection created with this factory will receive this value expressed in milliseconds.	Admin Console field label: Default Time To Live Required: no Default: 0 Minimum: 0 Maximum: 2⁶³-1
DeploymentOrder	A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type. For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes. Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.	Required: no Default: 1000 Minimum: 0 Maximum: 2³¹-1
FlowControlEnabled	Return the value of the FlowControlEnabled attribute for the connection factory. Indicates whether or not a producer created using a connection factory allows flow control. If true, the associated message producers will be slowed down if the JMS server reaches Btyes/Messages ThresholdHigh.	Admin Console field label: Flow Control Enabled Required: no Default: true
FlowInterval	Return the value of the FlowInterval attribute for the connection factory. An adjustment period of time, defined in seconds, when a producer adjusts its flow from the Flow Maximum number of messages to the Flow Minimum amount, or vice versa. When a producer is flow controlled it is slowed down from its FlowMaximum to its FlowMinimum over FlowInterval seconds.	Admin Console field label: Flow Interval (seconds) Required: no Units: seconds Default: 60 Minimum: 0 Maximum: 2³¹-1
FlowMaximum	Get the value of the FlowMaximum attribute for the connection factory. The maximum number of messages per second for a producer that is experiencing a threshold condition. When a producer is flow controlled it will never be allowed to go faster than FlowMaximum messages per second. If a producer is not currently limiting its flow when a threshold condition is reached, the initial flow limit for that producer is set to Flow Maximum. If a producer is already limiting its flow when a threshold condition is reached (the flow limit is less than Flow Maximum), then the producer will continue at its current flow limit until the next time the flow is evaluated. Note: Once a threshold condition has subsided, the producer is not permitted to ignore its flow limit. If its flow limit is less than the Flow Maximum, then the producer must gradually increase its flow to the Flow Maximum each time the flow is evaluated. When the producer finally reaches the Flow Maximum, it can then ignore its flow limit and send without limiting its flow.	Admin Console field label: Flow Maximum Required: no Units: messages/second Default: 500 Minimum: 1 Maximum: 2³¹-1
FlowMinimum	Get the value of the FlowMinimum attribute for the connection factory. The minimum number of messages per second for a producer that is experiencing a threshold condition. This is the lower boundary of a producer's flow limit. That is, WebLogic JMS will not further slow down a producer whose message flow limit is at its Flow Minimum. When a producer is flow controlled it will never be required to go slower than FlowMinimum messages per second.	Admin Console field label: Flow Minimum Required: no Units: messages/second Default: 50 Minimum: 1 Maximum: 2³¹-1
FlowSteps	Get the value of the FlowSteps attribute for the connection factory. The number of steps used when a producer is adjusting its flow from the Flow Maximum amount of messages to the Flow Minimum amount, or vice versa. Specifically, the Flow Interval adjustment period is divided into the number of Flow Steps (for example, 60 seconds divided by 6 steps is 10 seconds per step). Also, the movement (i.e., the rate of adjustment) is calculated by dividing the difference between the Flow Maximum and the Flow Minimum into steps. At each Flow Step, the flow is adjusted upward or downward, as necessary, based on the current conditions, as follows: The downward movement (the decay) is geometric over the specified period of time (Flow Interval) and according to the specified number of Flow Steps. (For example, 100, 50, 25, 12.5) The movement upward is linear. The difference is simply divided by the number of steps.	Admin Console field label: Flow Steps Required: no Default: 10 Minimum: 1 Maximum: 2³¹-1
JNDIName	Return the JNDI name of the JMS connection factory. This is the name that is assigned to and used to look up the connection factory within the JNDI namespace. The connection factory name is configured separately.	Admin Console field label: JNDIName Required: no
LoadBalancingEnabled	Return the value of the LoadBalancingEnabled attribute for the connection factory. For distributed destinations, specifies whether non-anonymous producers created through a connection factory are load balanced within a distributed destination on a per-call basis. If true, the associated message producers will be load balanced on every send() or publish(). If false, the associated message producers will be load balanced on the first send() or publish().	Admin Console field label: Load Balancing Enabled Required: no Default: true
MessagesMaximum	Return the value of the MessagesMaximum attribute for the connection factory. The maximum number of messages that may exist for an asynchronous session and that have not yet been passed to the message listener. A value of -1 indicates that there is no limit on the number of messages. In this case, however, the limit is set to the amount of remaining virtual memory. A value of 0 is not valid and will cause various exceptions to be thrown. When the number of messages reaches the MessagesMaximum value: For multicast sessions, new messages are discarded according the policy specified by the OverrunPolicy attribute and a DataOverrunException is thrown. For non-multicast sessions, new messages are flow-controlled, or retained on the server until the application can accommodate the messages. For multicast sessions, when a connection is stopped, messages will continue to be delivered, but only until the MessagesMaximum value is reached. Once this value is reached, messages will be discarded based on the Overrun policy.	Admin Console field label: Messages Maximum Required: no Default: 10 Minimum: -1 Maximum: 2³¹-1
Name	The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.	Admin Console field label: Name Required: no
Notes	Optional information that you can include to describe this configuration.	Admin Console field label: Notes Required: no
OverrunPolicy	Return the value of the OverrunPolicy attribute for the connection factory. Th Overrun Policy applies to multicast messages. When the number of outstanding messages reaches the MessagesMaximum attribute value, messages are discarded based on the specified policy. If set to KeepNew, the most recent messages are given priority over the oldest messages, and the oldest messages are discarded, as needed. If set to KeepOld, the oldest messages are given priority over the most recent messages, and the most recent messages are discarded, as needed. Message age is defined by the order of receipt, not by the JMSTimestamp value.	Admin Console field label: Overrun Policy Required: no Default: KeepOld
ServerAffinityEnabled	Return the value of the ServerAffinityEnabled attribute for the connection factory. For distributed destinations, specifies whether a WebLogic Server instance that is load balancing consumers or producers across multiple physical destinations (queues or topics) in a distributed destination, will first attempt to load balance across any other physical destinations that are also running in the same instance.	Admin Console field label: Server Affinity Enabled Required: no Default: true
Targets	The targets in the current domain on which this item can be deployed.	Required: no
TransactionTimeout	Return the value of the TransactionTimeout attribute for the connection factory. All transactions on connections created with this connection factory will have this timeout value expressed in seconds. If a transacted session is still active after the timeout has elapsed, the transaction is rolled back. A value of 0 indicates that the default value will be used. If you have long-running transactions, you might want to adjust the value of this attribute to allow transactions to complete.	Admin Console field label: Transaction Timeout Required: no Default: 3600 Minimum: 0 Maximum: 2³¹-1
UserTransactionsEnabled	Return the value of the UserTransactionsEnabled attribute. Indicates whether or not a connection factory creates sessions that are JTA aware. If true, the associated message producers and message consumers look into the running thread for a transaction context. Otherwise, the current JTA transaction will be ignored. However, if the XAConnectionFactoryEnabled flag is true, then the UserTransactionsEnabled attribute must also be true to return an XA connection factory. Note: Transacted sessions ignore the current threads transaction context in favor of their own internal transaction, regardless of the setting. This setting only affects non-transacted sessions.	Admin Console field label: User Transactions Enabled Required: no Default: false
XAConnectionFactoryEnabled	Return the value of the XAConnectionFactoryEnabled attribute for the connection factory. Indicates whether or not a XA queue or XA topic connection factory is returned, instead of a queue or topic connection factory. It can be used to return a XA queue session or XA topic session, which has the getXAResource method. In order for an XA connection factory to be returned, the UserTransactionsEnabled flag must also be set to true (since it defaults to false).	Admin Console field label: XAConnection Factory Enabled Required: no Default: false
XAServerEnabled	Return the value of the XAServerEnabled attribute for the connection factory. Determines whether XA-enabled JMS connections and sessions are always created when this connection factory is invoked from inside a WebLogic Server instance.	Admin Console field label: Server Side XA Enabled Required: no Default: false

Attribute

Description

Range of Values and Default

AcknowledgePolicy

Return the value of the AcknowledgePolicy attribute for the connection factory.

Note: This attribute only applies to implementations that use the CLIENT_ACKNOWLEDGE acknowledge mode for a non-transacted session.

This attribute works around a change in the JMS specification. Specifically, the specification allowed users to acknowledge all messages before and including the message geing acknowledged. The specification was changed so that acknowledging any message acknowledges all messages ever received (even those received after the message being acknowledge), as follows:

An acknowledge policy of ACKNOWLEDGE_PREVIOUS retains the old behavior (acknowledge all message up to and including the message being acknowledged).

An acknowledge policy of ACKNOWLEDGE_ALL yields the new behavior, where all messages received by the given session are acknowledged regardless of which message is being used to effect the acknowledge.

Admin Console field label: Acknowledge Policy

Required: no

Default: All

AllowCloseInOnMessage

Return the value of the AllowCloseInOnMessage attribute for the connection factory.

Indicates whether or not a connection factory creates message consumers that allow a close() method to be issued within its onMessage() method call.

If selected (true), a close() method call from within an onMessage() method call will succeed instead of blocking forever. If the acknowledge mode of the session is set to AUTO_ACKNOWLEDGE, the current message will still be acknowledged automatically when the onMessage() call completes.

If not selected (false), it will cause the stop() and close() methods to hang if called from onMessage().

This attribute is dynamic and can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.

Admin Console field label: Allow Close In On Message

Required: no

Default: false

ClientId

Return the client ID for a durable subscriber that uses this connection factory.

Admin Console field label: Client Id

Required: no

DefaultDeliveryMode

Return the value of the DefaultDeliveryMode attribute for the connection factory.

The default delivery mode used for messages for which a delivery mode is not explicitly defined. All messages with a DefaultDeliveryMode of null that are produced on a connection created with this factory will receive this value.

Admin Console field label: Default Delivery Mode

Required: no

Default: Persistent

DefaultPriority

Return the defaultPriority attribute for the connection factory.

The default priority used for messages for which a priority is not explicitly defined. All messages with a DefaultPriority of -1 that are produced on a connection created with this factory will receive this value.

Admin Console field label: Default Priority

Required: no

Default: 4

Minimum: 0

Maximum: 9

DefaultRedeliveryDelay

Return the value of the defaultRedeliveryDelay attribute for the connection factory.

A redelivery delay defines the delay, in milliseconds, before rolled back or recovered messages are redelivered. All messages consumed by a consumer created with this factory that have a DefaultRedeliveryDelay of -1 will use this value.

Admin Console field label: Default Redelivery Delay

Required: no

Default: 0

Minimum: 0

Maximum: 2⁶³-1

DefaultTimeToDeliver

Return the value of the DefaultTimeToDeliver attribute for the connection factory.

A time-to-deliver defines the delay, in milliseconds, between when a message is produced and when it is made visible on its destination. All messages produced by a producer created with this factory that have a DefaultTimeToDeliver of -1 will use this value.

Admin Console field label: Default Time To Deliver

Required: no

Default: 0

Minimum: 0

Maximum: 2⁶³-1

DefaultTimeToLive

Return the value of the DefaultTimeToLive attribute for the connection factory.

The default maximum length of time, in milliseconds, that a message will exist. Used for messages for which a priority was not explicitly defined. A value of 0 indicates that the message has an infinite amount time to live. All messages with a DefaultTimeToLive of -1 that are produced on a connection created with this factory will receive this value expressed in milliseconds.

Admin Console field label: Default Time To Live

Required: no

Default: 0

Minimum: 0

Maximum: 2⁶³-1

DeploymentOrder

A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type. For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

Required: no

Default: 1000

Minimum: 0

Maximum: 2³¹-1

FlowControlEnabled

Return the value of the FlowControlEnabled attribute for the connection factory.

Indicates whether or not a producer created using a connection factory allows flow control. If true, the associated message producers will be slowed down if the JMS server reaches Btyes/Messages ThresholdHigh.

Admin Console field label: Flow Control Enabled

Required: no

Default: true

FlowInterval

Return the value of the FlowInterval attribute for the connection factory.

An adjustment period of time, defined in seconds, when a producer adjusts its flow from the Flow Maximum number of messages to the Flow Minimum amount, or vice versa.

When a producer is flow controlled it is slowed down from its FlowMaximum to its FlowMinimum over FlowInterval seconds.

Admin Console field label: Flow Interval (seconds)

Required: no

Units: seconds

Default: 60

Minimum: 0

Maximum: 2³¹-1

FlowMaximum

Get the value of the FlowMaximum attribute for the connection factory.

The maximum number of messages per second for a producer that is experiencing a threshold condition. When a producer is flow controlled it will never be allowed to go faster than FlowMaximum messages per second.

If a producer is not currently limiting its flow when a threshold condition is reached, the initial flow limit for that producer is set to Flow Maximum. If a producer is already limiting its flow when a threshold condition is reached (the flow limit is less than Flow Maximum), then the producer will continue at its current flow limit until the next time the flow is evaluated.

Note: Once a threshold condition has subsided, the producer is not permitted to ignore its flow limit. If its flow limit is less than the Flow Maximum, then the producer must gradually increase its flow to the Flow Maximum each time the flow is evaluated. When the producer finally reaches the Flow Maximum, it can then ignore its flow limit and send without limiting its flow.

Admin Console field label: Flow Maximum

Required: no

Units: messages/second

Default: 500

Minimum: 1

Maximum: 2³¹-1

FlowMinimum

Get the value of the FlowMinimum attribute for the connection factory.

The minimum number of messages per second for a producer that is experiencing a threshold condition. This is the lower boundary of a producer's flow limit. That is, WebLogic JMS will not further slow down a producer whose message flow limit is at its Flow Minimum.

When a producer is flow controlled it will never be required to go slower than FlowMinimum messages per second.

Admin Console field label: Flow Minimum

Required: no

Units: messages/second

Default: 50

Minimum: 1

Maximum: 2³¹-1

FlowSteps

Get the value of the FlowSteps attribute for the connection factory.

The number of steps used when a producer is adjusting its flow from the Flow Maximum amount of messages to the Flow Minimum amount, or vice versa. Specifically, the Flow Interval adjustment period is divided into the number of Flow Steps (for example, 60 seconds divided by 6 steps is 10 seconds per step).

Also, the movement (i.e., the rate of adjustment) is calculated by dividing the difference between the Flow Maximum and the Flow Minimum into steps. At each Flow Step, the flow is adjusted upward or downward, as necessary, based on the current conditions, as follows:

The downward movement (the decay) is geometric over the specified period of time (Flow Interval) and according to the specified number of Flow Steps. (For example, 100, 50, 25, 12.5)

The movement upward is linear. The difference is simply divided by the number of steps.

Admin Console field label: Flow Steps

Required: no

Default: 10

Minimum: 1

Maximum: 2³¹-1

JNDIName

Return the JNDI name of the JMS connection factory.

This is the name that is assigned to and used to look up the connection factory within the JNDI namespace. The connection factory name is configured separately.

Admin Console field label: JNDIName

Required: no

LoadBalancingEnabled

Return the value of the LoadBalancingEnabled attribute for the connection factory.

For distributed destinations, specifies whether non-anonymous producers created through a connection factory are load balanced within a distributed destination on a per-call basis.

If true, the associated message producers will be load balanced on every send() or publish().

If false, the associated message producers will be load balanced on the first send() or publish().

Admin Console field label: Load Balancing Enabled

Required: no

Default: true

MessagesMaximum

Return the value of the MessagesMaximum attribute for the connection factory.

The maximum number of messages that may exist for an asynchronous session and that have not yet been passed to the message listener. A value of -1 indicates that there is no limit on the number of messages. In this case, however, the limit is set to the amount of remaining virtual memory. A value of 0 is not valid and will cause various exceptions to be thrown.

When the number of messages reaches the MessagesMaximum value:

For multicast sessions, new messages are discarded according the policy specified by the OverrunPolicy attribute and a DataOverrunException is thrown.

For non-multicast sessions, new messages are flow-controlled, or retained on the server until the application can accommodate the messages.

For multicast sessions, when a connection is stopped, messages will continue to be delivered, but only until the MessagesMaximum value is reached. Once this value is reached, messages will be discarded based on the Overrun policy.

Admin Console field label: Messages Maximum

Required: no

Default: 10

Minimum: -1

Maximum: 2³¹-1

Name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Admin Console field label: Name

Required: no

Notes

Optional information that you can include to describe this configuration.

Admin Console field label: Notes

Required: no

OverrunPolicy

Return the value of the OverrunPolicy attribute for the connection factory.

Th Overrun Policy applies to multicast messages. When the number of outstanding messages reaches the MessagesMaximum attribute value, messages are discarded based on the specified policy.

If set to KeepNew, the most recent messages are given priority over the oldest messages, and the oldest messages are discarded, as needed.

If set to KeepOld, the oldest messages are given priority over the most recent messages, and the most recent messages are discarded, as needed.

Message age is defined by the order of receipt, not by the JMSTimestamp value.

Admin Console field label: Overrun Policy

Required: no

Default: KeepOld

ServerAffinityEnabled

Return the value of the ServerAffinityEnabled attribute for the connection factory.

For distributed destinations, specifies whether a WebLogic Server instance that is load balancing consumers or producers across multiple physical destinations (queues or topics) in a distributed destination, will first attempt to load balance across any other physical destinations that are also running in the same instance.

Admin Console field label: Server Affinity Enabled

Required: no

Default: true

Targets

The targets in the current domain on which this item can be deployed.

Required: no

TransactionTimeout

Return the value of the TransactionTimeout attribute for the connection factory.

All transactions on connections created with this connection factory will have this timeout value expressed in seconds.

If a transacted session is still active after the timeout has elapsed, the transaction is rolled back. A value of 0 indicates that the default value will be used. If you have long-running transactions, you might want to adjust the value of this attribute to allow transactions to complete.

Admin Console field label: Transaction Timeout

Required: no

Default: 3600

Minimum: 0

Maximum: 2³¹-1

UserTransactionsEnabled

Return the value of the UserTransactionsEnabled attribute.

Indicates whether or not a connection factory creates sessions that are JTA aware. If true, the associated message producers and message consumers look into the running thread for a transaction context. Otherwise, the current JTA transaction will be ignored.

However, if the XAConnectionFactoryEnabled flag is true, then the UserTransactionsEnabled attribute must also be true to return an XA connection factory.

Note: Transacted sessions ignore the current threads transaction context in favor of their own internal transaction, regardless of the setting. This setting only affects non-transacted sessions.

Admin Console field label: User Transactions Enabled

Required: no

Default: false

XAConnectionFactoryEnabled

Return the value of the XAConnectionFactoryEnabled attribute for the connection factory.

Indicates whether or not a XA queue or XA topic connection factory is returned, instead of a queue or topic connection factory. It can be used to return a XA queue session or XA topic session, which has the getXAResource method.

In order for an XA connection factory to be returned, the UserTransactionsEnabled flag must also be set to true (since it defaults to false).

Admin Console field label: XAConnection Factory Enabled

Required: no

Default: false

XAServerEnabled

Return the value of the XAServerEnabled attribute for the connection factory.

Determines whether XA-enabled JMS connections and sessions are always created when this connection factory is invoked from inside a WebLogic Server instance.

Admin Console field label: Server Side XA Enabled

Required: no

Default: false