org.opennms.netmgt.poller.remote.support
Class DefaultPollerFrontEnd

java.lang.Object
  org.opennms.netmgt.poller.remote.support.DefaultPollerFrontEnd

All Implemented Interfaces:

PollerFrontEnd, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

public class DefaultPollerFrontEnd
extends Object
implements PollerFrontEnd, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

Author:

Mathew Brozowski

Nested Class Summary

class	DefaultPollerFrontEnd.FatalExceptionOccurred
class	DefaultPollerFrontEnd.Initial
class	DefaultPollerFrontEnd.Running

Constructor Summary

DefaultPollerFrontEnd()

Method Summary

void	addConfigurationChangedListener(ConfigurationChangedListener l) Register a listener to listen for events indication a change in the poller configuration
void	addPropertyChangeListener(PropertyChangeListener l) Register a property change listener.
void	addServicePollStateChangedListener(ServicePollStateChangedListener l) Register a listener for changes in an attribute of a PolledService
void	afterPropertiesSet()
void	checkConfig()
void	destroy()
OnmsLocationMonitor.MonitorStatus	doCheckIn()
void	doDelete()
void	doDisconnected()
Integer	doInitialize()
void	doPause()
boolean	doPollerStart()
void	doPollService(Integer polledServiceId)
void	doRegister(String location)
void	doResume()
void	doStop()
Map<String,String>	getDetails()
Integer	getMonitorId()
Collection<OnmsMonitoringLocationDefinition>	getMonitoringLocations()
String	getMonitorName() Return the monitor name of the poller or null if none exist
Collection<PolledService>	getPolledServices()
List<ServicePollState>	getPollerPollState()
ServicePollState	getServicePollState(int polledServiceId) Returns the state of polling in this monitor.
String	getStatus()
boolean	isExitNecessary() Returns whether some error occurred and an exit is necessary
boolean	isRegistered() Is the poller currently registered with the server.
boolean	isStarted() Returns whether or not the poller has been started
void	pollService(Integer polledServiceId) Poll the service with id polledServiceId and report the results to the server
void	register(String monitoringLocation) Register the poller if it has not been registered before.
void	removeConfigurationChangedListener(ConfigurationChangedListener l) Remove a config change listener
void	removePropertyChangeListener(PropertyChangeListener l)
void	removeServicePollStateChangedListener(ServicePollStateChangedListener l)
void	setInitialPollTime(Integer polledServiceId, Date initialPollTime) Set the initial poll time for a polledService
void	setMonitorId(Integer monitorId)
void	setPollerBackEnd(PollerBackEnd backEnd)
void	setPollerSettings(PollerSettings settings)
void	setPollService(PollService pollService)
void	stop() Stop polling.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPollerFrontEnd

public DefaultPollerFrontEnd()

Method Detail

addConfigurationChangedListener

public void addConfigurationChangedListener(ConfigurationChangedListener l)

Description copied from interface: PollerFrontEnd

Register a listener to listen for events indication a change in the poller configuration

Specified by:

addConfigurationChangedListener in interface PollerFrontEnd

doResume

public void doResume()

doPause

public void doPause()

doDisconnected

public void doDisconnected()

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Description copied from interface: PollerFrontEnd

Register a property change listener. (for exampe the 'registered' property)

Specified by:

addPropertyChangeListener in interface PollerFrontEnd

addServicePollStateChangedListener

public void addServicePollStateChangedListener(ServicePollStateChangedListener l)

Description copied from interface: PollerFrontEnd

Register a listener for changes in an attribute of a PolledService

Specified by:

addServicePollStateChangedListener in interface PollerFrontEnd

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

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

Throws:

Exception

checkConfig

public void checkConfig()

destroy

public void destroy()
             throws Exception

Specified by:

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

Throws:

Exception

doCheckIn

public OnmsLocationMonitor.MonitorStatus doCheckIn()

doDelete

public void doDelete()

doInitialize

public Integer doInitialize()

doPollerStart

public boolean doPollerStart()

doPollService

public void doPollService(Integer polledServiceId)

doRegister

public void doRegister(String location)

doStop

public void doStop()

getDetails

public Map<String,String> getDetails()

getMonitorId

public Integer getMonitorId()

getMonitoringLocations

public Collection<OnmsMonitoringLocationDefinition> getMonitoringLocations()

Specified by:

getMonitoringLocations in interface PollerFrontEnd

getMonitorName

public String getMonitorName()

Description copied from interface: PollerFrontEnd

Return the monitor name of the poller or null if none exist

Specified by:

getMonitorName in interface PollerFrontEnd

getPolledServices

public Collection<PolledService> getPolledServices()

Specified by:

getPolledServices in interface PollerFrontEnd

getPollerPollState

public List<ServicePollState> getPollerPollState()

Specified by:

getPollerPollState in interface PollerFrontEnd

getServicePollState

public ServicePollState getServicePollState(int polledServiceId)

Description copied from interface: PollerFrontEnd

Returns the state of polling in this monitor.

Specified by:

getServicePollState in interface PollerFrontEnd

Returns:

getStatus

public String getStatus()

isRegistered

public boolean isRegistered()

Description copied from interface: PollerFrontEnd

Is the poller currently registered with the server.

Specified by:

isRegistered in interface PollerFrontEnd

Returns:

true if and only if the server has been registered

isStarted

public boolean isStarted()

Description copied from interface: PollerFrontEnd

Returns whether or not the poller has been started

Specified by:

isStarted in interface PollerFrontEnd

pollService

public void pollService(Integer polledServiceId)

Description copied from interface: PollerFrontEnd

Poll the service with id polledServiceId and report the results to the server

Specified by:

pollService in interface PollerFrontEnd

Parameters:

polledServiceId - The serviceid of the polledService that needs to be polled

register

public void register(String monitoringLocation)

Description copied from interface: PollerFrontEnd

Register the poller if it has not been registered before.

Specified by:

register in interface PollerFrontEnd

Parameters:

monitoringLocation - The name of the monitoring Location definition under which to register this monitor

removeConfigurationChangedListener

public void removeConfigurationChangedListener(ConfigurationChangedListener l)

Description copied from interface: PollerFrontEnd

Remove a config change listener

Specified by:

removeConfigurationChangedListener in interface PollerFrontEnd

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Specified by:

removePropertyChangeListener in interface PollerFrontEnd

removeServicePollStateChangedListener

public void removeServicePollStateChangedListener(ServicePollStateChangedListener l)

Specified by:

removeServicePollStateChangedListener in interface PollerFrontEnd

setInitialPollTime

public void setInitialPollTime(Integer polledServiceId,
                               Date initialPollTime)

Description copied from interface: PollerFrontEnd

Set the initial poll time for a polledService

Specified by:

setInitialPollTime in interface PollerFrontEnd

Parameters:

polledServiceId - the id of the polledService whose pollTime we are setting

initialPollTime - the time to set its initialPollTime to

setMonitorId

public void setMonitorId(Integer monitorId)

setPollerBackEnd

public void setPollerBackEnd(PollerBackEnd backEnd)

setPollerSettings

public void setPollerSettings(PollerSettings settings)

setPollService

public void setPollService(PollService pollService)

stop

public void stop()

Description copied from interface: PollerFrontEnd

Stop polling. This should be called before the system exits.

Specified by:

stop in interface PollerFrontEnd

isExitNecessary

public boolean isExitNecessary()

Description copied from interface: PollerFrontEnd

Returns whether some error occurred and an exit is necessary

Specified by:

isExitNecessary in interface PollerFrontEnd