org.opennms.netmgt.collectd

Class CollectionSpecification

java.lang.Object

org.opennms.netmgt.collectd.CollectionSpecification

public class CollectionSpecification
extends Object

CollectionSpecification class.

Version:

$Id: $

Author:

ranger

Constructor Summary

Constructors

Constructor and Description
CollectionSpecification(Package wpkg, String svcName, ServiceCollector collector, CollectionInstrumentation instrumentation) Constructor for CollectionSpecification.

Method Summary

Methods

Modifier and Type	Method and Description
CollectionSet	collect(CollectionAgent agent) collect
long	getInterval() getInterval
String	getPackageName() getPackageName
RrdRepository	getRrdRepository(String collectionName) getRrdRepository
String	getServiceName() getServiceName
ServiceParameters	getServiceParameters() Return a read only instance of the parameters, which consists of the overall service parameters, plus various other Collection specific parameters (e.g.
void	initialize(CollectionAgent agent) initialize
void	refresh(CollectdConfigFactory collectorConfigDao) refresh
void	release(CollectionAgent agent) release
boolean	scheduledOutage(CollectionAgent agent) scheduledOutage
String	toString() toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionSpecification

public CollectionSpecification(Package wpkg,
                       String svcName,
                       ServiceCollector collector,
                       CollectionInstrumentation instrumentation)

Constructor for CollectionSpecification.

Parameters:

wpkg - a org.opennms.netmgt.config.CollectdPackage object.

svcName - a String object.

collector - a ServiceCollector object.

Method Detail

getPackageName

public String getPackageName()

getPackageName

Returns:

a String object.

getServiceName

public String getServiceName()

getServiceName

Returns:

a String object.

getInterval

public long getInterval()

getInterval

Returns:

a long.

toString

public String toString()

toString

Overrides:

toString in class Object

Returns:

a String object.

getServiceParameters

public ServiceParameters getServiceParameters()

Return a read only instance of the parameters, which consists of the overall service parameters, plus various other Collection specific parameters (e.g. storeByNodeID etc)

Returns:

A read only Map instance

initialize

public void initialize(CollectionAgent agent)
                throws CollectionInitializationException

initialize

Parameters:

agent - a CollectionAgent object.

Throws:

CollectionInitializationException

release

public void release(CollectionAgent agent)

release

Parameters:

agent - a CollectionAgent object.

collect

public CollectionSet collect(CollectionAgent agent)
                      throws CollectionException

collect

Parameters:

agent - a CollectionAgent object.

Returns:

a CollectionSet object.

Throws:

CollectionException - if any.

scheduledOutage

public boolean scheduledOutage(CollectionAgent agent)

scheduledOutage

Parameters:

agent - a CollectionAgent object.

Returns:

a boolean.

refresh

public void refresh(CollectdConfigFactory collectorConfigDao)

refresh

Parameters:

collectorConfigDao - a org.opennms.netmgt.dao.api.CollectorConfigDao object.

getRrdRepository

public RrdRepository getRrdRepository(String collectionName)

getRrdRepository

Parameters:

collectionName - a String object.

Returns:

a RrdRepository object.