WebLogic Server Configuration Reference

 Previous Next Contents Index View as PDF  

JMSServer

 


Description

This MBean defines a JMS Server.

 


Syntax

<JMSServer
BytesMaximum="number"
BytesPagingEnabled=( "true" | "false" )
BytesThresholdHigh="number"
BytesThresholdLow="number"
DeploymentOrder="number"
MessagesMaximum="number"
MessagesPagingEnabled=( "true" | "false" )
MessagesThresholdHigh="number"
MessagesThresholdLow="number"
Name="String"
Notes="String"
PagingStore="JMSStore name"
Store="JMSStore name"
Targets="list of Target names"
TemporaryTemplate="JMSTemplate name"
/>

 


Parent Elements

 


Child Elements

 


Attributes

Table 31-1 JMSServer 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 JMS server. A value of -1 specifies that there is no limit on the number of bytes that can be stored in the JMS server.

Range of Values: >= BytesThresholdHigh

This attribute is dynamically configurable.

Admin Console field label: Bytes Maximum

Required: no

Default: -1

Minimum: -1

Maximum: 263-1

BytesPagingEnabled

Check if BytesPagingEnabled is set.

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

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

  • If this flag is selected (true), a paging store has been configured, and both the BytesThresholdLow and BytesThresholdHigh attribute values are greater than -1, then server bytes paging is enabled.

  • If either the BytesThresholdLow or BytesThreshold Highattribute is undefined, or defined as -1, then server bytes paging is implicitly disabled--even though this flag is selected.

Admin Console field label: Bytes Paging Enabled

Required: no

Default: false

BytesThresholdHigh

Returns the value of BytesThresholdHigh.

Upper threshold value that triggers events based on the number of bytes stored in the JMS server. 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 server bytes paging is started.

Flow Control - If flow control is enabled, the JMS server 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 JMS server.

Range of Values: <= BytesMaximum; >BytesThresholdLow

This attribute is dynamically configurable.

Note: Bytes paging cannot be dynamically disabled by resetting the BytesThresholdHigh to -1. To 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 JMS server. 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 JMS server 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 JMS server.

Range of Values: < BytesThresholdHigh

This attribute is dynamically configurable.

Admin Console field label: Bytes Threshold Low

Required: no

Default: -1

Minimum: -1

Maximum: 263-1

DeploymentOrder

A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type. For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

Required: no

Default: 1000

Minimum: 0

Maximum: 231-1

MessagesMaximum

Returns the value of MessagesMaximum.

The maximum number of messages that may be stored in the JMS server. A value of -1 specifies that there is no limit on the number of messages that can be stored in the JMS server.

This attribute is dynamically configurable.

Range of Values: >= MessagesThresholdHigh

Admin Console field label: Messages Maximum

Required: no

Default: -1

Minimum: -1

Maximum: 263-1

MessagesPagingEnabled

Check if MessagesPagingEnabled is set.

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


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

  • If this flag is selected (true), a paging store has been configured, and both the MessagesThresholdLow and MessagesThresholdHigh attribute values are greater than -1, then server messages paging is enabled.

  • If either the MessagesThresholdLow or MessagesThresholdHigh attribute is undefined, or defined as -1, then server messages paging is implicitly disabled--even though this flag is selected.

Admin Console field label: Messages Paging Enabled

Required: no

Default: false

MessagesThresholdHigh

Returns the value of MessagesThresholdHigh.

Upper threshold value that triggers events based on the number of messages stored in the JMS server. 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 server messages paging is started.

Flow Control - If flow control is enabled, the JMS server 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 JMS server.

Range of Values: <= MessagesMaximum; >MessagesThresholdLow

This attribute is dynamically configurable.

Note: Messages paging cannot be dynamically disabled by resetting the MessagesThresholdHigh to -1. To 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 JMS server. 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.

Messagse Paging - If messages paging is enabled, paging is stopped (if paging is occurring).

Flow Control - If flow control is enabled, the JMS server 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 JMS server.

Range of Values: < MessagesThresholdHigh

This attribute is dynamically configurable.

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

PagingStore

Get the paging store for the JMS server.

The name of the persistent store where non-persistent messages are paged for the JMS server. A paging store cannot be the same store used for persistent messages or durable subscribers.

A paging store may only be used by one JMS server. A value of none specifies that message paging is not supported. If no paging store is specified, then the server and destinations will not support message paging.

Note: Using a JDBC store is not recommended for paging since the amount of traffic and subsequent lack of performance would make such a configuration undesirable.

Admin Console field label: Paging Store

Required: no

Store

Get the persistent store for the JMS server.

A persistent store may only be used by one JMS server. A value of none specifies that no persistent messaging is supported. If no persistent store is specified, then destinations on this JMS server will not support persistent messages or durable subscribers.

Admin Console field label: Store

Required: no

Targets

The targets in the current domain on which this item can be deployed.

Admin Console field label: Targets

Required: no

TemporaryTemplate

Return the temporary template for the JMS server.

The name of an existing JMS template used to create all temporary destinations, including temporary queues and temporary topics. The attribute values for a temporary destination are derived from this JMS template. If provided as part of the template, the Store attribute values are ignored because temporary destinations do not support persistent messaging.

Note: If this attribute is set to none, attempts to create a temporary destination (queue or topic) will fail.

Admin Console field label: Temporary Template

Required: no

 

Back to Top Previous Next