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.
Modifier and Type | Method and Description |
---|---|
long |
getBytesHigh()
The upper threshold (total number of bytes in this destination)
that triggers logging or flow control events.
|
long |
getBytesLow()
The lower threshold (total number of bytes in this destination)
that triggers logging or flow control events.
|
long |
getMessagesHigh()
The upper threshold (total number of messages in this
destination) that triggers logging or flow control events.
|
long |
getMessagesLow()
The lower threshold (total number of messages in this
destination) that triggers logging or flow control events.
|
TemplateBean |
getTemplateBean()
Finds the template bean for this destination.
|
void |
setBytesHigh(long bytesHigh)
Sets the value of the BytesHigh attribute.
|
void |
setBytesLow(long bytesLow)
Sets the value of the BytesLow attribute.
|
void |
setMessagesHigh(long messagesHigh)
Sets the value of the MessagesHigh attribute.
|
void |
setMessagesLow(long messagesLow)
Sets the value of the MessagesLow attribute.
|
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.
void setBytesHigh(long bytesHigh) throws IllegalArgumentException
Sets the value of the BytesHigh attribute.
bytesHigh
- The upper value that triggers events based on bytes storedIllegalArgumentException
ThresholdParamsBean.getBytesHigh()
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.
void setBytesLow(long bytesLow) throws IllegalArgumentException
Sets the value of the BytesLow attribute.
bytesLow
- The lower value that triggers events based on bytes storedIllegalArgumentException
ThresholdParamsBean.getBytesLow()
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.
void setMessagesHigh(long messagesHigh) throws IllegalArgumentException
Sets the value of the MessagesHigh attribute.
messagesHigh
- The upper value that triggers events based on messages storedIllegalArgumentException
ThresholdParamsBean.getMessagesHigh()
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.
void setMessagesLow(long messagesLow) throws IllegalArgumentException
Sets the value of the MessagesLow attribute.
messagesLow
- The lower value that triggers events based on messages storedIllegalArgumentException
ThresholdParamsBean.getMessagesLow()
TemplateBean getTemplateBean()
Finds the template bean for this destination.