TemplateBean

Overview

Template beans contain default values for destination attributes. If a destination defines a template and does not explicitly set the value of an attribute, then that attribute will take its value from the defined template.

Related MBeans

This section describes attributes that provide access to other MBeans.

DeliveryFailureParams

The parameters that control what should happen to messages when failures occur.

These parameters enable the Administrator to control error destinations, logging, and other actions that might be taken when a message cannot be delivered or when other failures are detected.

DeliveryParamsOverrides

Delivery parameter settings that override delivery parameters set by the JMS client.

These overrides, if set, will cause those specific parameters set in the JMS client to be ignored and replaced by the value set here.

GroupParams

The group parameters for this template. When using templates, group parameters enable you to customize parameters based on the group to which the destination belongs.

Templates are a convenient way to associate common parameters amongst a large number of destinations. However, some attributes of particular destinations may need to be configured based on where the destination is targeted. For example, the error destination of a destination and the destination itself must be targeted to the same JMS server.

Group parameters allow the template user to customize parameters based on the group the destination is a member of. The value that will be used for a destination will come from the group parameter if the subdeployment attribute has the same name as the subdeployment the destination is a member of.

For example, imagine two queues Q1 and Q2 in subdeployments G1 and G2 respectively. Both Q1 and Q2 specify template X1 as their template. X1 has group parameters with sub-deployment attributes G1 and G2, where the error destination value for G1 is E1 and the quota value for G2 is E2. Neither Q1 nor Q2 specify their error-destination variable explicitly, so they will get their error destinations from the template. Since Q1 is a member of G1, and the template value of G1 is E1, Q1 will get the error destination E1. Likewise, Q2's error destination will eventually resolve to error destination E2. If a third destination Q3 is added in with sub-deployment G3 and the template does not have a group parameter for G3 then Q3 will get the default value for its error destination.

MessageLoggingParams

Message logging parameters control message logging actions when a message life cycle change is detected.

Multicast

The parameters for receiving messages using multicast rather than a connection-oriented protocol such as TCP.

Topics with certain quality of service tolerance can receive a significant performance boost by using multicast to receive messages rather than using a connection oriented protocol like TCP.

Quota

A Quota controls the allotment of system resources available to destinations. For example the number of bytes a destination is allowed to store can be configured with a QuotaBean.

Thresholds

A threshold is a point that must be exceeded in order to produce a given effect. These action points may cause logging, flow control, or other actions, as defined by the specific points whose values have been exceeded.

Attributes

This section describes the following attributes:

AttachSender

Specifies whether messages landing on destinations that use this template should attach the credential of the sending user.

• 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 ConnectionFactory with AttachJMSXUserID="true".

• Never

  The JMSXUserID property is never be set with the security principal of the sending user.

• Always

  The JMSXUserID property is always set with the security principal of the sending user.

This property is dynamically configurable. A dynamic change will only affect messages received after the update has been made.

ConsumptionPausedAtStartup

Specifies whether message consumption is paused on destinations that use this template at server startup.

• false

  Paused message consumption at server startup is disabled on this template.

• true

  Paused message consumption at server startup is enabled on this template.

DefaultUnitOfOrder

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 adistributed 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.

DestinationKeys

The list of potential destination keys for sorting messages that arrive on destinations that use this JMS template.

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.

Id

Return the unique identifier of this bean instance.

IncompleteWorkExpirationTime

Specifies the maximum amount of time, in milliseconds, before undelivered messages in an incomplete UOW are expired. Such messages will then follow the template's expiration policy defined for undeliverable messages.

Note: A template's error destination for UOW messages cannot be configured to use the Single Message Delivery value.

InsertionPausedAtStartup

Specifies whether new message insertion is paused on destinations that use this template at server startup.

• false

  Paused message insertion at server startup is disabled on this template.

• true

  Paused message insertion at server startup is enabled on this template.

MaximumMessageSize

The maximum size of a message that will be accepted from producers on this destination. The message size includes the message body, any user-defined properties, and the user-defined JMS header fields: JMSCorrelationID and JMSType.

Producers sending messages that exceed the configured maximum message size for the destination receive a ResourceAllocationException .

The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.

Maximum Message Size is dynamically configurable, but only incoming messages are affected; stored messages are not affected.

MessagingPerformancePreference

Controls how long destinations that use this template 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 MessagesMaximum setting.

Name

The name of this entity, represented in XML as an attribute.

Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.

This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.

Notes

Optional information that you can include to describe this named JMS descriptor bean.

JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.

Note:

If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

ProductionPausedAtStartup

Specifies whether new message production on destinations that use this template is paused on at server startup.

• false

  Paused message production at server startup is disabled on this template.

• true

  Paused message production at server startup is enabled on this template.

SafExportPolicy

Specifies whether a user can send messages to destinations that use this template using Store-and-Forward.

• All

  All users can send messages to destinations using Store-and-Forward.

• None

  Remote users cannot send messages to destinations using Store-and-Forward.

This property is dynamically configurable. A dynamic change will only affect messages sent after the update has been made.

UnitOfWorkHandlingPolicy

Specifies whether the Unit-of-Work (UOW) feature is enabled for destinations that use this template. A UOW is a set of messages that are processed as a single unit.

• Pass-Through

  By default, destinations that use this template do not treat messages as part of a UOW.

• Single Message Delivery

  This value should only be selected if UOW consumers are receiving messages on destinations that use this template. When selected, UOW messages are formed into a list and are consumed as an ObjectMessage containing the list.

Operations

This section describes the following operations:

addDestinationKey

Adds a destination key to the end of the list of keys used for sorting destinations.

findErrorDestination

Finds the name of the error destination to use when a destination comes from a specific group

isSet

Return true if the given property has been explicitly set in this bean.

removeDestinationKey

Removes a destination key from the list of keys used for sorting destinations.

unSet

Restore the given property to its default value.