org.opennms.netmgt.poller.remote.support

Class ExceptionProtectedPollerBackEnd

java.lang.Object

org.opennms.netmgt.poller.remote.support.ExceptionProtectedPollerBackEnd

All Implemented Interfaces:

PollerBackEnd

public class ExceptionProtectedPollerBackEnd
extends Object
implements PollerBackEnd

ExceptionProtectedPollerBackEnd. This turns all server side exceptions into RemoteAccessExceptions so the ServerUnreachableAdapter can handle the code correctly.

Version:

$Id: $

Author:

brozow

Field Summary

Fields inherited from interface org.opennms.netmgt.poller.remote.PollerBackEnd

CONNECTION_HOST_ADDRESS_KEY, CONNECTION_HOST_NAME_KEY, HOST_ADDRESS_KEY, HOST_NAME_KEY

Constructor Summary

Constructors

Constructor and Description
ExceptionProtectedPollerBackEnd()

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() getMonitoringLocations
String	getMonitorName(String locationMonitorId) Get monitor name
PollerConfiguration	getPollerConfiguration(String locationMonitorId) Gets the poller configuration assigned to this location monitor.
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
void	setDelegate(PollerBackEnd delegate) setDelegate

Methods inherited from class java.lang.Object

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

Constructor Detail

ExceptionProtectedPollerBackEnd

public ExceptionProtectedPollerBackEnd()

Method Detail

setDelegate

public void setDelegate(PollerBackEnd delegate)

setDelegate

Parameters:

delegate - a PollerBackEnd object.

checkForDisconnectedMonitors

public void checkForDisconnectedMonitors()

checkForDisconnectedMonitors

Specified by:

checkForDisconnectedMonitors in interface PollerBackEnd

configurationUpdated

public void configurationUpdated()

configurationUpdated

Specified by:

configurationUpdated in interface PollerBackEnd

getMonitorName

public String getMonitorName(String locationMonitorId)

Get monitor name

Specified by:

getMonitorName in interface PollerBackEnd

Parameters:

locationMonitorId - a int.

Returns:

a String object.

getMonitoringLocations

public Collection<OnmsMonitoringLocation> getMonitoringLocations()

getMonitoringLocations

Specified by:

getMonitoringLocations in interface PollerBackEnd

Returns:

a Collection object.

getPollerConfiguration

public PollerConfiguration getPollerConfiguration(String locationMonitorId)

Gets the poller configuration assigned to this location monitor.

Specified by:

getPollerConfiguration in interface PollerBackEnd

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

public PollerConfiguration getPollerConfigurationForLocation(String location)

Gets the poller configuration assigned to this monitoring location

Specified by:

getPollerConfigurationForLocation in interface PollerBackEnd

Parameters:

location - the location

Returns:

the PollerConfiguration for the indicated location

getApplicationsForLocation

public Set<String> getApplicationsForLocation(String location)

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

Specified by:

getApplicationsForLocation in interface PollerBackEnd

Parameters:

location - the location

Returns:

a Set of application names for this location

getServiceMonitorLocators

public Collection<ServiceMonitorLocator> getServiceMonitorLocators(DistributionContext context)

Get service monitor locators for creating serviceMonitors for the poller.

Specified by:

getServiceMonitorLocators in interface PollerBackEnd

Parameters:

context - a DistributionContext object.

Returns:

a Collection object.

pollerCheckingIn

public 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.

Specified by:

pollerCheckingIn in interface PollerBackEnd

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.

pollerStarting

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

Notifies the backend that a registered poller is starting

Specified by:

pollerStarting in interface PollerBackEnd

Parameters:

locationMonitorId - the id of the requesting location monitor

pollerDetails - TODO

Returns:

a boolean.

pollerStopping

public void pollerStopping(String locationMonitorId)

Notifies the backend that a registered poller is stopping

Specified by:

pollerStopping in interface PollerBackEnd

Parameters:

locationMonitorId - the id of the requesting location monitor

registerLocationMonitor

public String registerLocationMonitor(String monitoringLocationId)

Register a new location monitor

Specified by:

registerLocationMonitor in interface PollerBackEnd

Parameters:

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

Returns:

the id of the new locations monitor

reportResult

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

Report a poll result from the client to the server.

Specified by:

reportResult in interface PollerBackEnd

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.

saveResponseTimeData

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

Description copied from interface: PollerBackEnd

saveResponseTimeData

Specified by:

saveResponseTimeData in interface PollerBackEnd

Parameters:

locationMonitor - a String object.

monSvc - a OnmsMonitoredService object.

responseTime - a double.

pkg - a Package object.

reportSingleScan

public void reportSingleScan(ScanReport report)

Description copied from interface: PollerBackEnd

Report a single scan from the client to the server.

Specified by:

reportSingleScan in interface PollerBackEnd

getMetadataFields

public Set<MetadataField> getMetadataFields()

Description copied from interface: PollerBackEnd

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

Specified by:

getMetadataFields in interface PollerBackEnd

Returns:

a Set of metadata fields

getTheme

public PollerTheme getTheme()

Description copied from interface: PollerBackEnd

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

Specified by:

getTheme in interface PollerBackEnd

Returns:

a poller theme