Package com.opencloud.rhino.limiting

Interface QueueSaturationLimiterMBean

All Superinterfaces:

LimiterMBean

public interface QueueSaturationLimiterMBean
extends LimiterMBean

Defines the JMX interface for controlling a single queue saturation limiter.

When a node is configured to use the pool clustering mode, operations in this interface that include an argument to specify an array of node IDs can only be used to manage state on the node the management client directs the method call at, as determined by RhinoHousekeepingMBean.getNodeID(). Including the node ID of any other node in the array argument will result in an InvalidArgumentException being thrown. To manage state for another node in pool mode, a client must connect directly with that node.

Limiter Information

A CompositeData object containing detailed Limiter information for specified nodes is returned by the methods LimiterMBean.getInfoSummary(int[]) and LimiterMBean.getConfigSummary().

Field	Open Type	Description
limiter-name	String	The name of this limiter. Always null for per-node values returned by LimiterMBean.getConfigSummary().
type	String	The type of this limiter. Always null for per-node values returned by LimiterMBean.getConfigSummary().
node-id	Integer	The node ID that this row applies to. -1 for the cluster-wide values row returned by LimiterMBean.getConfigSummary().
parent	String	The name of the parent of this limiter or null if it has no parent. Always null for per-node values returned by LimiterMBean.getConfigSummary().
max-saturation	Double	The maximum saturation setting for this limiter
bypassed	Boolean	The bypassed setting for this limiter

Method Summary

Modifier and Type	Method	Description
double	getMaxSaturationDefault()	Get the default maximum amount of saturation allowed in the queue, as a percentage, before this limiter will reject work.
double[]	getMaxSaturationForNode(int[] nodeIDs)	Get the per-node maximum amount of saturation allowed in the queue on the specified nodes, as a percentage, before this limiter will reject work.
void	setMaxSaturationDefault(double maxSaturation)	Set the default maximum amount of saturation allowed in the queue, as a percentage, before this limiter will reject work (the range of valid values is from "0" to "100").
void	setMaxSaturationForNode(double[] maxSaturation, int[] nodeIDs)	Set the per-node maximum amount of saturation allowed in the queue on the specified nodes, as a percentage, before this limiter will reject work (the range of valid values is from "0" to "100").
void	setMaxSaturationForNode(Double[] maxSaturation, int[] nodeIDs)	Set the per-node maximum amount of saturation allowed in the queue on the specified nodes, as a percentage, before this limiter will reject work (the range of valid values is from "0" to "100").

Methods inherited from interface com.opencloud.rhino.limiting.LimiterMBean

getChildLimiters, getConfigSummary, getConnectedEndPoints, getInfoSummary, getName, getParent, getType, isBypassedDefault, isBypassedForNode, setBypassedDefault, setBypassedForNode, setBypassedForNode, setParent, useDefaultConfig

Method Detail

getMaxSaturationDefault

double getMaxSaturationDefault()
                        throws ConfigurationException

Get the default maximum amount of saturation allowed in the queue, as a percentage, before this limiter will reject work. E.g. "80" means that the limiter will reject work when the queue is over 80% full. The range of valid values is from "0" to "100". This value will be used when no per-node setting exists for a given node.

Throws:

ConfigurationException

getMaxSaturationForNode

double[] getMaxSaturationForNode(int[] nodeIDs)
                          throws ConfigurationException,
                                 NullPointerException,
                                 InvalidArgumentException

Get the per-node maximum amount of saturation allowed in the queue on the specified nodes, as a percentage, before this limiter will reject work. E.g. "80" means that the limiter will reject work when the queue is over 80% full. The range of valid values is from "0" to "100".

Throws:

ConfigurationException

NullPointerException

InvalidArgumentException

setMaxSaturationDefault

void setMaxSaturationDefault(double maxSaturation)
                      throws ConfigurationException,
                             com.opencloud.util.exception.ValidationException

Set the default maximum amount of saturation allowed in the queue, as a percentage, before this limiter will reject work (the range of valid values is from "0" to "100"). E.g. "80" means that the limiter will reject work when the queue is over 80% full. This value will be used when no per-node setting exists for a given node.

Throws:

ConfigurationException

com.opencloud.util.exception.ValidationException

setMaxSaturationForNode

void setMaxSaturationForNode(double[] maxSaturation,
                             int[] nodeIDs)
                      throws ConfigurationException,
                             com.opencloud.util.exception.ValidationException,
                             NullPointerException,
                             InvalidArgumentException

Set the per-node maximum amount of saturation allowed in the queue on the specified nodes, as a percentage, before this limiter will reject work (the range of valid values is from "0" to "100"). E.g. "80" means that the limiter will reject work when the queue is over 80% full.

Throws:

ConfigurationException

com.opencloud.util.exception.ValidationException

NullPointerException

InvalidArgumentException

setMaxSaturationForNode

void setMaxSaturationForNode(Double[] maxSaturation,
                             int[] nodeIDs)
                      throws ConfigurationException,
                             com.opencloud.util.exception.ValidationException,
                             NullPointerException,
                             InvalidArgumentException

Set the per-node maximum amount of saturation allowed in the queue on the specified nodes, as a percentage, before this limiter will reject work (the range of valid values is from "0" to "100"). E.g. "80" means that the limiter will reject work when the queue is over 80% full.

This method is identical to setMaxSaturationForNode(double[], int[]) but it allows a previously set per-node value to be deleted by specifying a null value for that node in the input array.

Throws:

ConfigurationException

com.opencloud.util.exception.ValidationException

NullPointerException

InvalidArgumentException

Since:

Rhino 2.7.0