org.jboss.modcluster.load.metric

Interface LoadMetricMBean

All Known Subinterfaces:

LoadMetric

public interface LoadMetricMBean

Author:

Paul Ferraro

Method Summary

Modifier and Type	Method and Description
double	getCapacity() Returns the load capacity of this metric.
int	getWeight() Returns the "weight" of this metric, i.e.
void	setCapacity(double capacity) Sets the maximum capacity of this metric.
void	setWeight(int weight) Sets the weight of the metric relative to the other metrics.

Method Detail

getWeight

int getWeight()

Returns the "weight" of this metric, i.e. significance of this load metric compared to the other metrics.

Returns:

the weight of the metric

getCapacity

double getCapacity()

Returns the load capacity of this metric. Used to normalize the value returned by LoadMetric.getLoad(org.jboss.modcluster.container.Engine) expressed as a percentage of the capacity, such that: 0 <= (LoadMetric.getLoad(org.jboss.modcluster.container.Engine) / getCapacity()) < 1

Returns:

the estimated capacity of this metric.

setWeight

void setWeight(int weight)

Sets the weight of the metric relative to the other metrics. Defaults to 1.

Parameters:

weight - weight of the metric.

setCapacity

void setCapacity(double capacity)

Sets the maximum capacity of this metric. Used for metrics that do not have an implicit capacity and need to be configured. Defaults to 1.

Parameters:

capacity - non-negative capacity of the metric.