org.opennms.netmgt.collection.api

Interface ServiceCollector

All Known Implementing Classes:

HttpCollector, JBossCollector, JdbcCollector, JMXCollector, JMXSecureCollector, Jsr160Collector, MX4JCollector, NSClientCollector, SnmpCollector, TcaCollector, VmwareCimCollector, VmwareCollector, WmiCollector, XmlCollector, XmpCollector

public interface ServiceCollector

The Collector class.

Author:

Mike, OpenNMS

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLLECTION_FAILED Constant COLLECTION_FAILED=2
static int	COLLECTION_SUCCEEDED Constant COLLECTION_SUCCEEDED=1
static int	COLLECTION_UNKNOWN Status of the collector object.
static String[]	statusType Constant statusType="{Unknown,COLLECTION_SUCCEEDED,COLLECTIO"{trunked}

Method Summary

Methods

Modifier and Type	Method and Description
CollectionSet	collect(CollectionAgent agent, EventProxy eproxy, 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() release
void	release(CollectionAgent agent) release

Field Detail

COLLECTION_UNKNOWN

static final int COLLECTION_UNKNOWN

Status of the collector object.

See Also:

Constant Field Values

COLLECTION_SUCCEEDED

static final int COLLECTION_SUCCEEDED

Constant COLLECTION_SUCCEEDED=1

See Also:

Constant Field Values

COLLECTION_FAILED

static final int COLLECTION_FAILED

Constant COLLECTION_FAILED=2

See Also:

Constant Field Values

statusType

static final String[] statusType

Constant statusType="{Unknown,COLLECTION_SUCCEEDED,COLLECTIO"{trunked}

Method Detail

initialize

void initialize(Map<String,String> parameters)
                throws CollectionInitializationException

initialize

Parameters:

parameters - a Map object.

Throws:

CollectionInitializationException

release

void release()

release

initialize

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

initialize

Parameters:

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

parameters - a Map object.

Throws:

CollectionInitializationException

release

void release(CollectionAgent agent)

release

Parameters:

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

collect

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

Invokes a collection on the object.

Parameters:

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

eproxy - a EventProxy object.

parameters - a Map object.

Returns:

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

Throws:

org.opennms.netmgt.collectd.CollectionException - if any.

CollectionException

getRrdRepository

RrdRepository getRrdRepository(String collectionName)

getRrdRepository

Parameters:

collectionName - a String object.

Returns:

a RrdRepository object.