Package com.opencloud.rhino.limiting

Interface StatLimiterMBean

All Superinterfaces:

LimiterMBean

All Known Subinterfaces:

AbsoluteStatLimiterMBean, RelativeStatLimiterMBean

public interface StatLimiterMBean
extends LimiterMBean

Defines the JMX interface for controlling a single stat 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.

Since:

Rhino 2.7.0

Method Summary

Modifier and Type	Method	Description
double[]	getLimitPercentages()	Get the corresponding limit percentages for the limiting tiers.
double[][]	getLimitPercentagesForNodes(int[] nodeIDs)	Get the corresponding per-node limit percentages for the limiting tiers.
String	getParameterSet()	Get the parameter set for the statistic to monitor.
String	getStatistic()	Get the statistic to monitor.
void	setParameterSetStatistic(String parameterSet, String statistic)	Set the parameter set and statistic to monitor.

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

getParameterSet

String getParameterSet()
                throws ConfigurationException

Get the parameter set for the statistic to monitor.

Returns:

the parameter set name

Throws:

ConfigurationException - if an error occurred reading the limiter configuration.

Since:

Rhino 2.7.0

getStatistic

String getStatistic()
             throws ConfigurationException

Get the statistic to monitor.

Returns:

the statistic name

Throws:

ConfigurationException - if an error occurred reading the limiter configuration.

Since:

Rhino 2.7.0

setParameterSetStatistic

void setParameterSetStatistic(String parameterSet,
                              String statistic)
                       throws ConfigurationException,
                              com.opencloud.util.exception.ValidationException

Set the parameter set and statistic to monitor.

Parameters:

parameterSet - the parameter set name

statistic - the statistic name

Throws:

ConfigurationException - if an error occurred updating the limiter configuration.

com.opencloud.util.exception.ValidationException - if the new limiter configuration is invalid.

Since:

Rhino 2.7.0

getLimitPercentages

double[] getLimitPercentages()
                      throws ConfigurationException

Get the corresponding limit percentages for the limiting tiers.

Returns:

an array of the max value limit percentages or an empty array if not configured

Throws:

ConfigurationException - if an error occurred reading the limiter configuration.

Since:

Rhino 2.7.0

getLimitPercentagesForNodes

double[][] getLimitPercentagesForNodes(int[] nodeIDs)
                                throws ConfigurationException,
                                       InvalidArgumentException

Get the corresponding per-node limit percentages for the limiting tiers.

Parameters:

nodeIDs - the IDs of the nodes

Returns:

a two-dimensional array of the limit percentages for each node or an empty array if not configured

Throws:

ConfigurationException - if an error occurred reading the limiter configuration.

InvalidArgumentException - if nodeIDs is a zero-length array.

Since:

Rhino 2.7.0