org.opennms.netmgt.poller.remote.support

Class DefaultPollerBackEnd

java.lang.Object

org.opennms.netmgt.poller.remote.support.DefaultPollerBackEnd

All Implemented Interfaces:

SpringServiceDaemon, PollerBackEnd, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

@Transactional
public class DefaultPollerBackEnd
extends Object
implements PollerBackEnd, SpringServiceDaemon

DefaultPollerBackEnd class.

Author:

Mathew Brozowski, DJ Gregor

Field Summary

Fields

Modifier and Type	Field and Description
static String	FAILED_POLL_RESULT_MESSAGE_FORMAT
static String	FAILURE_SUMMARY_MESSAGE_FORMAT
static int	HEARTBEAT_STEP_MULTIPLIER
static String	PARM_SCAN_REPORT_FAILURE_MESSAGE
static String	PARM_SCAN_REPORT_ID
static String	PARM_SCAN_REPORT_LOCATION

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
DefaultPollerBackEnd()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() afterPropertiesSet
void	checkForDisconnectedMonitors() checkForDisconnectedMonitors
void	configurationUpdated() configurationUpdated
void	destroy() destroy
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
protected static Map<String,Object>	getParameterMap(Service serviceConfig)
PollerConfiguration	getPollerConfiguration(String locationMonitorId) Deprecated. Use #getPoller(OnmsMonitoringLocation) 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 pollResult) 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 locationMonitorId, OnmsMonitoredService monSvc, double responseTime, Package pkg) saveResponseTimeData
void	setDisconnectedTimeout(int disconnectedTimeout) setDisconnectedTimeout
void	setEventIpcManager(EventIpcManager eventIpcManager) setEventIpcManager
void	setLocationMonitorDao(LocationMonitorDao locMonDao) setLocationMonitorDao
void	setMinimumConfigurationReloadInterval(long value) setMinimumConfigurationReloadInterval
void	setMonitoredServiceDao(MonitoredServiceDao monSvcDao) setMonitoredServiceDao
void	setMonitoringLocationDao(MonitoringLocationDao monitoringLocationDao)
void	setPersisterFactory(PersisterFactory persisterFactory)
void	setPollerConfig(PollerConfig pollerConfig) setPollerConfig
void	setScanReportDao(ScanReportDao scanReportDao)
void	setTimeKeeper(TimeKeeper timeKeeper) setTimeKeeper
void	start() start
protected void	updateConnectionHostDetails(OnmsLocationMonitor mon, Map<String,String> pollerDetails)

Methods inherited from class java.lang.Object

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

Field Detail

HEARTBEAT_STEP_MULTIPLIER

public static final int HEARTBEAT_STEP_MULTIPLIER

See Also:

Constant Field Values

PARM_SCAN_REPORT_ID

public static final String PARM_SCAN_REPORT_ID

See Also:

Constant Field Values

PARM_SCAN_REPORT_LOCATION

public static final String PARM_SCAN_REPORT_LOCATION

See Also:

Constant Field Values

PARM_SCAN_REPORT_FAILURE_MESSAGE

public static final String PARM_SCAN_REPORT_FAILURE_MESSAGE

See Also:

Constant Field Values

FAILURE_SUMMARY_MESSAGE_FORMAT

public static final String FAILURE_SUMMARY_MESSAGE_FORMAT

See Also:

Constant Field Values

FAILED_POLL_RESULT_MESSAGE_FORMAT

public static final String FAILED_POLL_RESULT_MESSAGE_FORMAT

See Also:

Constant Field Values

Constructor Detail

DefaultPollerBackEnd

public DefaultPollerBackEnd()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

afterPropertiesSet

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception - if any.

start

public void start()

start

Specified by:

start in interface SpringServiceDaemon

Throws:

Exception - if any.

destroy

public void destroy()

destroy

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

checkForDisconnectedMonitors

public void checkForDisconnectedMonitors()

checkForDisconnectedMonitors

Specified by:

checkForDisconnectedMonitors in interface PollerBackEnd

configurationUpdated

public void configurationUpdated()

configurationUpdated

Specified by:

configurationUpdated in interface PollerBackEnd

getMonitoringLocations

@Transactional(readOnly=true)
public Collection<OnmsMonitoringLocation> getMonitoringLocations()

getMonitoringLocations

Specified by:

getMonitoringLocations in interface PollerBackEnd

Returns:

a Collection object.

getMonitorName

@Transactional(readOnly=true)
public String getMonitorName(String locationMonitorId)

Get monitor name

Specified by:

getMonitorName in interface PollerBackEnd

Parameters:

locationMonitorId - a int.

Returns:

a String object.

getParameterMap

protected static Map<String,Object> getParameterMap(Service serviceConfig)

getPollerConfiguration

@Transactional(readOnly=true)
public PollerConfiguration getPollerConfiguration(String locationMonitorId)

Deprecated. Use #getPoller(OnmsMonitoringLocation) instead.

Description copied from interface: PollerBackEnd

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

@Transactional(readOnly=true)
public PollerConfiguration getPollerConfigurationForLocation(String location)

Description copied from interface: PollerBackEnd

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

@Transactional(readOnly=true)
public Set<String> getApplicationsForLocation(String location)

Description copied from interface: PollerBackEnd

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

@Transactional(readOnly=true)
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.

updateConnectionHostDetails

protected void updateConnectionHostDetails(OnmsLocationMonitor mon,
                                           Map<String,String> pollerDetails)

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 pollResult)

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

pollResult - a PollStatus object.

saveResponseTimeData

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

saveResponseTimeData

Specified by:

saveResponseTimeData in interface PollerBackEnd

Parameters:

locationMonitorId - a String object.

monSvc - a OnmsMonitoredService object.

responseTime - a double.

pkg - a Package object.

setDisconnectedTimeout

public void setDisconnectedTimeout(int disconnectedTimeout)

setDisconnectedTimeout

Parameters:

disconnectedTimeout - a int.

setMinimumConfigurationReloadInterval

public void setMinimumConfigurationReloadInterval(long value)

setMinimumConfigurationReloadInterval

Parameters:

value -

setEventIpcManager

public void setEventIpcManager(EventIpcManager eventIpcManager)

setEventIpcManager

Parameters:

eventIpcManager - a EventIpcManager object.

setMonitoringLocationDao

public void setMonitoringLocationDao(MonitoringLocationDao monitoringLocationDao)

setLocationMonitorDao

public void setLocationMonitorDao(LocationMonitorDao locMonDao)

setLocationMonitorDao

Parameters:

locMonDao - a LocationMonitorDao object.

setMonitoredServiceDao

public void setMonitoredServiceDao(MonitoredServiceDao monSvcDao)

setMonitoredServiceDao

Parameters:

monSvcDao - a MonitoredServiceDao object.

setScanReportDao

public void setScanReportDao(ScanReportDao scanReportDao)

setPollerConfig

public void setPollerConfig(PollerConfig pollerConfig)

setPollerConfig

Parameters:

pollerConfig - a PollerConfig object.

setTimeKeeper

public void setTimeKeeper(TimeKeeper timeKeeper)

setTimeKeeper

Parameters:

timeKeeper - a TimeKeeper object.

setPersisterFactory

public void setPersisterFactory(PersisterFactory persisterFactory)

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

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

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