Skip navigation links

weblogic.management.configuration
Interface JMSConnectionFactoryMBean

All Superinterfaces:

ConfigurationMBean, DeploymentMBean, DescriptorBean, DynamicMBean, JMSConstants, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

Deprecated. 9.0.0.0 Replaced by JMSConnectionFactoryBean

public interface JMSConnectionFactoryMBean

extends DeploymentMBean, JMSConstants

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

getJNDIName

String getJNDIName()

Deprecated. 

The JNDI name used to look up this JMS connection factory within the JNDI namespace.

Returns:

The jNDIName value

setJNDIName

void setJNDIName(String name)
                 throws InvalidAttributeValueException

Deprecated. 

Sets the value of the JNDIName attribute.

Parameters:

name - The new jNDIName value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getJNDIName()

getClientId

String getClientId()

Deprecated. 

An optional client ID for a durable subscriber that uses this JMS connection factory. Configuring this value on the connection factory prevents more than one JMS client from using a connection from the factory. Generally, JMS durable subscriber applications set their client IDs dynamically using the javax.jms.Connection.setClientID() call.

Returns:

The clientId value

setClientId

void setClientId(String id)
                 throws InvalidAttributeValueException

Deprecated. 

Sets the value of the ClientId attribute.

Parameters:

id - The new clientId value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getClientId()

getDefaultPriority

int getDefaultPriority()

Deprecated. 

The default priority used for messages when a priority is not explicitly defined.

Message producers can set the priority explicitly by calling the javax.jms.MessageProducer.setPriority() method.

Range of Values: Between 0 and 9.

Note: This value is dynamic. It 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.

Returns:

The defaultPriority value

setDefaultPriority

void setDefaultPriority(int defaultPriority)
                        throws InvalidAttributeValueException

Deprecated. 

Sets the value of the DefaultPriority attribute.

Message producers can set the priority explicitly by calling the javax.jms.MessageProducer.setPriority() method.

Parameters:

defaultPriority - The new defaultPriority value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getDefaultPriority()

getDefaultTimeToDeliver

long getDefaultTimeToDeliver()

Deprecated. 

The number of milliseconds between when a message is produced and when it is made visible on its target destination.

Message producers can get the time-to-deliver explicitly by calling the weblogic.jms.extensions.WLMessageProducer.getTimeToDeliver() method.

Range of Values: Between 0 and a positive 64-bit integer.

Note: This value is dynamic. It 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.

Returns:

The defaultTimeToDeliver value

setDefaultTimeToDeliver

void setDefaultTimeToDeliver(long timeToDeliver)
                             throws InvalidAttributeValueException

Deprecated. 

Sets the value of the DefaultTimeToDeliver attribute.

Parameters:

timeToDeliver - The new defaultTimeToDeliver value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getDefaultTimeToDeliver()

getDefaultTimeToLive

long getDefaultTimeToLive()

Deprecated. 

The default maximum number of milliseconds that a message will exist. Used for messages for which a Time to Live was not explicitly defined.

The default value of 0 indicates that the message has an infinite amount time to live.

Message producers can get the time-to-live explicitly by calling the javax.jms.MessageProducer.getTimeToLive() method.

Range of Values: Between 0 and a positive 64-bit integer.

Note: This value is dynamic. It 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.

Returns:

The defaultTimeToLive value

setDefaultTimeToLive

void setDefaultTimeToLive(long defaultTimeToLive)
                          throws InvalidAttributeValueException

Deprecated. 

Sets the value of the DefaultTimeToLive attribute.

Parameters:

defaultTimeToLive - The new defaultTimeToLive value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getDefaultTimeToLive()

getSendTimeout

long getSendTimeout()

Deprecated. 

The maximum number of milliseconds that a sender will wait for sufficient space (quota) on a JMS server and destination to accommodate the message being sent. Also see the Blocking Send Policy field on the JMS Server > Configuration > Thresholds & Quotas tab.

Range of Values: Between 0 and a positive 64-bit integer.

The default time is 10 milliseconds. A value of 0 indicates that the sender does not want to wait for space.

Note: This value is dynamic. It can be changed at any time. However, changing the value does not affect existing connections or their producers. It only affects new connections made with this connection factory. Producers inherit the setting from the connection factory used to create their session and connection. The value can then be overridden at run time by setting the value on the producer.

