Rio Project 4.2 API Documentation

org.rioproject.system.measurable.memory
Class SystemMemoryMonitor

java.lang.Object
  org.rioproject.system.measurable.memory.SystemMemoryMonitor

All Implemented Interfaces:

MeasurableMonitor<SystemMemoryUtilization>

public class SystemMemoryMonitor
extends Object
implements MeasurableMonitor<SystemMemoryUtilization>

The SystemMemoryMonitor object provides feedback information to the SystemMemory object, providing memory usage information for the system using SIGAR. If SIGAR is not available, this utility returns a -1 for system memory utilization.

Note: Hyperic SIGAR is licensed under the GPL with a FLOSS license exception, allowing it to be included with the Rio Apache License v2 distribution. If for some reason the GPL cannot be used with your distribution of Rio, remove the RIO_HOME/lib/hyperic directory.

Author:

Dennis Reedy

Constructor Summary

SystemMemoryMonitor()

Method Summary

SystemMemoryUtilization	getMeasuredResource() Get the MeasuredResource
void	setID(String id) Set the identifier for the resource being measured
void	setThresholdValues(ThresholdValues tVals) Set the ThresholdValues for the resource being measured
void	terminate() Terminate any collection mechanisms

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemMemoryMonitor

public SystemMemoryMonitor()

Method Detail

terminate

public void terminate()

Description copied from interface: MeasurableMonitor

Terminate any collection mechanisms

Specified by:

terminate in interface MeasurableMonitor<SystemMemoryUtilization>

setID

public void setID(String id)

Description copied from interface: MeasurableMonitor

Set the identifier for the resource being measured

Specified by:

setID in interface MeasurableMonitor<SystemMemoryUtilization>

Parameters:

id - The identifier

setThresholdValues

public void setThresholdValues(ThresholdValues tVals)

Description copied from interface: MeasurableMonitor

Set the ThresholdValues for the resource being measured

Specified by:

setThresholdValues in interface MeasurableMonitor<SystemMemoryUtilization>

Parameters:

tVals - The ThresholdValues

getMeasuredResource

public SystemMemoryUtilization getMeasuredResource()

Description copied from interface: MeasurableMonitor

Get the MeasuredResource

Specified by:

getMeasuredResource in interface MeasurableMonitor<SystemMemoryUtilization>

Returns:

The MeasuredResource for the MeasurableMonitor