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

DefaultPollerFrontEnd class.

Author:

Mathew Brozowski

Nested Class Summary

Nested classes/interfaces inherited from interface org.opennms.netmgt.poller.remote.PollerFrontEnd

PollerFrontEnd.PollerFrontEndStates

Constructor Summary

Constructors

Constructor and Description
DefaultPollerFrontEnd()

Method Summary

Modifier and Type	Method and Description
void	addConfigurationChangedListener(ConfigurationChangedListener l) Register a listener to listen for events indication a change in the poller configuration
void	addPropertyChangeListener(PropertyChangeListener listener) Register a property change listener.
void	addServicePollStateChangedListener(ServicePollStateChangedListener listener) Register a listener for changes in an attribute of a PolledService
void	afterPropertiesSet() afterPropertiesSet
void	checkConfig() checkConfig
void	destroy() destroy
static Map<String,String>	getDetails() Construct a list of certain system properties and metadata about this monitoring system that will be relayed back to the PollerBackEnd.
String	getMonitoringSystemId() getMonitoringSystemId
String	getMonitorName() getMonitorName
Collection<PolledService>	getPolledServices() getPolledServices
List<ServicePollState>	getPollerPollState() getPollerPollState
ServicePollState	getServicePollState(int polledServiceId) Returns the state of polling in this monitor.
void	initialize() Initialize the poller front end.
boolean	isDisconnected() Returns whether or not the poller has been disconnected
boolean	isExitNecessary() isExitNecessary
boolean	isPaused() Returns whether or not the poller has been paused
boolean	isRegistered() isRegistered
boolean	isStarted() isStarted
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 listener) Remove a config change listener
void	removePropertyChangeListener(PropertyChangeListener listener) removePropertyChangeListener
void	removeServicePollStateChangedListener(ServicePollStateChangedListener listener) removeServicePollStateChangedListener
void	setInitialPollTime(Integer polledServiceId, Date initialPollTime) Set the initial poll time for a polledService
void	setPollerBackEnd(PollerBackEnd backEnd) setPollerBackEnd
void	setPollerSettings(PollerSettings settings) setPollerSettings
void	setPollService(PollService pollService) setPollService
void	setTimeAdjustment(TimeAdjustment timeAdjustment)
void	stop() stop

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)

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

Specified by:

addConfigurationChangedListener in interface PollerFrontEnd

Parameters:

l - a ConfigurationChangedListener object.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

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

Specified by:

addPropertyChangeListener in interface PollerFrontEnd

Parameters:

listener - a PropertyChangeListener object.

addServicePollStateChangedListener

public void addServicePollStateChangedListener(ServicePollStateChangedListener listener)

Register a listener for changes in an attribute of a PolledService

Specified by:

addServicePollStateChangedListener in interface PollerFrontEnd

Parameters:

listener - a ServicePollStateChangedListener object.

afterPropertiesSet

public void afterPropertiesSet()

afterPropertiesSet

Specified by:

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

Throws:

Exception - if any.

checkConfig

public void checkConfig()

checkConfig

Specified by:

checkConfig in interface PollerFrontEnd

destroy

public void destroy()

destroy

Specified by:

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

Throws:

Exception - if any.

getDetails

public static Map<String,String> getDetails()

Construct a list of certain system properties and metadata about this monitoring system that will be relayed back to the PollerBackEnd.

Returns:

a Map object.

getMonitoringSystemId

public String getMonitoringSystemId()

getMonitoringSystemId

Returns:

a String object.

getMonitorName

public String getMonitorName()

getMonitorName

Specified by:

getMonitorName in interface PollerFrontEnd

Returns:

a String object.

getPolledServices

public Collection<PolledService> getPolledServices()

getPolledServices

Specified by:

getPolledServices in interface PollerFrontEnd

Returns:

a Collection object.

getPollerPollState

public List<ServicePollState> getPollerPollState()

getPollerPollState

Specified by:

getPollerPollState in interface PollerFrontEnd

Returns:

a List object.

getServicePollState

public ServicePollState getServicePollState(int polledServiceId)

Returns the state of polling in this monitor.

Specified by:

getServicePollState in interface PollerFrontEnd

Parameters:

polledServiceId - a int.

Returns:

a ServicePollState object.

isRegistered

public boolean isRegistered()

isRegistered

Specified by:

isRegistered in interface PollerFrontEnd

Returns:

a boolean.

isStarted

public boolean isStarted()

isStarted

Specified by:

isStarted in interface PollerFrontEnd

Returns:

a boolean.

pollService

public void pollService(Integer polledServiceId)

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)

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

Remove a config change listener

Specified by:

removeConfigurationChangedListener in interface PollerFrontEnd

Parameters:

listener - a ConfigurationChangedListener object.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

Specified by:

removePropertyChangeListener in interface PollerFrontEnd

Parameters:

listener - a PropertyChangeListener object.

removeServicePollStateChangedListener

public void removeServicePollStateChangedListener(ServicePollStateChangedListener listener)

removeServicePollStateChangedListener

Specified by:

removeServicePollStateChangedListener in interface PollerFrontEnd

Parameters:

listener - a ServicePollStateChangedListener object.

setInitialPollTime

public void setInitialPollTime(Integer polledServiceId,
                               Date initialPollTime)

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

setPollerBackEnd

public void setPollerBackEnd(PollerBackEnd backEnd)

setPollerBackEnd

Parameters:

backEnd - a PollerBackEnd object.

setPollerSettings

public void setPollerSettings(PollerSettings settings)

setPollerSettings

Parameters:

settings - a PollerSettings object.

setTimeAdjustment

public void setTimeAdjustment(TimeAdjustment timeAdjustment)

Parameters:

timeAdjustment - the timeAdjustment to set

setPollService

public void setPollService(PollService pollService)

setPollService

Parameters:

pollService - a PollService object.

initialize

public void initialize()

Description copied from interface: PollerFrontEnd

Initialize the poller front end. This will include reading the configuration and then starting up the front end.

Specified by:

initialize in interface PollerFrontEnd

stop

public void stop()

stop

Specified by:

stop in interface PollerFrontEnd

isDisconnected

public boolean isDisconnected()

Description copied from interface: PollerFrontEnd

Returns whether or not the poller has been disconnected

Specified by:

isDisconnected in interface PollerFrontEnd

Returns:

a boolean.

isPaused

public boolean isPaused()

Description copied from interface: PollerFrontEnd

Returns whether or not the poller has been paused

Specified by:

isPaused in interface PollerFrontEnd

Returns:

a boolean.

isExitNecessary

public boolean isExitNecessary()

isExitNecessary

Specified by:

isExitNecessary in interface PollerFrontEnd

Returns:

a boolean.