Returns:

The sendTimeout value

setSendTimeout

void setSendTimeout(long sendTimeout)
                    throws InvalidAttributeValueException

Deprecated. 

Sets the value of the SendTimeout value.

Parameters:

sendTimeout - The new sendTimeout value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getSendTimeout()

getDefaultDeliveryMode

String getDefaultDeliveryMode()

Deprecated. 

The delivery mode assigned to all messages sent by a producer using this connection factory.

Message producers can get the delivery mode explicitly by calling the javax.jms.MessageProducer.getDeliveryMode() method.

Note: This value is dynamic. It 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.

Returns:

The defaultDeliveryMode value

setDefaultDeliveryMode

void setDefaultDeliveryMode(String defaultDeliveryMode)
                            throws InvalidAttributeValueException

Deprecated. 

Sets the value of the DefaultDeliveryMode value.

Parameters:

defaultDeliveryMode - The new defaultDeliveryMode value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getDefaultDeliveryMode()

getDefaultRedeliveryDelay

long getDefaultRedeliveryDelay()

Deprecated. 

The number of milliseconds before rolled back or recovered messages are redelivered. This value is dynamic. It 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.

Message consumers can get the redelivery delay explicitly by calling the weblogic.jms.extensions.WLSession.getRedliveryDelay() method.

Range of Values: Between 0 and a positive 64-bit integer.

Returns:

The defaultRedeliveryDelay value

setDefaultRedeliveryDelay

void setDefaultRedeliveryDelay(long defaultRedeliveryDelay)
                               throws InvalidAttributeValueException

Deprecated. 

Sets the value of the DefaultRedeliveryDelay attribute.

Parameters:

defaultRedeliveryDelay - The new defaultRedeliveryDelay value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getDefaultRedeliveryDelay()

getTransactionTimeout

long getTransactionTimeout()

Deprecated. 

The timeout seconds for all transactions on transacted sessions created with this JMS connection factory. This setting has no effect on the transaction-timeout for JTA user transactions.

Range of Values: Between 0 and a positive 32-bit integer.

Note: This value is dynamic. It 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.

Note: 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 value to allow transactions to complete.

Returns:

The transactionTimeout value

setTransactionTimeout

void setTransactionTimeout(long transactionTimeout)
                           throws InvalidAttributeValueException

Deprecated. 

Sets the value of the TransactionTimeout attribute.

Parameters:

transactionTimeout - The new transactionTimeout value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getTransactionTimeout()

isUserTransactionsEnabled

boolean isUserTransactionsEnabled()

Deprecated. 8.1.0.0 Replaced by isXAConnectionFactoryEnabled

Specifies whether 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. This value is dynamic. It 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.

Note: This value is now deprecated. If the XAServerEnabled value is set, then this value is automatically set as well.

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.

Returns:

The userTransactionsEnabled value

setUserTransactionsEnabled

void setUserTransactionsEnabled(boolean userTransactionsEnabled)
                                throws InvalidAttributeValueException

Deprecated. 8.1.0.0 Replaced by setXAConnectionFactoryEnabled

Sets the value of the TransactionsEnabled attribute.

Parameters:

userTransactionsEnabled - The new userTransactionsEnabled value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.isUserTransactionsEnabled()

getAllowCloseInOnMessage

boolean getAllowCloseInOnMessage()

Deprecated. 

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

• If selected (set to true) on a custom connection factory, an onMessage() method callback is allowed to issue a close() method on its own Session, Connection and JMSContext objects, or a stop() call on its own Connection and JMSContext objects. If false, these calls will throw an exception.

• Default JMS Connection Factories (for example, "java:comp/DefaultJMSConnectionFactory", "weblogic.jms.ConnectionFactory", or a "weblogic.jms.XAConnectionFactory") set this option to false.

Note: This value 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.

Returns:

The allowCloseInOnMessage value

setAllowCloseInOnMessage

void setAllowCloseInOnMessage(boolean allowCloseInOnMessage)
                              throws InvalidAttributeValueException

Deprecated. 

Sets the value of the AllowCloseInOnMessage attribute.

Parameters:

allowCloseInOnMessage - The new allowCloseInOnMessage value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getAllowCloseInOnMessage()

getMessagesMaximum

int getMessagesMaximum()

