Uniform Distributed Queue: Configuration: General
Configuration Options Advanced Configuration Options Related Tasks Related Topics
Use this page to define the general configuration parameters for a distributed queue, such as selecting a destination key for sorting messages as they arrive on the distributed queue members.
Configuration Options
Name Description Name The name of this distributed queue.
MBean Attribute:
JMSDestinationMBean.Name
Changes take effect after you redeploy the module or restart the server.
JNDI Name The name used to bind a virtual destination to the JNDI tree. Applications can use the JNDI name to look up the virtual destination.
If not specified, then the destination is not bound into the JNDI namespace.
MBean Attribute (Does not apply to application modules) :
DistributedDestinationBean.JNDIName
Load Balancing Policy Determines how messages are distributed to the members of this destination.
Choose from the following distribution techniques:
- Round-Robin
The system maintains an ordering of physical topic members within the set by distributing the messaging load across the topic members one at a time in the order that they are defined in the configuration file. Each WebLogic Server instance maintains an identical ordering, but may be at a different point within the ordering. If weights are assigned to any of the topic members in the set, then those members appear multiple times in the ordering.
- Random
The weight assigned to the topic members is used to compute a weighted distribution for the members of the set. The messaging load is distributed across the topic members by pseudo-randomly accessing the distribution. In the short run, the load will not be directly proportional to the weight. In the long run, the distribution will approach the limit of the distribution. A pure random distribution can be achieved by setting all the weights to the same value, which is typically set to 1.
MBean Attribute (Does not apply to application modules) :
UniformDistributedDestinationBean.LoadBalancingPolicy
Forward Delay The number of seconds after which a uniform distributed queue member with no consumers will wait before forwarding its messages to other uniform distributed queue members that do have consumers.
The default value of -1 disables this feature so that no messages are forwarded to other uniform distributed queue members.
MBean Attribute (Does not apply to application modules) :
UniformDistributedQueueBean.ForwardDelay
Secure value:
-1
Reset Delivery Count On Forward Determines whether or not the delivery count is reset during message forwarding between distributed queue members.
The default value of true resets the delivery counts on messages when they are forwarded to another distributed queue member.
MBean Attribute (Does not apply to application modules) :
UniformDistributedQueueBean.ResetDeliveryCountOnForward
Destination Keys The list of potential destination keys for sorting the messages that arrive on a JMS destination.
The keys are ordered from most significant to least significant. If more than one key is specified, a key based on the JMSMessageID can only be the last key in the list.
Note: If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and is set as "Ascending" (FIFO) for the sort order.
MBean Attribute (Does not apply to application modules) :
DestinationBean.DestinationKeys
Changes take effect after you redeploy the module or restart the server.
Default Targeting Enabled Specifies whether this JMS resource defaults to the parent module's targeting or uses the subdeployment targeting mechanism.
When set to true, this resource implicitly inherits the targeting of its parent module. When set to false, this resource gets targeted based its subdeployment's targets, if one is specified.
MBean Attribute (Does not apply to application modules) :
DestinationBean.DefaultTargetingEnabled
Changes take effect after you redeploy the module or restart the server.
Advanced Configuration Options
Name Description Pause Message Production At Startup Specifies whether new message production is paused on a destination at startup.
- default
If a JMS template is specified, then this value inherits the template's Production Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false.
- false
Production Paused is explicitly disabled for this destination.
- true
Production Paused is explicitly turned on for this destination.
MBean Attribute (Does not apply to application modules) :
DestinationBean.ProductionPausedAtStartup
Changes take effect after you redeploy the module or restart the server.
Pause Message Consumption At Startup Specifies whether consumption is paused on a destination at startup.
- default
If a JMS template is specified, then this value inherits the template's Consumption Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false.
- false
Consumption Paused is explicitly disabled for this destination.
- true
Consumption Paused is explicitly turned on for this destination.
MBean Attribute (Does not apply to application modules) :
DestinationBean.ConsumptionPausedAtStartup
Changes take effect after you redeploy the module or restart the server.
Pause Message Insertion At Startup Specifies whether new message insertion is paused on a destination at startup.
- default
If a JMS template is specified, then this value inherits the template's Insertion Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false.
- false
Insertion Paused is explicitly disabled for this destination.
- true
Insertion Paused is explicitly turned on for this destination.
MBean Attribute (Does not apply to application modules) :
DestinationBean.InsertionPausedAtStartup
Changes take effect after you redeploy the module or restart the server.
Auto-generate Unit-of-Order Name Specifies whether WebLogic Server creates a system-generated unit-of-order name based on the domain, JMS server, and destination name. Any message arriving at this destination that does not already belong to a unit-of-order is assigned this default name.
This field is recommended for advanced use. Generally, it is recommended to set a message unit-of-order using application calls or connection factory configuration. When relying on a destination default unit order to enforce ordering with a distributed destination, the application must be aware that unit-of-order routing doesn't apply. Instead the application must specifically ensure that any particular set of messages that must be processed in order are all sent to the same specific member destination even in the event of process failures or service migration.
MBean Attribute (Does not apply to application modules) :
DestinationBean.DefaultUnitOfOrder
Changes take effect after you redeploy the module or restart the server.
Unit-of-Order Message Routing Determines how a distributed destination member is selected as the destination for a message that is part of a unit-of-order. Hash, indicates that a message producer computes the member destination from the
hashCode
of the unit-of-order. PathService indicates that the configured Path Service determines the member destination.Unit-of-Order Routing can be set programmatically with WLProducer, or administratively on the connection factory or destination.
Unit of Order Routing is not dynamically configurable.
MBean Attribute (Does not apply to application modules) :
UniformDistributedDestinationBean.UnitOfOrderRouting
Changes take effect after you redeploy the module or restart the server.
Attach Sender Credential Specifies whether messages landing on this destination should attach the credential of the sending user. You should consult the JMSXUserID documentation in Programming WebLogic JMS before using this feature.
- Supports
The JMSXUserID property is set with the security principal of the sending user if requested. The sender can request its identity to be attached to its messages by using a connection factory with the AttachJMSXUserID security property enabled.
- Never
The JMSXUserID property is never set with the security principal of the sending user no matter how the AttachJMSXUserID property is configured on connection factories.
- Always
The JMSXUserID property is always set with the security principal of the sending user no matter how the AttachJMSXUserID property is configured on connection factories.
This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages received after the update has been made.
MBean Attribute (Does not apply to application modules) :
DestinationBean.AttachSender
Create Destination Identifier A reference name for a destination or a member of a distributed destination that provides a way to lookup that destination without JNDI using
javax.jms.Session createQueue
orcreateTopic
. See "How to Lookup a Destination" in Programming JMS for more information on how to use this attribute.This name must be unique within the scope of the JMS server to which this destination is targeted. However, it does not need to be unique within the scope of an entire JMS module or WebLogic Cluster. For example, two queues can have the same destination name as long as those queues are targeted to different JMS servers.
Note: Since this name must be unique within the scope of a JMS server, verify whether other JMS modules may contain destination names that conflict with this name. It is the responsibility of the deployer to resolve the destination names targeted to JMS servers.
MBean Attribute (Does not apply to application modules) :
DestinationBean.JMSCreateDestinationIdentifier
Changes take effect after you redeploy the module or restart the server.
SAF Export Policy Specifies whether a user can send messages to a destination using Store-and-Forward.
- All
All users can send messages to this destination using Store-and-Forward.
- None
Remote users can not send messages to a destination using Store-and-Forward.
This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages sent after the update has been made.
MBean Attribute (Does not apply to application modules) :
UniformDistributedDestinationBean.SAFExportPolicy
Changes take effect after you redeploy the module or restart the server.
Messaging Performance Preference Controls how long destinations are willing to wait to create full batches of available messages (if at all) for delivery to consumers. At the minimum value, batching is disabled; at the default value, less-than-full batches will not wait and are delivered immediately with currently available messages; tuning higher than the default value controls the maximum wait time for additional messages before less-than-full batches are delivered to consumers.
The maximum message count of a full batch is controlled by the JMS connection factory's Messages Maximum setting.
MBean Attribute (Does not apply to application modules) :
UniformDistributedDestinationBean.MessagingPerformancePreference
Minimum value:
0
Maximum value:
100
Unit-of-Work (UOW) Message Handling Policy Specifies whether the Unit-of-Work (UOW) feature is enabled for this destination. A UOW is a set of messages that are processed as a single unit.
- Pass-Through
By default, this destination does not treat messages as part of a UOW.
- Single Message Delivery
This value should only be selected if UOW consumers are receiving messages on this destination. When selected, UOW messages are formed into a list and are consumed as an
ObjectMessage
containing the list.MBean Attribute (Does not apply to application modules) :
DestinationBean.UnitOfWorkHandlingPolicy
Expiration Time for Incomplete UOW Messages Specifies the maximum length of time, in milliseconds, before undelivered messages in an incomplete UOW are expired. Such messages will then follow the expiration policy defined for undeliverable messages.
Note: An error destination for UOW messages cannot be configured with a Unit-of-Work Handling Policy of Single Message Delivery value.
This attribute is effective only if the Unit-of-Work Handling Policy is set to Single Message Delivery value. A value of -1 means that UOW messages will never expire.
MBean Attribute (Does not apply to application modules) :
DestinationBean.IncompleteWorkExpirationTime