Skip navigation.
Downloads | Product Documentation | Support

WebLogic Server Configuration Reference

# JMSTopic

# Description

This class represents a JMS topic (Pub/Sub) destination for a JMS server.

# Syntax

>     <JMSTopic
>       BytesMaximum="number"
>       BytesPagingEnabled=( "default" | "false" | "true" )
>       BytesThresholdHigh="number"
>       BytesThresholdLow="number"
>       DeliveryModeOverride=( "Persistent" | "Non-Persistent" | "No-Delivery" )
>       DestinationKeys="list of JMSDestinationKey names"
>       ErrorDestination="JMSDestination name"
>       ExpirationLoggingPolicy="String"
>       ExpirationPolicy=( "Discard" | "Log" | "Redirect" )
>       JNDIName="String"
>       JNDINameReplicated=( "true" | "false" )
>       MaximumMessageSize="number"
>       MessagesMaximum="number"
>       MessagesPagingEnabled=( "default" | "false" | "true" )
>       MessagesThresholdHigh="number"
>       MessagesThresholdLow="number"
>       MulticastAddress="String"
>       MulticastPort="number"
>       MulticastTTL="number"
>       Name="String"
>       Notes="String"
>       PriorityOverride="number"
>       RedeliveryDelayOverride="number"
>       RedeliveryLimit="number"
>       StoreEnabled=( "default" | "false" | "true" )
>       Template="JMSTemplate name"
>       TimeToDeliverOverride="String"
>       TimeToLiveOverride="number"
>     />

# Parent Elements

- JMSServer

# Attributes

Table 40-1 JMSTopic attributes