Deprecated. 

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. This value is dynamic. It 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. (For topic subscribers that use the multicast extension, also see the Overrun Policy field.)

When the number of messages reaches the MessagesMaximum value:

• For multicast sessions, new messages are discarded according the policy specified by the OverrunPolicy value 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.

Range of Values: Between -1 and a positive 32-bit integer.

Note: 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.

Returns:

The messagesMaximum value

setMessagesMaximum

void setMessagesMaximum(int messagesMaximum)
                        throws InvalidAttributeValueException

Deprecated. 

Sets the value of the MessagesMaximum attribute.

Parameters:

messagesMaximum - The new messagesMaximum value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getMessagesMaximum()

getOverrunPolicy

String getOverrunPolicy()

Deprecated. 

Overrun policy for topic subscribers that use the multicast extension. The policy to use when the number of outstanding multicast messages reaches the value specified in the Messages Maximum field and some messages must be discarded. Keep New indicates that the most recent messages are given priority over the oldest messages, and the oldest messages are discarded, as needed. Keep Old indicates that 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.

The policy to use when the number of outstanding multicast messages reaches the value specified in MessagesMaximum and some messages must be discarded.

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

• If set to Keep Old, 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.

Note: This value is dynamic. It 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.

Returns:

The overrunPolicy value

setOverrunPolicy

void setOverrunPolicy(String policy)
                      throws InvalidAttributeValueException

Deprecated. 

Sets the value of the OverrunPolicy attribute.

Parameters:

policy - The new overrunPolicy value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getOverrunPolicy()

isXAConnectionFactoryEnabled

boolean isXAConnectionFactoryEnabled()

Deprecated. 

Specifies whether a XA queue or XA topic connection factory is returned, instead of a queue or topic connection factory. An XA factory is required for JMS applications to use JTA user-transactions, but is not required for transacted sessions. All connections created from an XA factory, whether they are XAConnections or plain Connections, become JTA user-transaction-aware.

In addition, this value 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.

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.

Returns:

The xAConnectionFactoryEnabled value

setXAConnectionFactoryEnabled

void setXAConnectionFactoryEnabled(boolean XAConnectionFactoryEnabled)
                                   throws InvalidAttributeValueException

Deprecated. 

Sets the value of the XAConnectionFactoryEnabled attribute.

Parameters:

XAConnectionFactoryEnabled - The new xAConnectionFactoryEnabled value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.isXAConnectionFactoryEnabled()

getAcknowledgePolicy

String getAcknowledgePolicy()

Deprecated. 

Acknowledge policy for non-transacted sessions that use the CLIENT_ACKNOWLEDGE mode. All specifies that calling acknowledge on a message acknowledges all unacknowledged messages received on the session. Previous specifies that calling acknowledge on a message acknowledges only unacknowledged messages up to, and including, the given message.

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

Note: This value works around a change in the JMS specification. Specifically, the specification allowed users to acknowledge all messages before and including the message being 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.

Returns:

The acknowledgePolicy value

setAcknowledgePolicy

void setAcknowledgePolicy(String policy)
                          throws InvalidAttributeValueException

Deprecated. 

Sets the value of the AcknowledgePolicy attribute.

Parameters:

policy - The new acknowledgePolicy value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getAcknowledgePolicy()

getFlowMinimum

int getFlowMinimum()

Deprecated. 

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

Range of Values: Between 0 and a positive 32-bit integer.

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

Note: This value is dynamic. It can be changed at any time. However, changing the value does not affect existing connections.

Returns:

The flowMinimum value

setFlowMinimum

void setFlowMinimum(int flowMinimum)
                    throws InvalidAttributeValueException

Deprecated. 

Sets the value of the FlowMinimum attribute.

Parameters:

flowMinimum - The new flowMinimum value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getFlowMinimum()

getFlowMaximum

int getFlowMaximum()

Deprecated. 

The maximum number of messages-per-second (between 0 and a positive 32-bit integer) allowed for a producer that is experiencing a threshold condition on the JMS server or queue/topic destination. When a producer is flow controlled it will never be allowed to go faster than this number of 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 FlowMaximum. If a producer is already limiting its flow when a threshold condition is reached (the flow limit is less than FlowMaximum), 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 FlowMaximum, then the producer must gradually increase its flow to the FlowMaximum each time the flow is evaluated. When the producer finally reaches the FlowMaximum, it can then ignore its flow limit and send without limiting its flow.

