org.opennms.netmgt.threshd.api

Interface ThresholdingService

All Known Implementing Classes:

ThresholdingServiceImpl

public interface ThresholdingService

Thresholding API Service.

Method Summary

Modifier and Type	Method and Description
ThresholdingSession	createSession(int nodeId, String hostAddress, String serviceName, RrdRepository rrdRepository, ServiceParameters serviceParameters) Creates a session to perform Thresholding against.
ThresholdingSetPersister	getThresholdingSetPersister()

Method Detail

createSession

ThresholdingSession createSession(int nodeId,
                                  String hostAddress,
                                  String serviceName,
                                  RrdRepository rrdRepository,
                                  ServiceParameters serviceParameters)
                           throws ThresholdInitializationException

Creates a session to perform Thresholding against. The Session is keyed by the combination of nodeId, hostAddress and serviceName.

Parameters:

nodeId - The Node Id.

hostAddress - The Host IP Address.

serviceName - The Service name.

rrdRepository - Must not be null. Will be used to resolve Resource Filters and for genertaing Event labels.

serviceParameters - Must not be null. Required by some existing CollectionResource objects to evaluate whether to apply thresholds when accepting a CollectionSet. If your CollectionResource does not require this, pass an empty ServiceParameters object.

Returns:

A ThresholdingSession

Throws:

ThresholdInitializationException - if there is an error creating the ThresholdingSession because of invalid Thresholding Configuration.

getThresholdingSetPersister

ThresholdingSetPersister getThresholdingSetPersister()