org.jboss.modcluster.load.metric.impl

Class HeapMemoryUsageLoadMetric

java.lang.Object

org.jboss.modcluster.load.metric.impl.AbstractLoadMetric

org.jboss.modcluster.load.metric.impl.HeapMemoryUsageLoadMetric

All Implemented Interfaces:

LoadMetric, LoadMetricMBean

public class HeapMemoryUsageLoadMetric
extends AbstractLoadMetric

LoadMetric implementation that returns the heap memory usage ratio.

Author:

Paul Ferraro

Field Summary

Fields inherited from interface org.jboss.modcluster.load.metric.LoadMetric

DEFAULT_CAPACITY, DEFAULT_WEIGHT

Constructor Summary

Constructors

Constructor and Description
HeapMemoryUsageLoadMetric()
HeapMemoryUsageLoadMetric(MemoryMXBean bean)

Method Summary

Modifier and Type	Method and Description
double	getLoad(Engine engine) Returns the current load of this metric as a percent of the metric's capacity.

Methods inherited from class org.jboss.modcluster.load.metric.impl.AbstractLoadMetric

getCapacity, getWeight, setCapacity, setWeight

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeapMemoryUsageLoadMetric

public HeapMemoryUsageLoadMetric()

HeapMemoryUsageLoadMetric

public HeapMemoryUsageLoadMetric(MemoryMXBean bean)

Method Detail

getLoad

public double getLoad(Engine engine)
               throws Exception

Description copied from interface: LoadMetric

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

Returns:

raw load / capacity.

Throws:

NodeUnavailableException - if the node should be put into the error state.

Exception - if the load could not be determined.