JMS Templates


	BEA Home \| Events \| Solutions \| Partners \| Products \| Services \| Download \| Developer Center \| WebSUPPORT
	http://www.oracle.com/technology/documentation/index.html \| Site Map \| Search \| Download Documentation \| Contact \| Glossary

\| WebLogic Server Doc Home \| Console Online Help \| Previous Topic \| Next Topic \| Contents \| Index \| View as PDF

JMS Templates

Create a JMS Template

Click the JMS node in the left pane.
Click the JMS Templates node. The JMS Templates table displays in the right pane showing all the templates defined in the domain.
Click the Configure a new JMS Template text link. A dialog displays in the right pane showing the tabs associated with configuring a new template.
Enter a value in the Name attribute field.
Click Create to create a template instance with the name you specified in the Name field. The new instance is added under the JMS Templates node in the left pane.
Click the remaining tabs individually and change the attribute fields or accept the default values as assigned.
Click Apply to save any changes you made.

Clone a JMS Template

Click the JMS node in the left pane.
Click the JMS Templates node. The JMS Templates table displays in the right pane showing all the templates defined in the domain.
Click the Clone icon in the row of the template you want to clone. A dialog displays in the right pane showing the tabs associated with cloning a new template.
Enter a value in the Name attribute field.
Click the Create button in the lower right corner to create a template instance with the name you specified in the Name field. The new instance is added under the JMS Templates node in the left pane.
Click the remaining tabs individually and change the attribute fields or accept the default values as assigned.
Click Apply to save any changes you made.

Delete a JMS Template

Click the JMS node in the left pane.
Click the JMS Templates node. The JMS Templates table displays in the right pane showing all the templates defined in the domain.
Click the Delete icon in the row of the server you want to delete. A dialog displays in the right pane prompting you to confirm your deletion request.
Click Yes to delete the template. The template icon under the JMS Templates node is deleted.

Configuration

General

Attribute	Description	Range of Values	Default Value
Name	Name of the JMS template. This attribute is not dynamically configurable.	Java identifier, unique within specific cluster	MyJMS Template[-n]
Destination Keys	This attribute provides a list of potential destination keys for sorting the messages as they arrive on the destination. They 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 set as "Ascending" (FIFO) for the sort order.	List	Null

Attribute

Description

Range of Values

Default Value

Name

Name of the JMS template.

This attribute is not dynamically configurable.

Java identifier, unique within specific cluster

MyJMS Template[-n]

Destination Keys

This attribute provides a list of potential destination keys for sorting the messages as they arrive on the destination. They 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 set as "Ascending" (FIFO) for the sort order.

List

Null

Thresholds and Quotas

Attribute	Description	Range of Values	Default Value
Bytes Maximum	Maximum number of bytes that may be stored in the destination. A value of -1 specifies that there is no limit on the number of bytes that can be stored in the destination. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.	-1, 0 through 2⁶³-1, Greater than or equal to Bytes Threshold High	-1
Bytes Threshold High	Upper threshold value based on the number of bytes stored in the destination. If the number of bytes exceeds this threshold—and if bytes paging is enabled and a paging store has been configured for the JMS Server—then destination-level bytes paging is started, and a message is logged on the server indicating a high threshold condition. A value of -1 specifies that bytes paging and threshold log messages are disabled for the destination. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted. Note: Bytes paging cannot be dynamically disabled by resetting the high threshold to -1. To disable paging, you could set the high threshold to very large number (max is 2⁶³ -1), so that paging would not be triggered.	-1, 0 through 2⁶³-1, Less than or equal to Bytes Maximum, >Bytes Threshold Low	-1
Bytes Threshold Low	Lower threshold value based on the number of bytes stored in the destination. If the number of bytes falls below this threshold, then destination-level bytes paging is stopped (if paging is occurring), and a message is logged on the server indicating that the threshold condition has cleared. A value of -1 specifies that destination bytes paging and threshold log messages are disabled for the destination. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.	-1, 0 through 2⁶³-1, <Bytes Threshold High	-1
Bytes Paging Enabled	Flag for specifying whether or not bytes paging is enabled on the destination. If this flag is not selected, then bytes paging is disabled for the template's destinations—unless the destination setting overrides the template. If this flag is selected, a paging store has been configured for the JMS Server, and both the Bytes Threshold Low and Bytes Threshold High attribute values are greater than -1, then bytes paging is enabled for the template's destinations—unless the destination setting overrides the template. Note: If no value is defined in the JMS Template MBean, then it defaults to False and bytes paging is disabled for the template's destinations—unless the destination setting overrides the template.	Boolean Enabled = selected Disabled = not selected	Not selected
Messages Maximum	Maximum number of messages that may be stored in the destination. A value of -1 specifies that there is no limit on the number of messages that can be stored in the destination. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.	-1, 0 through 2⁶³-1, Greater than or equal to Messages Threshold High	-1
Messages Threshold High	Upper threshold value based on the number of messages stored in the destination. If the number of messages exceeds this threshold—and if messages paging is enabled and a paging store has been configured for the JMS Server—then destination-level messages paging is started, and a message is logged on the server indicating a high threshold condition. A value of -1 specifies that destination messages paging and threshold log messages are disabled for the destination. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted. Note: Messages paging cannot be dynamically disabled by resetting the High Threshold to -1. To disable paging, you could set the High Threshold to a very large number (max is 2⁶³ -1), so that paging would not be triggered.	-1, 0 through 2⁶³-1, Less than or equal to Messages Maximum, >Messages Threshold Low	-1
Messages Threshold Low	Lower threshold value based on the number of messages stored in the destination. If the number of messages falls below this threshold, then destination-level messages paging is stopped (if paging is occurring), and a message is logged on the server indicating that the threshold condition has cleared. A value of -1 specifies that destination mesages paging and threshold log messages are disabled for the destination. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.	-1, 0 through 2⁶³-1, <Bytes Threshold High	-1
Messages Paging Enabled	Flag for specifying whether or not messages paging is enabled on the destination. If this flag is not selected, then messages paging is disabled for the template's destinations-unless the destination setting overrides the template. If this flag is selected, a paging store has been configured for the JMS Server, and both the Messages Threshold Low and Messages Threshold High attribute values are greater than -1, then messages paging is enabled for the template's destinations—unless the destination setting overrides the template. Note: If no value is defined in the JMS Template MBean, then it defaults to False and messages paging is disabled for the template's destinations—unless the destination setting overrides the template.	Boolean Enabled = selected Disabled = not selected	Not selected

