|
Hyperic HQ Plugin API v. 5.8.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.hyperic.hq.product.GenericPlugin
org.hyperic.hq.product.MeasurementPlugin
public class MeasurementPlugin
Define and collect metrics.
Field Summary | |
---|---|
static String |
PROP_TEMPLATE_CONFIG
|
static String |
TYPE_COLLECTOR
|
Fields inherited from class org.hyperic.hq.product.GenericPlugin |
---|
config, FILE_DELIM, FILE_DELIM_ESC, PROP_NAME |
Constructor Summary | |
---|---|
MeasurementPlugin()
|
Method Summary | |
---|---|
Properties |
getCollectorProperties(Metric metric)
|
org.hyperic.util.config.ConfigSchema |
getConfigSchema(TypeInfo info,
org.hyperic.util.config.ConfigResponse config)
The ConfigSchema used to render config options for this resource in the UI and client shell. |
String |
getHelp(TypeInfo info,
Map props)
|
protected MeasurementPluginManager |
getManager()
|
protected Map |
getMeasurementProperties()
Allow xml template properties to be added by a plugin. |
MeasurementInfo[] |
getMeasurements(TypeInfo info)
|
Collector |
getNewCollector()
|
protected String[][] |
getPlatformHelpProperties()
|
protected String |
getPluginXMLHelp(TypeInfo info,
String name,
Map props)
|
org.hyperic.hq.product.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. |
String |
translate(String template,
org.hyperic.util.config.ConfigResponse config)
Translate a measurement as returned from getMeasurements() into a value which can be passed into the plugin's getValue() routine. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String PROP_TEMPLATE_CONFIG
public static final String TYPE_COLLECTOR
Constructor Detail |
---|
public MeasurementPlugin()
Method Detail |
---|
public void init(PluginManager manager) throws PluginException
GenericPlugin
init
in class GenericPlugin
manager
- The plugin manager for this plugin type.
PluginException
protected MeasurementPluginManager getManager()
protected Map getMeasurementProperties()
public MeasurementInfo[] getMeasurements(TypeInfo info)
protected String[][] getPlatformHelpProperties()
protected String getPluginXMLHelp(TypeInfo info, String name, Map props)
public String getHelp(TypeInfo info, Map props)
public org.hyperic.hq.product.MetricValue getValue(Metric metric) throws PluginException, MetricNotFoundException, MetricUnreachableException
metric
- Value returned from translate(), representing a
specific metric to retrieve
MetricInvalidException
- The plugin is unable to use the metric,
generally a developer bug where the template is malformed.
I.e. JMX MalformedObjectNameException
MetricNotFoundException
- The monitored resource does not know
about the requested Metric. I.e. JMX AttributeNotFoundException
MetricUnreachableException
- The monitored resource is unreachable.
I.e. ConnectException
PluginException
- Thrown when an internal plugin error occurspublic Collector getNewCollector()
public Properties getCollectorProperties(Metric metric)
public String translate(String template, org.hyperic.util.config.ConfigResponse config)
template
- Measurement template from one of the plugins
measurements returned from getMeasurements()config
- Configuration used to perform translation on the
template
PluginException
- When an internal plugin error occurs
MetricInvalidException
- When the template passed cannot
be mapped to a template returned
via getMeasurements()public org.hyperic.util.config.ConfigSchema getConfigSchema(TypeInfo info, org.hyperic.util.config.ConfigResponse config)
GenericPlugin
getConfigSchema
in class GenericPlugin
info
- The TypeInfo of this plugin from ProductPlugin.getTypesconfig
- ConfigReponse of the parent resource (if any).
|
Hyperic HQ Plugin API v. 5.8.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |