|
Hyperic HQ Plugin API v. 2.5.dev | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.hyperic.hq.product.GenericPlugin
net.hyperic.hq.product.MeasurementPlugin
net.hyperic.hq.product.SigarMeasurementPlugin
net.hyperic.hq.product.JDBCMeasurementPlugin
Base class for JDBC measurement plugins. Abstracts the JDBC connection and query functionality.
Field Summary | |
protected static java.lang.String |
AVAIL_ATTR
|
static int |
COL_INVALID
|
static java.lang.String |
PROP_PASSWORD
|
static java.lang.String |
PROP_TABLE
|
static java.lang.String |
PROP_URL
|
static java.lang.String |
PROP_USER
|
Fields inherited from class net.hyperic.hq.product.SigarMeasurementPlugin |
manager, PTQL_CONFIG, PTQL_DOMAIN, VALUE_NOTIMPL |
Fields inherited from class net.hyperic.hq.product.MeasurementPlugin |
PROP_TEMPLATE_CONFIG |
Fields inherited from class net.hyperic.hq.product.GenericPlugin |
config, FILE_DELIM, FILE_DELIM_ESC, PROP_NAME |
Constructor Summary | |
JDBCMeasurementPlugin()
|
Method Summary | |
protected java.sql.Connection |
getCachedConnection(java.lang.String url,
java.lang.String user,
java.lang.String pass)
|
protected int |
getColumn(Metric jdsn)
The column in the ResultSet that holds the measurement value. |
protected java.lang.String |
getColumnName(Metric jdsn)
|
ConfigSchema |
getConfigSchema(TypeInfo info,
ConfigResponse config)
Config schema includes jdbc URL, database username and password. |
protected abstract java.sql.Connection |
getConnection(java.lang.String url,
java.lang.String user,
java.lang.String password)
The plugin must preform the DriverManager.getConnection so its ClassLoader is used to find the driver. |
protected abstract java.lang.String |
getDefaultURL()
|
protected abstract void |
getDriver()
The plugin must preform the Class.forName so its ClassLoader is used to find the driver. |
protected abstract java.lang.String |
getQuery(Metric jdsn)
|
protected double |
getQueryValue(Metric jdsn)
Do the database query returned by the getQuery() method and return the result. |
MetricValue |
getValue(Metric metric)
Dispatches to getQueryValue() |
void |
init(PluginManager manager)
Verifies that JDBC driver returned by the getDriver() method can be loaded by the plugin. |
protected abstract void |
initQueries()
|
protected void |
removeCachedConnection(java.lang.String url,
java.lang.String user,
java.lang.String pass)
|
void |
shutdown()
Close any cached connections. |
Methods inherited from class net.hyperic.hq.product.SigarMeasurementPlugin |
getSigar, translate |
Methods inherited from class net.hyperic.hq.product.MeasurementPlugin |
getHelp, getManager, getMeasurementProperties, getMeasurements, getPlatformHelpProperties, getPluginXMLHelp |
Methods inherited from class net.hyperic.hq.product.GenericPlugin |
configure, getAbsoluteFiles, getConfig, getConfig, getCustomPropertiesSchema, getCustomPropertiesSchema, getCustomPropertiesSchema, getDefaultInstallPath, getLog, getLogName, getName, getPlatformName, getPluginClassName, getProductPlugin, getProperties, getProperty, getTypeInfo, getTypeNameProperty, getTypeNameProperty, getTypeProperty, getTypeProperty, getTypeProperty, isWin32, openResource, setName, setTypeInfo, toFileList |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final java.lang.String AVAIL_ATTR
public static final java.lang.String PROP_URL
public static final java.lang.String PROP_USER
public static final java.lang.String PROP_PASSWORD
public static final java.lang.String PROP_TABLE
public static final int COL_INVALID
Constructor Detail |
public JDBCMeasurementPlugin()
Method Detail |
public ConfigSchema getConfigSchema(TypeInfo info, ConfigResponse config)
getConfigSchema
in class MeasurementPlugin
public void init(PluginManager manager) throws PluginException
init
in class SigarMeasurementPlugin
PluginException
public void shutdown() throws PluginException
shutdown
in class SigarMeasurementPlugin
PluginException
public MetricValue getValue(Metric metric) throws PluginException, MetricUnreachableException, MetricInvalidException, MetricNotFoundException
getValue
in class SigarMeasurementPlugin
PluginException
MetricUnreachableException
MetricInvalidException
MetricNotFoundException
protected abstract void initQueries()
protected abstract java.lang.String getQuery(Metric jdsn)
protected abstract void getDriver() throws java.lang.ClassNotFoundException
java.lang.ClassNotFoundException
protected abstract java.sql.Connection getConnection(java.lang.String url, java.lang.String user, java.lang.String password) throws java.sql.SQLException
java.sql.SQLException
protected abstract java.lang.String getDefaultURL()
protected int getColumn(Metric jdsn)
protected java.lang.String getColumnName(Metric jdsn)
protected java.sql.Connection getCachedConnection(java.lang.String url, java.lang.String user, java.lang.String pass) throws java.sql.SQLException
java.sql.SQLException
protected void removeCachedConnection(java.lang.String url, java.lang.String user, java.lang.String pass)
protected double getQueryValue(Metric jdsn) throws MetricNotFoundException, PluginException, MetricUnreachableException
MetricNotFoundException
PluginException
MetricUnreachableException
|
Hyperic HQ Plugin API v. 2.5.dev | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |