org.opennms.netmgt.poller.remote

Interface PollerBackEnd

All Known Implementing Classes:

DefaultPollerBackEnd, ExceptionProtectedPollerBackEnd, ServerUnreachableAdaptor

public interface PollerBackEnd

PollerBackEnd interface.

Version:

$Id: $

Author:

Mathew Brozowski

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONNECTION_HOST_ADDRESS_KEY
static String	CONNECTION_HOST_NAME_KEY
static String	HOST_ADDRESS_KEY
static String	HOST_NAME_KEY

Method Summary

Modifier and Type	Method and Description
void	checkForDisconnectedMonitors() checkForDisconnectedMonitors
void	configurationUpdated() configurationUpdated
Set<String>	getApplicationsForLocation(String location) Gets all applications associated with OnmsMonitoredService objects managed by this monitoring location.
Set<MetadataField>	getMetadataFields() Gets all of the metadata fields to be used and optionally reported by the poller frontend.
Collection<OnmsMonitoringLocation>	getMonitoringLocations() Return the set of available MonitoringLocationDefinitions
String	getMonitorName(String locationMonitorId) Get monitor name
PollerConfiguration	getPollerConfiguration(String locationMonitorId) Deprecated. Use getPollerConfigurationForLocation(String) instead.
PollerConfiguration	getPollerConfigurationForLocation(String location) Gets the poller configuration assigned to this monitoring location
Collection<ServiceMonitorLocator>	getServiceMonitorLocators(DistributionContext context) Get service monitor locators for creating serviceMonitors for the poller.
PollerTheme	getTheme() Gets the theme (color, title, logo) information to use in poller UIs
OnmsLocationMonitor.MonitorStatus	pollerCheckingIn(String locationMonitorId, Date currentConfigurationVersion) Checkin with the backend to let it know that the poller is still alive and to find out if there are any configuration changes.
boolean	pollerStarting(String locationMonitorId, Map<String,String> pollerDetails) Notifies the backend that a registered poller is starting
void	pollerStopping(String locationMonitorId) Notifies the backend that a registered poller is stopping
String	registerLocationMonitor(String monitoringLocationId) Register a new location monitor
void	reportResult(String locationMonitorID, int serviceId, PollStatus status) Report a poll result from the client to the server.
void	reportSingleScan(ScanReport report) Report a single scan from the client to the server.
void	saveResponseTimeData(String locationMonitor, OnmsMonitoredService monSvc, double responseTime, Package pkg) saveResponseTimeData

Field Detail

HOST_ADDRESS_KEY

static final String HOST_ADDRESS_KEY

See Also:

Constant Field Values

HOST_NAME_KEY

static final String HOST_NAME_KEY

See Also:

Constant Field Values

CONNECTION_HOST_ADDRESS_KEY

static final String CONNECTION_HOST_ADDRESS_KEY

See Also:

Constant Field Values

CONNECTION_HOST_NAME_KEY

static final String CONNECTION_HOST_NAME_KEY

See Also:

Constant Field Values

Method Detail

getMonitoringLocations

Collection<OnmsMonitoringLocation> getMonitoringLocations()

Return the set of available MonitoringLocationDefinitions

Returns:

a Collection object.

registerLocationMonitor

String registerLocationMonitor(String monitoringLocationId)

Register a new location monitor

Parameters:

monitoringLocationId - the id of the monitoredLocation to associate with this location monitor

Returns:

the id of the new locations monitor

getMonitorName

String getMonitorName(String locationMonitorId)

Get monitor name

Parameters:

locationMonitorId - a int.

Returns:

a String object.

getServiceMonitorLocators

Collection<ServiceMonitorLocator> getServiceMonitorLocators(DistributionContext context)

Get service monitor locators for creating serviceMonitors for the poller.

Parameters:

context - a DistributionContext object.

Returns:

a Collection object.

pollerStarting

boolean pollerStarting(String locationMonitorId,
                       Map<String,String> pollerDetails)

Notifies the backend that a registered poller is starting

Parameters:

locationMonitorId - the id of the requesting location monitor

pollerDetails - TODO

Returns:

a boolean.

pollerStopping

void pollerStopping(String locationMonitorId)

Notifies the backend that a registered poller is stopping

Parameters:

locationMonitorId - the id of the requesting location monitor

pollerCheckingIn

OnmsLocationMonitor.MonitorStatus pollerCheckingIn(String locationMonitorId,
                                                   Date currentConfigurationVersion)

Checkin with the backend to let it know that the poller is still alive and to find out if there are any configuration changes.

Parameters:

locationMonitorId - the id of the location monitor that is checking in

currentConfigurationVersion - the version of the configuration that the location monitor is currently using

Returns:

true if the configuration should be updated.

getPollerConfiguration

PollerConfiguration getPollerConfiguration(String locationMonitorId)

Deprecated. Use getPollerConfigurationForLocation(String) instead.

Gets the poller configuration assigned to this location monitor.

Parameters:

locationMonitorId - the id of the requesting location monitor

Returns:

the PollerConfiguration for the indicated location monitor

See Also:

http://issues.opennms.org/browse/PB-36

getPollerConfigurationForLocation

PollerConfiguration getPollerConfigurationForLocation(String location)

Gets the poller configuration assigned to this monitoring location

Parameters:

location - the location

Returns:

the PollerConfiguration for the indicated location

getApplicationsForLocation

Set<String> getApplicationsForLocation(String location)

Gets all applications associated with OnmsMonitoredService objects managed by this monitoring location.

Parameters:

location - the location

Returns:

a Set of application names for this location

getMetadataFields

Set<MetadataField> getMetadataFields()

Gets all of the metadata fields to be used and optionally reported by the poller frontend.

Returns:

a Set of metadata fields

getTheme

PollerTheme getTheme()

Gets the theme (color, title, logo) information to use in poller UIs

Returns:

a poller theme

reportResult

void reportResult(String locationMonitorID,
                  int serviceId,
                  PollStatus status)

Report a poll result from the client to the server.

Parameters:

locationMonitorID - the id of the location monitor that did the poll

serviceId - the id of the service that was polled

status - a PollStatus object.

reportSingleScan

void reportSingleScan(ScanReport report)

Report a single scan from the client to the server.

configurationUpdated

void configurationUpdated()

configurationUpdated

checkForDisconnectedMonitors

void checkForDisconnectedMonitors()

checkForDisconnectedMonitors

saveResponseTimeData

void saveResponseTimeData(String locationMonitor,
                          OnmsMonitoredService monSvc,
                          double responseTime,
                          Package pkg)

saveResponseTimeData

Parameters:

locationMonitor - a String object.

monSvc - a OnmsMonitoredService object.

responseTime - a double.

pkg - a Package object.