Rio Project 4.2 API Documentation

org.rioproject.system.measurable.cpu
Class CPU

java.lang.Object
  org.rioproject.watch.Watch
      org.rioproject.watch.ThresholdWatch
          org.rioproject.watch.PeriodicWatch
              org.rioproject.system.measurable.MeasurableCapability
                  org.rioproject.system.measurable.cpu.CPU

All Implemented Interfaces:

ResourceCostProducer, MeasurableCapabilityMBean, PeriodicWatchMBean, ThresholdWatchMBean, WatchMBean

public class CPU
extends MeasurableCapability

The CPU object is a MeasurableCapability which refers to the platform's capability describing CPU utilization, capacity, and load.

Author:

Dennis Reedy

Field Summary

static String

VIEW

Fields inherited from class org.rioproject.system.measurable.MeasurableCapability

lastMeasured, monitor, sampleSize

Fields inherited from class org.rioproject.watch.PeriodicWatch

DEFAULT_PERIOD

Fields inherited from class org.rioproject.watch.Watch

DEFAULT_VIEW, id, localRef, watchDataSource

Constructor Summary

CPU(Configuration config)
Construct a new CPU object

CPU(Configuration config, String id, boolean monitorJVM)
Construct a new CPU object

Method Summary

void	checkValue() Abstract method to check the watch's value at the periodic interval
MeasurableMonitor	getMeasurableMonitor()
double	getUtilization() Get the computed utilization for this CPU object

Methods inherited from class org.rioproject.system.measurable.MeasurableCapability

addSecondaryThresholdManager, addWatchRecord, calculateResourceCost, getConfiguration, getMeasuredResource, getObservable, getSampleSize, getSLA, getThresholdManagers, isEnabled, removeSecondaryThresholdManager, setEnabled, setLastMeasuredResource, setMeasurableMonitor, setResourceCostModel, setSampleSize, setSLA, setWatchDataSource

Methods inherited from class org.rioproject.watch.PeriodicWatch

getPeriod, setPeriod, start, stop

Methods inherited from class org.rioproject.watch.ThresholdWatch

addThresholdListener, getBreachedCount, getClearedCount, getCurrentHighThreshold, getCurrentLowThreshold, getHighThreshold, getLowThreshold, getThresholdManager, getThresholdValues, removeThresholdListener, setCurrentHighThreshold, setCurrentLowThreshold, setThresholdValues

Methods inherited from class org.rioproject.watch.Watch

clear, equals, getCalculables, getId, getLastCalculableValue, getView, getWatchDataSource, hashCode, main, setView, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.rioproject.watch.PeriodicWatchMBean

getPeriod, setPeriod, start, stop

Methods inherited from interface org.rioproject.watch.ThresholdWatchMBean

getBreachedCount, getClearedCount, getCurrentHighThreshold, getCurrentLowThreshold, getHighThreshold, getLowThreshold, setCurrentHighThreshold, setCurrentLowThreshold

Methods inherited from interface org.rioproject.watch.WatchMBean

clear, getCalculables, getId, getLastCalculableValue

Field Detail

VIEW

public static final String VIEW

See Also:

Constant Field Values

Constructor Detail

CPU

public CPU(Configuration config)

Construct a new CPU object

Parameters:

config - Configuration object

CPU

public CPU(Configuration config,
           String id,
           boolean monitorJVM)

Construct a new CPU object

Parameters:

config - Configuration object

id - The identifier for the CPU watch

monitorJVM - If true, monitor the JVM's CPU utlization. If false, monitor the machine's CPU utilization

Method Detail

getUtilization

public double getUtilization()

Get the computed utilization for this CPU object

Returns:

Utilization computed for this component

checkValue

public void checkValue()

Description copied from interface: PeriodicWatchMBean

Abstract method to check the watch's value at the periodic interval

getMeasurableMonitor

public MeasurableMonitor getMeasurableMonitor()