Administration Console Online Help

Previous Next Open TOC in new window
Content starts here

JMS Topic: Configuration: General

Configuration Options     Advanced Configuration Options     Related Tasks     Related Topics

Use this page to define the general configuration parameters for this topic, such as selecting a destination key for sorting messages as they arrive on the topic.

You can configure topics explicitly or you can configure a JMS template to define and manage multiple topics with similar attribute settings.

Configuration Options

Name Description
Name

The name of this JMS topic.

JNDI Name

The global JNDI name used to look up the destination within the JNDI namespace.

In a clustered environment, this name is propagated to the entire cluster. If you want the JNDI name to be bound only on the local server, and not propagated to the rest of the cluster, then use the Local JNDI Name parameter.

If not specified, the destination name will not be advertised through the global JNDI namespace.

MBean Attribute (Does not apply to application modules) :
DestinationBean.JNDIName

Template

The JMS template from which the destination is derived. A template provides an efficient means of defining multiple destinations with similar configuration values.

If a JMS template is specified, destination parameters that are set to their default values will instead inherit their values from the JMS template at run-time. However, if a JMS template is not defined, then the configuration values for the destination must be specified as part of the destination.

Although you can dynamically modify a the configuration of a JMS template, the configuration values on a destination are static.

MBean Attribute (Does not apply to application modules) :
DestinationBean.Template

Changes take effect after you redeploy the module or restart the server.

Destination Keys

The list of potential destination keys for 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 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) :
TopicBean.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) :
TopicBean.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) :
TopicBean.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 that is statistically unique for a destination. Any message arriving at this destination that does not already belong to a unit-of-order is assigned this default name.

MBean Attribute (Does not apply to application modules) :
DestinationBean.DefaultUnitOfOrder

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

Local JNDI Name

The local JNDI name used to look up the destination within the JNDI namespace of the server where the destination resource is targeted. In a clustered environment, this name is bound only on the local server instance and is not propagated to the rest of the cluster.

A destination can have both a local JNDI name and a (global) JNDI name.

MBean Attribute (Does not apply to application modules) :
DestinationBean.LocalJNDIName

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.jsm.Session createQueue or createTopic.

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) :
DestinationBean.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) :
DestinationBean.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

Related Tasks

Related Topics


Back to Top