Attribute | Description | Range of Values and Default
--- | --- | ---
BytesMaximum | The maximum bytes quota (total amount of bytes) that can be stored in this destination. The default value of -1 specifies that there is no WebLogic-imposed limit on the number of bytes that can be stored in the destination. However, excessive bytes volume can cause memory saturation, so this value should correspond to the total amount of available system memory relative to the rest of your application load. Range of Values: >= BytesThresholdHigh This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted. Note: If a JMS template is used for distributed destination members, then this setting applies only to those specific members and not the distributed destination set as a whole. | Admin Console field label: Bytes Maximum Default: -1 Minimum: -1 Maximum: 263-1
BytesPagingEnabled | Specifies whether bytes paging is enabled on the destination for temporarily swapping message bodies out from memory to a persistent paging store when the destination's message load reaches a specified bytes/messages threshold. default - If a JMS template is specified, then this value inherits the template's Bytes Paging value. If no JMS template is configured for the destination, then the Default value is equivalent to false. false - Bytes paging is explicitly disabled for this destination. true - If a paging store has been configured for the JMS server, and both the BytesThresholdLow and BytesThresholdHigh attribute values are greater than -1, then bytes paging is enabled for this destination. | Admin Console field label: Bytes Paging Enabled Required: no Default: default
BytesThresholdHigh | The upper threshold value that triggers events based on the number of bytes stored in the destination. If the number of bytes exceeds this threshold, the triggered events are: Log Messages - A message is logged on the server indicating a high threshold condition. Bytes Paging - If bytes paging is enabled (and a paging store has been configured), then destination-level bytes paging is started. Flow Control - If flow control is enabled, the destination becomes armed and instructs producers to begin decreasing their message flow. A value of -1 specifies that the value is not set and that bytes paging, flow control, and threshold log messages are disabled for the destination. Range of Values: <= BytesMaximum; >BytesThresholdLow 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 value to -1. To dynamically disable paging, you could set the value to a very large number, so that paging would not be triggered. | Admin Console field label: Bytes Threshold High Default: -1 Minimum: -1 Maximum: 263-1
BytesThresholdLow | The lower threshold value that triggers events based on the number of bytes stored in the destination. If the number of bytes falls below this threshold, the triggered events are: Log Messages - A message is logged on the server indicating that the threshold condition has cleared. Bytes Paging - If bytes paging is enabled, paging is stopped (if paging is occurring). Flow Control - If flow control is enabled, the destination becomes disarmed and instructs producers to begin increasing their message flow. A value of -1 specifies that the value is not set and that bytes paging, flow control, and threshold log messages are disabled for the destination. Range of Values: < BytesThresholdHigh This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted. | Admin Console field label: Bytes Threshold Low Default: -1 Minimum: -1 Maximum: 263-1
DeliveryModeOverride | The delivery mode assigned to all messages that arrive at the destination regardless of the DeliveryMode specified by the message producer. A value of `No-Delivery` specifies that the DeliveryMode will not be overridden. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted. | Admin Console field label: Delivery Mode Override Required: no Default: No-Delivery
DestinationKeys | Return a read-only array of the destination keys of the JMS template or destination. | Admin Console field label: Destination Keys Required: no
ErrorDestination | The name of the target error destination for messages that have reached their redelivery limit. If no error destination is configured, then such messages are simply dropped. If a message has expired and the Expiration Policy is set to Redirect, then the message is moved to the specified Error Destination. Note: The error destination must be a destination that is configured on the local JMS server. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted. | Admin Console field label: Error Destination Required: no Secure value: null
ExpirationLoggingPolicy | The policy that defines what information about the message is logged when the Expiration Policy is set to Log. The valid logging policy values are: %header% - All JMS header fields are logged. %properties% - All user-defined properties are logged. JMSDeliveryTime - This WebLogic JMS-specific extended header field is logged. JMSRedeliveryLimit - This WebLogic JMS-specific extended header field is logged. foo - Any valid JMS header field or user-defined property is logged. When specifying multiple values, enter them as a comma-separated list. The `%header%` and `%properies%` values are not case sensitive. For example, you could use `"%header%,%properties%"` for all the JMS header fields and user properties. However, the enumeration of individual JMS header fields and user-defined properties are case sensitive. To enumerate only individual JMS header fields you could use `"%header, name, address, city, state, zip"`. Note: The `JMSMessageID` field is always logged and cannot be turned off. Therefore, if the Expiration Logging Policy is not defined (i.e., null) or is defined as an empty string, then the output to the log file contains only the `JMSMessageID` of the message. | Admin Console field label: Expiration Logging Policy Required: no
ExpirationPolicy | The message Expiration Policy to use when an expired message is encountered on a destination. The valid expiration policies are: None - Same as the Discard policy; expired messages are simply removed from the destination. Discard - Removes expired messages from the messaging system. The removal is not logged and the message is not redirected to another location. If no value is defined for a given destination (i.e., None), then expired messages are discarded. Log - Removes expired messages from the system and writes an entry to the server log file indicating that the messages have been removed from the system. The actual information that is logged is defined by the Expiration Logging Policy. Redirect - Moves expired messages from their current location to the Error Destination defined for the destination. The message retains its body, and all of its properties. The message also retains all of its header fields, but with the following exceptions: The destination for the message becomes the error destination. All property overrides associated with the error destination are applied to the redirected message. If there is no Time-To-Live Override value set for the error destination, then the message receives a new Expiration Time of zero (indicating that it will not expire again). It is illegal to use the Redirect policy when there is no valid error destination defined for the destination. Similarly, it is illegal to remove the error destination for a destination that is using the Redirect policy. Note: The Maximum Message quota is only enforced for sending new messages. It is ignored when moving messages because of the Redirect policy. | Admin Console field label: Expiration Policy Required: no
JNDIName | The JNDI name used to look up the destination within the JNDI namespace. If not specified, the destination name is not advertised through the JNDI namespace and cannot be looked up and used. This attribute is not dynamically configurable. | Admin Console field label: JNDI Name Required: no
JNDINameReplicated | If JNDINameReplicated is set to true, then the JNDI name for the destination (if present) is replicated across the cluster. If JNDINameReplicated is set to false, then the JNDI name for the destination (if present) is only visible from the server of which this destination is a part. | Admin Console field label: Replicate JNDI Name In Cluster Default: true
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. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted. | Admin Console field label: Maximum Message Size Default: 231-1 Minimum: 0 Maximum: 231-1
MessagesMaximum | The maximum message quota (total amount of messages) that can be stored in this destination. The default value of -1 specifies that there is no WebLogic-imposed limit on the number of messages that can be stored in the destination. However, excessive message volume can cause memory saturation, so this value should correspond to the total amount of available system memory relative to the rest of your application load. Range of Values: >= MessagesThresholdHigh This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted. Note: If a JMS template is used for distributed destination members, then this setting applies only to those specific members and not the distributed destination set as a whole. | Admin Console field label: Messages Maximum Default: -1 Minimum: -1 Maximum: 263-1
MessagesPagingEnabled | Specifies whether messages paging is enabled on the destination for temporarily swapping message bodies out from memory to a persistent paging store when the destination's message load reaches a specified bytes/messages threshold. default - If a JMS template is specified, then this value inherits the template's Messages Paging value. If no JMS template is configured for the destination, then the Default value is equivalent to false. false - Messages paging is explicitly disabled for this destination. true - If a paging store has been configured for the JMS server, and both the MessagesThresholdLow and MessagesThresholdHigh attribute values are greater than -1, then messages paging is enabled for this destination. | Admin Console field label: Messages Paging Enabled Required: no Default: default
MessagesThresholdHigh | The upper threshold value that triggers events based on the number of messages stored in the destination. If the number of messages exceeds this threshold, the triggered events are: Log Messages - A message is logged on the server indicating a high threshold condition. Messages Paging - If messages paging is enabled (and a paging store has been configured), then destination-level messages paging is started. Flow Control - If flow control is enabled, the destination becomes armed and instructs producers to begin decreasing their message flow. A value of -1 specifies that the value is not set and that messages paging, flow control, and threshold log messages are disabled for the destination. Range of Values: <= MessagesMaximum; >MessagesThresholdLow 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 the value to -1. To dynamically disable paging, you could set the value to a very large number, so that paging would not be triggered. | Admin Console field label: Messages Threshold High Default: -1 Minimum: -1 Maximum: 263-1
MessagesThresholdLow | The lower threshold value that triggers events based on the number of messages stored in the destination. If the number of messages falls below this threshold, the triggered events are: Log Messages - A message is logged on the server indicating that the threshold condition has cleared. Messages Paging - If messages paging is enabled, paging is stopped (if paging is occurring). Flow Control - If flow control is enabled, the destination becomes disarmed and instructs producers to begin increasing their message flow. A value of -1 specifies that the value is not set and that messages paging, flow control, and threshold log messages are disabled for the destination. Range of Values: < MessagesThresholdHigh This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted. | Admin Console field label: Messages Threshold Low Default: -1 Minimum: -1 Maximum: 263-1
MulticastAddress | The IP address used for multicasting by the topic. This address is used to transmit messages to multicast consumers. | Admin Console field label: Multicast Address Required: no
MulticastPort | The IP port used for multicasting for the topic. This port is used to transmit messages to multicast consumers. | Admin Console field label: Multicast Port Default: 6001 Minimum: 1 Maximum: 65535
MulticastTTL | The number of network hops that a multicast message is allowed to travel. This is the Time-To-Live value used for multicasting, which specifyies the number of routers that the message can traverse enroute to the consumers. A value of 1 indicates that the message will not traverse any routers and is limited to one subnet. This value is independent of the JMSExpirationTime value. | Admin Console field label: Multicast TTL Default: 1 Minimum: 0 Maximum: 255
Name | The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration. | Admin Console field label: Name Required: no
Notes | Optional information that you can include to describe this configuration. | Admin Console field label: Notes Required: no
PriorityOverride | 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. | Admin Console field label: Priority Override Default: -1 Minimum: -1 Maximum: 9
RedeliveryDelayOverride | Defines the delay, in milliseconds, before rolled back or recovered messages are redelivered, regardless of the RedeliveryDelay specified by the consumer and/or connection factory. Redelivered queue messages are put back into their originating destination; redelivered topic messages are put back into their originating subscription. The default value (-1) specifies that the destination will not override the RedeliveryDelay setting. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted. Note: Changing the RedeliveryDelayOverride only affects future rollbacks and recovers, it does not affect rollbacks and recovers that have already occurred. | Admin Console field label: Redelivery Delay Override Default: -1 Minimum: -1 Maximum: 263-1
RedeliveryLimit | The number of redelivery tries a message can have before it is moved to the error destination. This setting overrides any redelivery limit set by the message sender. If the redelivery limit is configured, but no error destination is configured, then persistent and non-persistent messages are simply dropped (deleted) when they reach their redelivery limit. Note: The redelivery limit with no error destination behavior also applies to transactional messages, which are not rolled back for future redelivery and no exception is thrown. The default value (-1) specifies that the destination will not override the message sender's redelivery limit setting. When the value is set to zero, messages are received at-most once. No redelivery attempts are made in the event of a rollback or receive. Instead, messages are either moved to the configured error destination or are simply deleted. This attribute is dynamically configurable, but only incoming messages are impacted; previously sent messages continue to use their original redelivery limit. Note: The number of times a message has been redelivered is not persisted. This means that after a restart, the number of delivery attempts on each message is reset to zero. | Admin Console field label: Redelivery Limit Default: -1 Minimum: -1 Maximum: 231-1
StoreEnabled | Specifies whether the destination supports persistent messaging by using the JMS store specified by the JMS server. default - The destination uses the JMS store defined for the JMS server--if one is defined--and supports persistent messaging. However, if a JMS store is not defined for the JMS server, then persistent messages are automatically downgraded to non-persistent. false - The destination does not support persistent messaging. true - The destination does support persistent messaging. However, if a JMS store is not defined for the JMS server, then the configuration will fail and the JMS server will not boot. This attribute is not dynamically configurable. | Admin Console field label: Enable Store Required: no Default: default
Template | The JMS template from which the destination is derived. If a JMS template is specified, destination attributes that are set to their default values will inherit their values from the JMS template at run time. However, 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 JMS template's attributes, however, can be modified dynamically. | Admin Console field label: Template Required: no
TimeToDeliverOverride | Defines the default delay, either in milliseconds or as a schedule, between when a message is produced and when it is made visible on its target 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 TimeToDeliver setting. The TimeToDeliverOverride can be specified either as a long or as a schedule. Note: Changing the TimeToDeliverOverride only affects future message delivery, it does not affect message delivery of already produced messages. | Admin Console field label: Time To Deliver Override Required: no Default: -1
TimeToLiveOverride | The time-to-live value assigned to all messages that arrive at the destination, regardless of the TimeToLive specified by the message producer. The default value (-1) specifies that the destination will not override the TimeToLive setting. This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted. | Admin Console field label: Time To Live Override Default: -1 Minimum: -1 Maximum: 263-1