|
BEA Systems, Inc. | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This class represents a JMS connection factory. Connection factories are objects that enable JMS clients to create JMS connections.
Fields inherited from class weblogic.management.configuration.DeploymentMBean |
CACHING_STUB_SVUID,
DEFAULT_ORDER,
MAX_ORDER,
MIN_ORDER |
Fields inherited from class weblogic.management.configuration.ConfigurationMBean |
CACHING_STUB_SVUID,
DEFAULT_EMPTY_BYTE_ARRAY |
Method Summary | |
java.lang.String |
getAcknowledgePolicy()
Note: This attribute only applies to implementations that use the CLIENT_ACKNOWLEDGE acknowledge mode for a non-transacted session. |
boolean |
getAllowCloseInOnMessage()
Specifies whether the connection factory creates message consumers that allow a close() method to be issued within its onMessage() method call. |
java.lang.String |
getClientId()
The client ID for a durable subscriber that uses this connection factory. |
java.lang.String |
getDefaultDeliveryMode()
The default delivery mode used for messages when a delivery mode is not explicitly defined. |
int |
getDefaultPriority()
The default priority used for messages when a priority is not explicitly defined. |
long |
getDefaultRedeliveryDelay()
The delay time, in milliseconds, before rolled back or recovered messages are redelivered. |
long |
getDefaultTimeToDeliver()
The delay time, in milliseconds, between when a message is produced and when it is made visible on its destination. |
long |
getDefaultTimeToLive()
The maximum length of time, in milliseconds, that a message will exist. |
int |
getFlowInterval()
The adjustment period of time, in seconds, when a producer adjusts its flow from the FlowMaximum number of messages to the FlowMinimum amount, or vice versa. |
int |
getFlowMaximum()
The maximum number of messages-per-second allowed for a producer that is experiencing a threshold condition. |
int |
getFlowMinimum()
The minimum number of messages-per-second allowed for a producer that is experiencing a threshold condition. |
int |
getFlowSteps()
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. |
java.lang.String |
getJNDIName()
The JNDI name used to look up the connection factory within the JNDI namespace. |
int |
getMessagesMaximum()
The maximum number of messages that can exist for an asynchronous session and that have not yet been passed to the message listener. |
java.lang.String |
getOverrunPolicy()
The policy to use when the number of outstanding multicast messages reaches the value specified in MessagesMaximum and some messages must be discarded. |
long |
getSendTimeout()
The maximum length of time, in milliseconds, that a sender will wait when there isn't enough available space (no quota) on a destination to accomodate the message being sent. |
long |
getTransactionTimeout()
The timeout value (in milliseconds) for all transactions on connections created with this connection factory. |
boolean |
isFlowControlEnabled()
Specifies whether a producer created using a connection factory allows flow control. |
boolean |
isLoadBalancingEnabled()
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. |
boolean |
isServerAffinityEnabled()
For distributed destinations, specifies whether a WebLogic Server instance 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 in the same instance. |
boolean |
isUserTransactionsEnabled()
Deprecated. |
boolean |
isXAConnectionFactoryEnabled()
Indicates whether a XA queue or XA topic connection factory is returned, instead of a queue or topic connection factory. |
boolean |
isXAServerEnabled()
Deprecated. |
void |
setAcknowledgePolicy(java.lang.String policy)
Note: This attribute only applies to implementations that use the CLIENT_ACKNOWLEDGE acknowledge mode for a non-transacted session. |
void |
setAllowCloseInOnMessage(boolean allowCloseInOnMessage)
Specifies whether the connection factory creates message consumers that allow a close() method to be issued within its onMessage() method call. |
void |
setClientId(java.lang.String id)
The client ID for a durable subscriber that uses this connection factory. |
void |
setDefaultDeliveryMode(java.lang.String defaultDeliveryMode)
The default delivery mode used for messages when a delivery mode is not explicitly defined. |
void |
setDefaultPriority(int defaultPriority)
The default priority used for messages when a priority is not explicitly defined. |
void |
setDefaultRedeliveryDelay(long defaultRedeliveryDelay)
The delay time, in milliseconds, before rolled back or recovered messages are redelivered. |
void |
setDefaultTimeToDeliver(long timeToDeliver)
The delay time, in milliseconds, between when a message is produced and when it is made visible on its destination. |
void |
setDefaultTimeToLive(long defaultTimeToLive)
The maximum length of time, in milliseconds, that a message will exist. |
void |
setFlowControlEnabled(boolean flowControlEnabled)
Specifies whether a producer created using a connection factory allows flow control. |
void |
setFlowInterval(int flowInterval)
The adjustment period of time, in seconds, when a producer adjusts its flow from the Flow Maximum number of messages to the Flow Minimum amount, or vice versa. |
void |
setFlowMaximum(int flowMaximum)
The maximum number of messages-per-second allowed for a producer that is experiencing a threshold condition. |
void |
setFlowMinimum(int flowMinimum)
The minimum number of messages-per-second allowed for a producer that is experiencing a threshold condition. |
void |
setFlowSteps(int flowSteps)
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. |
void |
setJNDIName(java.lang.String name)
The JNDI name used to look up the connection factory within the JNDI namespace. |
void |
setLoadBalancingEnabled(boolean loadBalancingEnabled)
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. |
void |
setMessagesMaximum(int messagesMaximum)
The maximum number of messages that may exist for an asynchronous session and that have not yet been passed to the message listener. |
void |
setOverrunPolicy(java.lang.String policy)
The policy to use when the number of outstanding multicast messages reaches the value specified in MessagesMaximum and some messages must be discarded. |
void |
setSendTimeout(long sendTimeout)
The maximum length of time, in milliseconds, that a sender will wait when there isn't enough available space (no quota) on a destination to accomodate the message being sent. |
void |
setServerAffinityEnabled(boolean serverAffinityEnabled)
For distributed destinations, specifies whether a WebLogic Server instance 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 in the same instance. |
void |
setTransactionTimeout(long transactionTimeout)
The timeout value (in milliseconds) for all transactions on connections created with this connection factory. |
void |
setUserTransactionsEnabled(boolean userTransactionsEnabled)
Deprecated. |
void |
setXAConnectionFactoryEnabled(boolean XAConnectionFactoryEnabled)
Indicates whether or not a XA queue or XA topic connection factory is returned, instead of a queue or topic connection factory. |
void |
setXAServerEnabled(boolean XAServerEnabled)
Deprecated. |
Methods inherited from interface weblogic.management.configuration.DeploymentMBean |
addTarget,
getDeploymentOrder,
getTargets,
removeTarget,
setDeploymentOrder,
setTargets |
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean |
freezeCurrentValue,
getNotes,
restoreDefaultValue,
setComments,
setDefaultedMBean,
setNotes,
setPersistenceEnabled |
Methods inherited from interface weblogic.management.WebLogicMBean |
getMBeanInfo,
getName,
getObjectName,
getParent,
getType,
isCachingDisabled,
isRegistered,
setName,
setParent |
Methods inherited from interface javax.management.DynamicMBean |
getAttribute,
getAttributes,
invoke,
setAttribute,
setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
postDeregister,
postRegister,
preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
addNotificationListener,
getNotificationInfo,
removeNotificationListener |
Method Detail |
public java.lang.String getJNDIName()
public void setJNDIName(java.lang.String name) throws javax.management.InvalidAttributeValueException
name
- The new jNDIName valuepublic java.lang.String getClientId()
public void setClientId(java.lang.String id) throws javax.management.InvalidAttributeValueException
id
- The new clientId valuepublic int getDefaultPriority()
Message producers can get the priority explicitly by calling the javax.jms.MessageProducer.getPriority() method.
public void setDefaultPriority(int defaultPriority) throws javax.management.InvalidAttributeValueException
Message producers can set the priority explicitly by calling the javax.jms.MessageProducer.setPriority() method.
This attribute 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.
defaultPriority
- The new defaultPriority valuepublic long getDefaultTimeToDeliver()
Message producers can get the time-to-deliver explicitly by calling the weblogic.jms.extensions.WLMessageProducer.getTimeToDeliver() method.
public void setDefaultTimeToDeliver(long timeToDeliver) throws javax.management.InvalidAttributeValueException
Message producers can set the time-to-deliver explicitly by calling the weblogic.jms.extensions.WLMessageProducer.setTimeToDeliver() method.
This attribute 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.
timeToDeliver
- The new defaultTimeToDeliver valuepublic long getDefaultTimeToLive()
Message producers can get the time-to-live explicitly by calling the javax.jms.MessageProducer.getTimeToLive() method.
public void setDefaultTimeToLive(long defaultTimeToLive) throws javax.management.InvalidAttributeValueException
Message producers can set the time-to-live explicitly by calling the javax.jms.MessageProducer.setTimeToLive() method.
This attribute 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.
defaultTimeToLive
- The new defaultTimeToLive valuepublic long getSendTimeout()
The default time is 10 milliseconds. A value of 0 indicates that the sender does not want to wait for space.
This attribute 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.
public void setSendTimeout(long sendTimeout) throws javax.management.InvalidAttributeValueException
The default time is 10 milliseconds. A value of 0 indicates that the sender does not want to wait.
This attribute 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.
sendTimeout
- The new sendTimeout valuepublic java.lang.String getDefaultDeliveryMode()
Message producers can get the delivery mode explicitly by calling the javax.jms.MessageProducer.getDeliveryMode() method.
public void setDefaultDeliveryMode(java.lang.String defaultDeliveryMode) throws javax.management.InvalidAttributeValueException
Message producers can set the delivery mode explicitly by calling the javax.jms.MessageProducer.setDeliveryMode() method.
This attribute 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.
defaultDeliveryMode
- The new defaultDeliveryMode valuepublic long getDefaultRedeliveryDelay()
Message consumers can get the redelivery delay explicitly by calling the weblogic.jms.extensions.WLSession.getRedliveryDelay() method.
public void setDefaultRedeliveryDelay(long defaultRedeliveryDelay) throws javax.management.InvalidAttributeValueException
Message consumers can set the redelivery delay explicitly by calling the weblogic.jms.extensions.WLSession.setRedliveryDelay()() method.
This attribute 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.
defaultRedeliveryDelay
- The new defaultRedeliveryDelay valuepublic long getTransactionTimeout()
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.
public void setTransactionTimeout(long transactionTimeout) throws javax.management.InvalidAttributeValueException
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.
This attribute 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.
transactionTimeout
- The new transactionTimeout valuepublic boolean isUserTransactionsEnabled()
This attribute is now deprecated -- if the XAServerEnabled attribute is set, then this attribute 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.
public void setUserTransactionsEnabled(boolean userTransactionsEnabled) throws javax.management.InvalidAttributeValueException
This attribute is now deprecated -- if the XAServerEnabled attribute is set, then this attribute 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.
This attribute 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.
userTransactionsEnabled
- The new userTransactionsEnabled valuepublic boolean getAllowCloseInOnMessage()
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.
public void setAllowCloseInOnMessage(boolean allowCloseInOnMessage) throws javax.management.InvalidAttributeValueException
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.
allowCloseInOnMessage
- The new allowCloseInOnMessage valuepublic int getMessagesMaximum()
When the number of messages reaches the MessagesMaximum value:
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.
public void setMessagesMaximum(int messagesMaximum) throws javax.management.InvalidAttributeValueException
When the number of messages reaches the MessagesMaximum value:
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.
This attribute 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.
messagesMaximum
- The new messagesMaximum valuepublic java.lang.String getOverrunPolicy()
Message age is defined by the order of receipt, not by the JMSTimestamp value.
public void setOverrunPolicy(java.lang.String policy) throws javax.management.InvalidAttributeValueException
This attribute 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.
policy
- The new overrunPolicy valuepublic boolean isXAConnectionFactoryEnabled()
In addition, this 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.
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.
public void setXAConnectionFactoryEnabled(boolean XAConnectionFactoryEnabled) throws javax.management.InvalidAttributeValueException
In addition, this 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.
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.
XAConnectionFactoryEnabled
- The new xAConnectionFactoryEnabled valuepublic java.lang.String getAcknowledgePolicy()
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:
public void setAcknowledgePolicy(java.lang.String policy) throws javax.management.InvalidAttributeValueException
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:
policy
- The new acknowledgePolicy valuepublic int getFlowMinimum()
When a producer is flow controlled it will never be required to go slower than FlowMinimum messages per second.
public void setFlowMinimum(int flowMinimum) throws javax.management.InvalidAttributeValueException
When a producer is flow controlled it will never be required to go slower than FlowMinimum messages per second.
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections.
flowMinimum
- The new flowMinimum valuepublic int getFlowMaximum()
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.
public void setFlowMaximum(int flowMaximum) throws javax.management.InvalidAttributeValueException
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.
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections.
flowMaximum
- The new flowMaximum valuepublic int getFlowInterval()
When a producer is flow controlled, it is slowed down from its FlowMaximum to its FlowMinimum over the FlowInterval seconds.
public void setFlowInterval(int flowInterval) throws javax.management.InvalidAttributeValueException
When a producer is flow controlled, it is slowed down from its FlowMaximum to its FlowMinimum over the FlowInterval seconds.
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections.
flowInterval
- The new flowInterval valuepublic int getFlowSteps()
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:
public void setFlowSteps(int flowSteps) throws javax.management.InvalidAttributeValueException
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:
This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections.
flowSteps
- The new flowSteps valuepublic boolean isFlowControlEnabled()
public void setFlowControlEnabled(boolean flowControlEnabled) throws javax.management.InvalidAttributeValueException
flowControlEnabled
- The new flowControlEnabled valuepublic boolean isLoadBalancingEnabled()
public void setLoadBalancingEnabled(boolean loadBalancingEnabled) throws javax.management.InvalidAttributeValueException
loadBalancingEnabled
- The new loadBalancingEnabled valuepublic boolean isServerAffinityEnabled()
public void setServerAffinityEnabled(boolean serverAffinityEnabled) throws javax.management.InvalidAttributeValueException
serverAffinityEnabled
- The new serverAffinityEnabled valuepublic boolean isXAServerEnabled()
Determines whether XA-enabled JMS connections and sessions are always created when this connection factory is invoked from inside a WebLogic Server instance.
This attribute is deprecated -- it is now possible to use a single XA-enabled connection factory for both XA- and non-XA purposes.
public void setXAServerEnabled(boolean XAServerEnabled) throws javax.management.InvalidAttributeValueException
Determines whether XA-enabled JMS connections and sessions are always created when this connection factory is invoked from inside a WebLogic Server instance.
This attribute is deprecated -- it is now possible to use a single XA-enabled connection factory for both XA- and non-XA purposes.
XAServerEnabled
- The new xAServerEnabled value
|
Documentation is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs81 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |