org.opennms.nrtg.api.model

Interface CollectionJob

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultCollectionJob

public interface CollectionJob
extends Serializable

Defines a collection job for a satellite.

The smallest sensible job unit to collect in one action.

A set of metrics from one interface in one technology at one time.

The satellite calls the responsible protocol handler. The protocol handler can optimize the collection of metrics depending on protocol specifics (one/multiple connection, one/multiple session, one/multiple call ...).

Author:

Simon Walter

Method Summary

Modifier and Type	Method and Description
void	addMetric(String metricId, Set<String> destinationSet, String onmsLogicMetricId)
Set<String>	getAllMetrics()
Date	getCreationTimestamp()
Date	getFinishedTimestamp()
String	getId()
MeasurementSet	getMeasurementSet()
Map<String,MeasurementSet>	getMeasurementSetsByDestination()
String	getMetricType(String metricId)
String	getMetricValue(String metricId)
String	getNetInterface()
int	getNodeId()
String	getOnmsLogicMetricId(String metricId)
Map<String,Object>	getParameters()
String	getProtocolConfiguration()
String	getService()
String	getSite()
void	setCreationTimestamp(Date creationTimestamp)
void	setFinishedTimestamp(Date finishedTimestamp)
void	setId(String id)
void	setMetricValue(String metricId, String value)
void	setMetricValue(String metricId, String metricType, String value)
void	setNetInterface(String theInterface)
void	setNodeId(int nodeId)
void	setParameters(Map<String,Object> parameters)
void	setProtocolConfiguration(String configurationString)
void	setService(String service)
void	setSite(String site)

Method Detail

getAllMetrics

Set<String> getAllMetrics()

setMetricValue

void setMetricValue(String metricId,
                    String metricType,
                    String value)
             throws IllegalArgumentException

Throws:

IllegalArgumentException

setMetricValue

void setMetricValue(String metricId,
                    String value)
             throws IllegalArgumentException

Throws:

IllegalArgumentException

getMetricValue

String getMetricValue(String metricId)
               throws IllegalArgumentException

Throws:

IllegalArgumentException

addMetric

void addMetric(String metricId,
               Set<String> destinationSet,
               String onmsLogicMetricId)
        throws IllegalArgumentException

Throws:

IllegalArgumentException

setParameters

void setParameters(Map<String,Object> parameters)

getParameters

Map<String,Object> getParameters()

getMeasurementSet

MeasurementSet getMeasurementSet()

setId

void setId(String id)

getId

String getId()

setNodeId

void setNodeId(int nodeId)

getNodeId

int getNodeId()

setSite

void setSite(String site)

getSite

String getSite()

setCreationTimestamp

void setCreationTimestamp(Date creationTimestamp)

getCreationTimestamp

Date getCreationTimestamp()

setFinishedTimestamp

void setFinishedTimestamp(Date finishedTimestamp)

getFinishedTimestamp

Date getFinishedTimestamp()

setNetInterface

void setNetInterface(String theInterface)

getNetInterface

String getNetInterface()

getService

String getService()

setService

void setService(String service)

getMeasurementSetsByDestination

Map<String,MeasurementSet> getMeasurementSetsByDestination()

setProtocolConfiguration

void setProtocolConfiguration(String configurationString)

getProtocolConfiguration

String getProtocolConfiguration()

getMetricType

String getMetricType(String metricId)
              throws IllegalArgumentException

Throws:

IllegalArgumentException

getOnmsLogicMetricId

String getOnmsLogicMetricId(String metricId)