jrds

Class ProbeConnected<KeyType,ValueType,ConnectionClass extends Connection<?>>

java.lang.Object

jrds.starter.StarterNode

jrds.Probe<KeyType,ValueType>

jrds.ProbeConnected<KeyType,ValueType,ConnectionClass>

All Implemented Interfaces:

Comparable<Probe<KeyType,ValueType>>, ConnectedProbe, StartersSet

Direct Known Subclasses:

GenericJdbcProbe, JMX, KstatProbe, KstatSumProbe, Ldap, Munin, SnmpProbe

public abstract class ProbeConnected<KeyType,ValueType,ConnectionClass extends Connection<?>>
extends Probe<KeyType,ValueType>
implements ConnectedProbe

Constructor Summary

Constructors

Constructor and Description
ProbeConnected(String connectionName)

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	configure()
ConnectionClass	getConnection()
String	getConnectionName()
Map<KeyType,ValueType>	getNewSampleValues() The method that return a map of data collected. It should return return as raw as possible, they can even be opaque data tied to the probe.
abstract Map<KeyType,ValueType>	getNewSampleValuesConnected(ConnectionClass cnx)
boolean	isCollectRunning()
void	setConnectionName(String connectionName)
protected void	setUptime(ConnectionClass cnx) This method is used by getNewSampleValues to define the uptime for the probe. The default way is to read it using the connection.

Methods inherited from class jrds.Probe

addGraph, addGraph, checkStore, checkStoreFile, collect, compareTo, create, dsExist, dumpAsXml, dumpAsXml, fetchData, fetchData, fetchData, filterValues, getCollectMapping, getDsDefs, getGraphList, getHost, getLabel, getLastUpdate, getLastValues, getName, getNamedLogger, getPd, getQualifiedName, getRrdDef, getRrdName, getSourceType, getTags, getUptime, hashCode, log, log, modifySample, readProperties, readSpecific, setHost, setLabel, setName, setPd, setUptime, toString

Methods inherited from class jrds.starter.StarterNode

configureStarters, find, find, find, find, find, getHostList, getLevel, getParent, getStarters, getStep, getTimeout, isStarted, registerStarter, registerStarter, setParent, setParent, setStep, setTimeout, startCollect, stopCollect

Methods inherited from class java.lang.Object

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

Constructor Detail

ProbeConnected

public ProbeConnected(String connectionName)

Method Detail

configure

public Boolean configure()

getConnectionName

public String getConnectionName()

Specified by:

getConnectionName in interface ConnectedProbe

setConnectionName

public void setConnectionName(String connectionName)

Specified by:

setConnectionName in interface ConnectedProbe

getConnection

public ConnectionClass getConnection()

getNewSampleValues

public Map<KeyType,ValueType> getNewSampleValues()

The method that return a map of data collected.
It should return return as raw as possible, they can even be opaque data tied to the probe. the key is resolved using the ProbeDesc. A key not associated with an existent datastore will generate a warning but will not prevent the other values to be stored.
the value should be a java.lang.Number
It also set the uptime for the probe, using connection data. One should override setUptime if a probe use a specific uptime, that can't be provided using the connection.

Specified by:

getNewSampleValues in class Probe<KeyType,ValueType>

Returns:

the map of collected object

setUptime

protected void setUptime(ConnectionClass cnx)

This method is used by getNewSampleValues to define the uptime for the probe.
The default way is to read it using the connection. It might be overridden if needed.

Parameters:

cnx -

getNewSampleValuesConnected

public abstract Map<KeyType,ValueType> getNewSampleValuesConnected(ConnectionClass cnx)

isCollectRunning

public boolean isCollectRunning()

Overrides:

isCollectRunning in class StarterNode