Override

Attribute	Description	Range of Values	Default Value
Priority Override	The priority assigned to all messages that arrive at the destination regardless of the priority specified by the message producer. The default value (-1) specifies that the destination will not override the Priority setting. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.	-1, 0 through 9	-1
Time to Live Override	The time-to-live value assigned to all messages that arrive at the destination, regardless of the time-to-live specified by the message producer. The default value (-1) specifies that the destination will not override the Time To Live setting. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.	-1, 0 through 2⁶³-1	-1
Time To Deliver Override	Defines the default delay, in milliseconds, between when a message is produced and when it is made visible on its destination, regardless of the delivery time specified by the producer and/or connection factory. The default value (-1) specifies that the destination will not override the Time To Deliver setting. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.	-1, 0 through 2⁶³-1^,or string syntax for a delivery schedule	-1
Delivery Mode Override	Delivery mode assigned to all messages that arrive at the destination regardless of the delivery mode specified by the message producer. A value of No-Delivery specifies that the delivery mode will not be overridden. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.	Persistent, Non-Persistent, or No-Delivery	No-Delivery

Redelivery

Attribute	Description	Range of Values	Default
Redelivery Delay Override	Defines the delay, in milliseconds, before rolled back or recovered messages are redelivered, regardless of the redelivery delay specified by the consumer and/or connection factory. The default value (-1) specifies that the destination will not override the Redelivery Delay setting. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.	-1, 0 through 2⁶³-1	-1
Redelivery Limit	The number of redelivery tries a message can have before it is placed in the error destination. Depending on whether an error destination is configured, the following occurs when the redelivery limit is reached: If no error destination is configured, or the quota for the error destination would be exceeded, then persistent and non-persistent messages are simply dropped. If an error destination is configured and the error destination is at quota, then an error message is logged and the message is dropped. However, if the message is persistent, it remains in the persistent store. This ensures that a persistent message will be redelivered when WebLogic Server is rebooted. The default value (-1) specifies that the destination will not override the redelivery limit setting. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.	-1, 0 through 2⁶³-1	-1
Error Destination	A destination for messages that have reached their redelivery limit. If the error destination is null, then such messages are simply dropped. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.	Existing destination or none	none

Attribute

Description

Range of Values

Default

Redelivery Delay Override

Defines the delay, in milliseconds, before rolled back or recovered messages are redelivered, regardless of the redelivery delay specified by the consumer and/or connection factory.

The default value (-1) specifies that the destination will not override the Redelivery Delay setting.

This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.

-1, 0 through 2⁶³-1

-1

Redelivery Limit

The number of redelivery tries a message can have before it is placed in the error destination. Depending on whether an error destination is configured, the following occurs when the redelivery limit is reached:

If no error destination is configured, or the quota for the error destination would be exceeded, then persistent and non-persistent messages are simply dropped.
If an error destination is configured and the error destination is at quota, then an error message is logged and the message is dropped. However, if the message is persistent, it remains in the persistent store. This ensures that a persistent message will be redelivered when WebLogic Server is rebooted.

The default value (-1) specifies that the destination will not override the redelivery limit setting.

This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.

-1, 0 through 2⁶³-1

-1

Error Destination

A destination for messages that have reached their redelivery limit. If the error destination is null, then such messages are simply dropped.

This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.

Existing destination or none

none

Notes

Attribute	Description	Range of Values	Default Value
Notes	This attribute provides a space for optional user-supplied information.	The value must be an alphanumeric string.	Null