Hyperic HQ Plugin API v. 4.4.0.2

org.hyperic.hq.product
Class SNMPMeasurementPlugin

java.lang.Object
  extended by org.hyperic.hq.product.GenericPlugin
      extended by org.hyperic.hq.product.MeasurementPlugin
          extended by org.hyperic.hq.product.SNMPMeasurementPlugin

public class SNMPMeasurementPlugin
extends MeasurementPlugin


Field Summary
static java.lang.String DOMAIN
           
static java.lang.String PROP_INDEX_NAME
           
static java.lang.String PROP_INDEX_VALUE
           
 
Fields inherited from class org.hyperic.hq.product.MeasurementPlugin
PROP_TEMPLATE_CONFIG, TYPE_COLLECTOR
 
Fields inherited from class org.hyperic.hq.product.GenericPlugin
config, FILE_DELIM, FILE_DELIM_ESC, PROP_NAME
 
Constructor Summary
SNMPMeasurementPlugin()
           
 
Method Summary
protected  java.lang.String[] getMIBs()
           
 MetricValue getValue(Metric metric)
          This method is called when the plugin is asked for a metric value.
 void init(PluginManager manager)
          Called when the plugin is loaded on the server and on the agent side.
 
Methods inherited from class org.hyperic.hq.product.MeasurementPlugin
getCollectorProperties, getConfigSchema, getHelp, getManager, getMeasurementProperties, getMeasurements, getNewCollector, getPlatformHelpProperties, getPluginXMLHelp, translate
 
Methods inherited from class org.hyperic.hq.product.GenericPlugin
adjustClassPath, configure, getAbsoluteFiles, getConfig, getConfig, getCustomPropertiesSchema, getCustomPropertiesSchema, getCustomPropertiesSchema, getDefaultInstallPath, getLog, getLogName, getManagerProperty, getName, getPlatformName, getPluginClassName, getPluginData, getPluginProperty, getProductPlugin, getProperties, getScriptExtension, getScriptExtension, getScriptExtension, getTypeInfo, getTypeNameProperty, getTypeNameProperty, getTypeProperties, getTypeProperty, getTypeProperty, getTypeProperty, isNetStatEnabled, isWin32, openResource, setData, setName, setTypeInfo, shutdown, toFileList
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DOMAIN

public static final java.lang.String DOMAIN
See Also:
Constant Field Values

PROP_INDEX_NAME

public static final java.lang.String PROP_INDEX_NAME
See Also:
Constant Field Values

PROP_INDEX_VALUE

public static final java.lang.String PROP_INDEX_VALUE
See Also:
Constant Field Values
Constructor Detail

SNMPMeasurementPlugin

public SNMPMeasurementPlugin()
Method Detail

getMIBs

protected java.lang.String[] getMIBs()

init

public void init(PluginManager manager)
          throws PluginException
Description copied from class: GenericPlugin
Called when the plugin is loaded on the server and on the agent side.

Overrides:
init in class MeasurementPlugin
Parameters:
manager - The plugin manager for this plugin type.
Throws:
PluginException

getValue

public MetricValue getValue(Metric metric)
                     throws MetricUnreachableException,
                            MetricNotFoundException,
                            PluginException
Description copied from class: MeasurementPlugin
This method is called when the plugin is asked for a metric value. The Metric is a translated value as returned by the getMeasurements() routine, and then run through the translate() method.

Overrides:
getValue in class MeasurementPlugin
Parameters:
metric - Value returned from translate(), representing a specific metric to retrieve
Returns:
The value of the Metric and timestamp of collection time
Throws:
MetricUnreachableException - The monitored resource is unreachable. I.e. ConnectException
MetricNotFoundException - The monitored resource does not know about the requested Metric. I.e. JMX AttributeNotFoundException
PluginException - Thrown when an internal plugin error occurs

Hyperic HQ Plugin API v. 4.4.0.2

Copyright © 2004-2006 Hyperic, Inc. support@hyperic.net, All Rights Reserved.