weblogic.j2ee.descriptor.wl
Interface ThresholdParamsBean

All Superinterfaces:

SettableBean

public interface ThresholdParamsBean
extends SettableBean

Thresholds are a point that must be exceeded in order to produce a given effect. These action points may cause logging or flow control or other actions, as defined by the specific points whose values have been exceeded.

Access limited to the following security roles:

Deployer

getBytesHigh

long getBytesHigh()

The upper threshold (total number of bytes in this destination) that triggers logging or flow control events. The value of java.lang.Long.MAX_VALUE disables logging and flow control events for 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.

• Flow Control

  If flow control is enabled, the destination becomes armed and instructs producers to begin decreasing their message flow.

Range of Values: <= BytesMaximum; >BytesThresholdLow

Any change to this threshold affects only incoming messages; stored messages are not affected.

Returns:

The upper value that triggers events based on bytes stored

Changes take effect after you redeploy the module or restart the server.

Default Value:

java.lang.Long.MAX_VALUE

setBytesHigh

void setBytesHigh(long bytesHigh)
                  throws IllegalArgumentException

Sets the value of the BytesHigh attribute.

Parameters:

bytesHigh - The upper value that triggers events based on bytes stored

Throws:

IllegalArgumentException

See Also:

ThresholdParamsBean.getBytesHigh()

Changes take effect after you redeploy the module or restart the server.

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

0

getBytesLow

long getBytesLow()

The lower threshold (total number of bytes in this destination) that triggers logging or flow control events. The value of java.lang.Long.MAX_VALUE disables logging and flow control events for 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 a low threshold condition.

• Flow Control

  If flow control is enabled, the destination becomes disarmed and instructs producers to begin increasing their message flow.

Range of Values: < BytesThresholdHigh

Any change to this threshold affects only incoming messages; stored messages are not affected.

Returns:

The lower value that triggers events based on bytes stored

Changes take effect after you redeploy the module or restart the server.

Default Value:

java.lang.Long.MAX_VALUE

setBytesLow

void setBytesLow(long bytesLow)
                 throws IllegalArgumentException

Sets the value of the BytesLow attribute.

Parameters:

bytesLow - The lower value that triggers events based on bytes stored

Throws:

IllegalArgumentException

See Also:

ThresholdParamsBean.getBytesLow()

Changes take effect after you redeploy the module or restart the server.

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

0

getMessagesHigh

long getMessagesHigh()

The upper threshold (total number of messages in this destination) that triggers logging or flow control events. The value of java.lang.Long.MAX_VALUE disables logging and flow control events for 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.

• Flow Control

  If flow control is enabled, the destination becomes armed and instructs producers to begin decreasing their message flow.

Range of Values: <= MessagesMaximum; >MessagesThresholdLow

Any change to this threshold affects only incoming messages; stored messages are not affected.

Returns:

The upper value that triggers events based on messages stored

Changes take effect after you redeploy the module or restart the server.

Default Value:

java.lang.Long.MAX_VALUE

setMessagesHigh

void setMessagesHigh(long messagesHigh)
                     throws IllegalArgumentException

Sets the value of the MessagesHigh attribute.

Parameters:

messagesHigh - The upper value that triggers events based on messages stored

Throws:

IllegalArgumentException

See Also:

ThresholdParamsBean.getMessagesHigh()

Changes take effect after you redeploy the module or restart the server.

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

0

getMessagesLow

long getMessagesLow()

The lower threshold (total number of messages in this destination) that triggers logging or flow control events. The value of java.lang.Long.MAX_VALUE disables logging and flow control events for 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 a low threshold condition.

• Flow Control

  If flow control is enabled, the destination becomes disarmed and instructs producers to begin increasing their message flow.

Range of Values: < MessagesThresholdHigh

Any change to this threshold affects only incoming messages; stored messages are not affected.

Returns:

The lower value that triggers events based on messages stored

Changes take effect after you redeploy the module or restart the server.

Default Value:

java.lang.Long.MAX_VALUE

setMessagesLow

void setMessagesLow(long messagesLow)
                    throws IllegalArgumentException

Sets the value of the MessagesLow attribute.

Parameters:

messagesLow - The lower value that triggers events based on messages stored

Throws:

IllegalArgumentException

See Also:

ThresholdParamsBean.getMessagesLow()

Changes take effect after you redeploy the module or restart the server.

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

0

getTemplateBean

TemplateBean getTemplateBean()

Finds the template bean for this destination.

Returns:

The template bean that will be used for this destination, or null if this threshold bean is from a template or a template could not be found for this destination