org.jboss.modcluster.load.metric

Interface LoadMetricMBean

All Known Subinterfaces:

LoadMetric

All Known Implementing Classes:

AbstractLoadMetric, AbstractMBeanLoadMetric, ActiveSessionsLoadMetric, AverageSystemLoadMetric, BusyConnectorsLoadMetric, HeapMemoryUsageLoadMetric, MBeanAttributeLoadMetric, MBeanAttributeRatioLoadMetric, ReceiveTrafficLoadMetric, RequestCountLoadMetric, SendTrafficLoadMetric

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)
void	setWeight(int weight) Returns the current load of this metric as a percent of the metric's capacity.

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 #getLoad() expressed as a percentage of the capacity, such that: 0 <= (#getLoad() / getCapacity()) < 1

Returns:

the estimated capacity of this metric.

setWeight

void setWeight(int weight)

Returns the current load of this metric as a percent of the metric's capacity.

Throws:

Exception - if the load could not be determined.

setCapacity

void setCapacity(double capacity)