WebLogic Server Configuration Reference

 Previous Next Contents Index View as PDF  

JMSQueue

 


Description

 


Syntax

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

 


Parent Elements

 


Attributes

Table 30-1 JMSQueue attributes

Attribute

Description

Range of Values and Default

BytesMaximum

Returns the value of BytesMaximum.

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

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.

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 Maximum

Required: no

Default: -1

Minimum: -1

Maximum: 263-1

BytesPagingEnabled

Return one of "true", "false", or "default".

Flag for specifying whether or not bytes paging is enabled on the destination:

  • If this flag is not selected (false), then bytes paging is explicitly disabled for this destination.

  • If this flag is not selected (true), 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.

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

Admin Console field label: Bytes Paging Enabled

Required: no

Default: default

BytesThresholdHigh

Returns the value of BytesThresholdHigh.

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: If bytes paging is enabled, it cannot be dynamically disabled by resetting the BytesThresholdHigh to -1, as this will cause an exception to be thrown. To dynamically disable paging, you could set the BytesThresholdHigh to a very large number, so that paging would not be triggered.

Admin Console field label: Bytes Threshold High

Required: no

Default: -1

Minimum: -1

Maximum: 263-1

BytesThresholdLow

Returns the value of BytesThresholdLow.

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

Required: no

Default: -1

Minimum: -1

Maximum: 263-1

DeliveryModeOverride

Returns the DeliveryModeOverride value.

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 template or destination.

Admin Console field label: Destination Keys

Required: no

ErrorDestination

Sets the ErrorDestination value for messages that have reached their redelivery limit.

Defines the name of the target destination for messages that have reached their redelivery limit. If no error destination is configured, then such messages are simply dropped.

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

JNDIName

Returns the JNDI name of the destination.

This value is the 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: JNDIName

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.

Required: no

Default: true

MessagesMaximum

Returns the value of MessagesMaximum.

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

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.

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 Maximum

Required: no

Default: -1

Minimum: -1

Maximum: 263-1

MessagesPagingEnabled

Return one of "true", "false", or "default".

Flag for specifying whether or not messages paging is enabled on the destination:

  • If this flag is not selected (false), then messages paging is explicitly disabled for this destination.

  • If this flag is not selected (true), 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.

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

Admin Console field label: Messages Paging Enabled

Required: no

Default: default

MessagesThresholdHigh

Returns the value of MessagesThresholdHigh.

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: If messages paging is enabled, it cannot be dynamically disabled by resetting the MessagesThresholdHigh to -1, as this will cause an exception to be thrown. To dynamically disable paging, you could set the MessagesThresholdHigh to a very large number, so that paging would not be triggered.

Admin Console field label: Messages Threshold High

Required: no

Default: -1

Minimum: -1

Maximum: 263-1

MessagesThresholdLow

Returns the value of MessagesThresholdLow.

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

Required: no

Default: -1

Minimum: -1

Maximum: 263-1

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

Returns the PriorityOverride value.

This value is 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

Required: no

Default: -1

Minimum: -1

Maximum: 9

RedeliveryDelayOverride

Returns the RedeliveryDelayOverride value in milliseconds before rolled back and recovered messages are redelivered.

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.

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.

Admin Console field label: Redelivery Delay Override

Required: no

Default: -1

Minimum: -1

Maximum: 263-1

RedeliveryLimit

Returns 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 RedeliveryLimit setting.

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

Note: Changing the RedeliveryLimit does not affect messages that have already reached this limit. The next time such messages are redelivered, they will immediately be redirected to the error destination. The number of times of 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

Required: no

Default: -1

Minimum: -1

Maximum: 263-1

StoreEnabled

Return one of "true", "false", or "default".

Flag specifying whether or not the destination uses the persistent store specified by the JMS server:

  • If this flag is enabled (true), 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 (false), 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.

Admin Console field label: Enable Store

Required: no

Default: default

Template

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

Note: Attributes that are set to their default values will inherit their destination values from the JMS template at run time. If this attribute is not defined, then the attributes for the destination must be specified as part of the destination.

Admin Console field label: Template

Required: no

TimeToDeliverOverride

Returns the TimeToDeliver override value either in milliseconds or as a schedule.

Defines the default delay, in milliseconds, 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

Returns the TimeToLiveOverride value.

Defines the TimeToLive 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

Required: no

Default: -1

Minimum: -1

Maximum: 263-1

 

Back to Top Previous Next