org.opennms.netmgt.collectd

Class SnmpCollector

java.lang.Object

org.opennms.netmgt.collectd.SnmpCollector

All Implemented Interfaces:

ServiceCollector

public class SnmpCollector
extends Object
implements ServiceCollector

The SnmpCollector class ...

Author:

Matt Brozowski

Field Summary

Fields

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

Fields inherited from interface org.opennms.netmgt.collection.api.ServiceCollector

COLLECTION_FAILED, COLLECTION_SUCCEEDED, COLLECTION_UNKNOWN, statusType

Constructor Summary

Constructors

Constructor and Description
SnmpCollector()

Method Summary

Modifier and Type	Method and Description
CollectionSet	collect(CollectionAgent agent, EventProxy eventProxy, Map<String,Object> parameters) Invokes a collection on the object.
RrdRepository	getRrdRepository(String collectionName) getRrdRepository
void	initialize(CollectionAgent agent, Map<String,Object> parameters) initialize
void	initialize(Map<String,String> parameters) initialize
void	release() Responsible for freeing up any resources held by the collector.
void	release(CollectionAgent agent) release
String	serviceName() Returns the name of the service that the plug-in collects ("SNMP").

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 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

Constructor Detail

SnmpCollector

public SnmpCollector()

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(Map<String,String> parameters)

initialize

Initialize the service collector. During initialization the SNMP collector:

• Initializes various configuration factories.
• Verifies access to the database.
• Verifies access to RRD file repository.
• Verifies access to JNI RRD shared library.
• Determines if SNMP to be stored for only the node's primary interface or for all interfaces.

Specified by:

initialize in interface ServiceCollector

Parameters:

parameters - a Map object.

Throws:

RuntimeException - Thrown if an unrecoverable error occurs that prevents the plug-in from functioning.

release

public void release()

Responsible for freeing up any resources held by the collector.

Specified by:

release in interface ServiceCollector

initialize

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

initialize

Responsible for performing all necessary initialization for the specified interface in preparation for data collection.

Specified by:

initialize in interface ServiceCollector

Parameters:

agent - a org.opennms.netmgt.collectd.CollectionAgent object.

parameters - a Map object.

Throws:

CollectionInitializationException

release

public void release(CollectionAgent agent)

release

Responsible for releasing any resources associated with the specified interface.

Specified by:

release in interface ServiceCollector

Parameters:

agent - a org.opennms.netmgt.collectd.CollectionAgent object.

collect

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

Invokes a collection on the object. Perform data collection.

Specified by:

collect in interface ServiceCollector

Parameters:

agent - a org.opennms.netmgt.collectd.CollectionAgent object.

eventProxy - a EventProxy object.

parameters - a Map object.

Returns:

a org.opennms.netmgt.config.collector.CollectionSet object.

Throws:

CollectionException

getRrdRepository

public RrdRepository getRrdRepository(String collectionName)

getRrdRepository

Specified by:

getRrdRepository in interface ServiceCollector

Parameters:

collectionName - a String object.

Returns:

a RrdRepository object.