JMS Topic


	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 Topic

Create a JMS Topic

Click to expand the JMS node.
Click to expand the JMS Servers node.
Click to expand a server instance under JMS Servers.
Click the Destinations node. The JMS Destinations table displays in the right pane showing all the JMS topic and queue destinations.
Click the Configure a new JMS Topic text link. A dialog displays in the right pane showing the tabs associated with configuring a new destination topic.
Enter values in the attribute fields.
Click Create to create a destination topic instance with the name you specified in the Name field. The new instance is added under the Destinations node in the left pane.

Clone a JMS Topic

Click to expand the JMS node.
Click to expand the JMS Servers node.
Click to expand a server instance under JMS Servers.
Click the Destinations node. The Destinations table displays in the right pane showing all the destinations.
Click the Clone icon in the row of the destination topic you want to clone. A dialog displays in the right pane showing the tabs associated with cloning a destination topic.
Enter values in the attribute fields.
Click Create to create a destination topic instance with the name you specified in the Name field. The new instance is added under the Destinations node in the left pane.

Delete a JMS Topic

Click to expand the JMS node.
Click to expand the JMS Servers node.
Click to expand a server instance under JMS Servers.
Click the Destination node. The JMS Destinations table displays in the right pane showing all the session pools.
Click the Delete icon in the row of the destination topic you want to delete. A dialog displays in the right pane prompting you to confirm your deletion request.
Click Yes to delete the destination topic. The topic icon under the Destinations node is deleted.

Monitor All Active JMS Destinations

See "Monitor All Active JMS Destinations" in the JMS Server online help for more information.

Configuration

General

Attribute	Description	Range of Values	Default
Name	Name of the topic. The JNDI name is configured separately. This attribute is not dynamically configurable.	Java identifier, unique within the JMS Server	MyJMS Destination[-n]
JNDI Name	Name used to look up the destination within the JNDI namespace. The destination name is configured separately. If not specified, the destination name is not advertised through the JNDI namespace. This attribute is not dynamically configurable.	Java identifier, unique within the JNDI namespace scope	null
Destination Keys	This attribute provides a list of potential destination keys for sorting the messages that arrive on the destination. They are ordered from most significant to least significant. A key that is based on JMSMessageID can only be the last key. 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
Enable Store	Flag specifying whether or not the destination uses the persistent store specified by the JMS server. If this flag is enabled, but no persistent store is defined for the JMS Server, then the configuration fails and WebLogic JMS does not boot. If this flag is disabled, then the destination does not support persistent messages. If this flag is set to Default, then the destination uses the persistent store—if one is defined for the JMS server—and supports persistent messaging. This attribute is not dynamically configurable.	false, true, default	default
Template	The JMS template from which the destination is derived. If this attribute is not defined, then the attributes for the destination must be specified as part of the destination. The Template attribute setting per destination is static. The template attributes, however, can be modified dynamically.	Existing JMS template name or none	none

Thresholds & Quotas

