Package org.opennms.netmgt.collectd

Class AbstractSnmpCollector

java.lang.Object

org.opennms.netmgt.collection.api.AbstractServiceCollector

org.opennms.netmgt.collectd.AbstractSnmpCollector

All Implemented Interfaces:

ServiceCollector

Direct Known Subclasses:

SnmpCollector, SnmpCollectorNG

public abstract class AbstractSnmpCollector
extends AbstractServiceCollector

Commons between SnmpCollector and SnmpCollectorNG.

Author:

Matt Brozowski

Field Summary

Fields

Modifier and Type	Field	Description
protected LocationAwareSnmpClient	m_client
static String	SNMP_STORAGE_PRIMARY	Valid values for the 'snmpStorageFlag' attribute in datacollection-config XML file.

Constructor Summary

Constructors

Constructor	Description
AbstractSnmpCollector()

Method Summary

Modifier and Type	Method	Description
abstract CollectionSet	collect(CollectionAgent agent, Map<String,Object> parameters)	Invokes a collection on the object.
RrdRepository	getRrdRepository(String collectionName)	Retrieve the RrdRepository configuration for the given collection.
void	initialize()	Initialize the collector.
String	serviceName()	Returns the name of the service that the plug-in collects ("SNMP").
void	validateAgent(CollectionAgent agent, Map<String,Object> parameters)	Validate whether or not this collector should be scheduled to run against the given agent.

Methods inherited from class org.opennms.netmgt.collection.api.AbstractServiceCollector

getEffectiveLocation, getRuntimeAttributes, marshalParameters, unmarshalParameters

Methods inherited from class java.lang.Object

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

Field Detail

SNMP_STORAGE_PRIMARY

public static final String SNMP_STORAGE_PRIMARY

Valid values for the 'snmpStorageFlag' attribute in datacollection-config XML file. "primary" = only primary SNMP interface should be collected and stored "all" = all primary SNMP interfaces should be collected and stored

See Also:

Constant Field Values

m_client

protected LocationAwareSnmpClient m_client

Constructor Detail

AbstractSnmpCollector

public AbstractSnmpCollector()

Method Detail

serviceName

public String serviceName()

Returns the name of the service that the plug-in collects ("SNMP").

Returns:

The service that the plug-in collects.

initialize

public void initialize()

Description copied from interface: ServiceCollector

Initialize the collector. This call will be invoked in OpenNMS before any other calls to the collector are made. This function may be invoked several times during the lifetime or the collector.

Specified by:

initialize in interface ServiceCollector

Overrides:

initialize in class AbstractServiceCollector

validateAgent

public void validateAgent(CollectionAgent agent,
                          Map<String,Object> parameters)
                   throws CollectionInitializationException

Description copied from interface: ServiceCollector

Validate whether or not this collector should be scheduled to run against the given agent. If the collector cannot, or should not be a run against a given agent, a CollectionInitializationException must be thrown. In the case of the SNMP collector, this is used to prevent collect from scheduling interfaces other than the those marked as primary on a given node.

Specified by:

validateAgent in interface ServiceCollector

Overrides:

validateAgent in class AbstractServiceCollector

Throws:

CollectionInitializationException

collect

public abstract CollectionSet collect(CollectionAgent agent,
                                      Map<String,Object> parameters)
                               throws CollectionException

Invokes a collection on the object. This call will be performed in both OpenNMS and Minion. Perform data collection.

Parameters:

agent - a CollectionAgent object.

parameters - a Map object.

Returns:

a CollectionSet object.

Throws:

CollectionException - if any.

getRrdRepository

public RrdRepository getRrdRepository(String collectionName)

Retrieve the RrdRepository configuration for the given collection. This call will always be performed in OpenNMS.

Parameters:

collectionName - a String object.

Returns:

a RrdRepository object.