Note: This value is dynamic. It can be changed at any time. However, changing the value does not affect existing connections.

Returns:

The flowMaximum value

setFlowMaximum

void setFlowMaximum(int flowMaximum)
                    throws InvalidAttributeValueException

Deprecated. 

Sets the value of the FlowMaximum attribute.

Parameters:

flowMaximum - The new flowMaximum value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getFlowMaximum()

getFlowInterval

int getFlowInterval()

Deprecated. 

The number of seconds (between 0 and a positive 32-bit integer) when a producer adjusts its flow from the Flow Maximum number of messages to the Flow Minimum amount, or vice versa.

Note: This value is dynamic. It can be changed at any time. However, changing the value does not affect existing connections.

Returns:

The flowInterval value

setFlowInterval

void setFlowInterval(int flowInterval)
                     throws InvalidAttributeValueException

Deprecated. 

Sets the value of the FlowInterval attribute.

Parameters:

flowInterval - The new flowInterval value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getFlowInterval()

getFlowSteps

int getFlowSteps()

Deprecated. 

The number of steps (between 1 and a positive 32-bit integer) used when a producer is adjusting its flow from the Flow Maximum amount of messages to the Flow Minimum amount, or vice versa.

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.

Note: This value is dynamic. It can be changed at any time. However, changing the value does not affect existing connections.

Returns:

The flowSteps value

setFlowSteps

void setFlowSteps(int flowSteps)
                  throws InvalidAttributeValueException

Deprecated. 

Sets the value of the FlowSteps attribute.

Parameters:

flowSteps - The new flowSteps value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.getFlowSteps()

isFlowControlEnabled

boolean isFlowControlEnabled()

Deprecated. 

Indicates whether flow control is enabled for a producer created using this connection factory. If true, the associated message producers will be slowed down if the JMS server reaches Bytes/MessagesThresholdHigh.

Returns:

The flowControlEnabled value

setFlowControlEnabled

void setFlowControlEnabled(boolean flowControlEnabled)
                           throws InvalidAttributeValueException

Deprecated. 

Sets the value of the FlowControlEnabled attribute.

Parameters:

flowControlEnabled - The new flowControlEnabled value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.isFlowControlEnabled()

isLoadBalancingEnabled

boolean isLoadBalancingEnabled()

Deprecated. 

Indicates whether non-anonymous producers sending to a distributed destination are load balanced on a per-send 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().

Returns:

The loadBalancingEnabled value

setLoadBalancingEnabled

void setLoadBalancingEnabled(boolean loadBalancingEnabled)
                             throws InvalidAttributeValueException

Deprecated. 

Sets the value of the LoadBalancingEnabled attribute.

Parameters:

loadBalancingEnabled - The new loadBalancingEnabled value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.isLoadBalancingEnabled()

isServerAffinityEnabled

boolean isServerAffinityEnabled()

Deprecated. 

Indicates whether a server that is load balancing consumers or producers across multiple physical destinations in a distributed destination set will first attempt to load balance across any other physical destinations that are also running on the same WebLogic Server instance.

Returns:

The serverAffinityEnabled value

setServerAffinityEnabled

void setServerAffinityEnabled(boolean serverAffinityEnabled)
                              throws InvalidAttributeValueException

Deprecated. 

Sets the value of the ServerAffinityEnabled attribute.

Parameters:

serverAffinityEnabled - The new serverAffinityEnabled value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.isServerAffinityEnabled()

isXAServerEnabled

boolean isXAServerEnabled()

Deprecated. 8.1.0.0 Replaced by isXAConnectionFactoryEnabled

Indicates whether an XA connection factory will be returned instead of a standard connection factory.

Note: This value is deprecated. It is now possible to use a single XA-enabled connection factory for both XA and non-XA purposes.

Returns:

The xAServerEnabled value

setXAServerEnabled

void setXAServerEnabled(boolean XAServerEnabled)
                        throws InvalidAttributeValueException

Deprecated. 8.1.0.0 Replaced by setXAConnectionFactoryEnabled

Sets the value of the XAServerEnabled attribute.

Parameters:

XAServerEnabled - The new xAServerEnabled value

Throws:

InvalidAttributeValueException

See Also:

JMSConnectionFactoryMBean.isXAServerEnabled()

Skip navigation links