Attribute	Description	Range of Values	Default
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^{63 - 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 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. Note: Bytes paging cannot be dynamically disabled by resetting the Bytes High Threshold to -1. To disable paging, you could set the Bytes High Threshold to a very large number (max is 2⁶³-1), so that paging would not be triggered.	-1, 0 through 2^{63 - 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^{63 - 1,}<Bytes Threshold High	-1
Bytes Paging Enabled	Flag for specifying whether or not bytes paging is enabled on the destination. If this attribute is set to False, then destination-level byte paging is explicitly disabled for this destination. If this attribute is set to True, 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 destination-level bytes paging is enabled for this destination. If this attribute is set to Default, then this value inherits the JMS template's value—if a JMS template is specified. If no template is configured for the destination, then the Default value is equivalent to False. Note: If server-level bytes paging is enabled, and destination-level paging is disabled for a given destination, than messages on the destination can still be paged if server-level paging is started. However, when destination-level paging is disabled for a given destination, then the destination-level high thresholds will not force the destination to page out messages when they are exceeded.	String True False Default	Default
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^{63 - 1,}Greater than or equal to Bytes 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 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 Messages High Threshold to -1. To disable paging, you could set the Messages High Threshold to a very large number (max is 2⁶³-1), so that paging would not be triggered.	-1, 0 through 2^{63 - 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 server, indicating that the threshold condition has cleared. A value of -1 specifies that destination messaes 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^{63 - 1,}<Messages Threshold High	-1
Messages Paging Enabled	Flag for specifying whether or not messages paging is enabled on the destination. If this attribute is set to False, then destination-level message paging is explicitly disabled for this destination. If this attribute is set to True, a paging store has been configured for the JMS Server, and both the Message Threshold Low and Message Threshold High attribute values are greater than -1, then destination-level messages paging is enabled for this destination. If this attribute is set to Default, then this value inherits the JMS template's value—if a JMS template is specified. If no template is configured for the destination, then the Default value is equivalent to False. Note: If server-level messages paging is enabled, and destination-level paging is disabled for a given destination, than messages on the destination can still be paged if server-level paging is started. However, when destination-level paging is disabled for a given destination, then the destination-level high thresholds will not force the destination to page out messages when they are exceeded.	String True False Default	Default

Overrides

Attribute	Description	Range of Values	Default
Priority Override	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	Time-to-live 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^{63 - 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 time-to-deliver 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^{63 - 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. The default 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^{63 - 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^{63 - 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

Multicast

Attribute	Description	Range of Values	Default
Multicast Address	IP address used for multicasting. This address is used to transmit messages to multicast consumers. This attribute is valid for topics only and is not dynamically configurable.	A well-formed IP address (Class D)	N/A
Multicast TTL	Time-to-live value used for multicasting, specifying the number of routers that the message can traverse en route to the consumers. A value of 0 indicates that the message will not traverse any routers, and is limited to one subnet. This value is independent of the JMSExpirationTime value. This attribute is valid for topics only and is not dynamically configurable.	0 to 255	0
Multicast Port	IP port used for multicasting. This port is used to transmit messages to multicast consumers. This attribute is valid for topics only and is not dynamically configurable.	1024 to 65535	6001

Attribute

Description

Range of Values

Default

Multicast Address

IP address used for multicasting. This address is used to transmit messages to multicast consumers.

This attribute is valid for topics only and is not dynamically configurable.

A well-formed IP address (Class D)

N/A

Multicast TTL

Time-to-live value used for multicasting, specifying the number of routers that the message can traverse en route to the consumers. A value of 0 indicates that the message will not traverse any routers, and is limited to one subnet.

This value is independent of the JMSExpirationTime value.

This attribute is valid for topics only and is not dynamically configurable.

0 to 255

Multicast Port

IP port used for multicasting. This port is used to transmit messages to multicast consumers.

This attribute is valid for topics only and is not dynamically configurable.

1024 to 65535

6001

Monitoring

Monitor All Active JMS Destinations

Attribute	Description	Default Value
Destination	Destination name.	N/A
Server	Associated server name.	N/A
Consumers	Current number of registered message consumers.	N/A
Consumers High	Greatest number of registered message consumers at any given time.	N/A
Consumers Total	Total number of registered message consumers.	N/A
Bytes Current	Current number of bytes stored.	N/A
Bytes Pending	Number of unacknowledged and uncommitted transactional bytes stored.	N/A
Bytes Received	Number of bytes received.	N/A
Bytes Threshold Time	Amount of time that the destination has spent in a bytes threshold condition since the last time the server was booted.	N/A
Messages	Current number of messages stored at this destination.	N/A
Messages High	Greatest number of messages stored at any given time.	N/A
Messages Pending	Number of unacknowledged and uncommitted transactional messages stored.	N/A
Messages Received	Number of messages received.	N/A
Messages Threshold Time	Amount of time that the destination spent in a message threshold condition.	N/A

For additional information about monitoring JMS Queues, please see Monitor All Active JMS Destinations.

Notes

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