org.opennms.netmgt.poller.remote

Interface PollerFrontEnd

All Known Implementing Classes:

DefaultPollerFrontEnd, ScanReportPollerFrontEnd

public interface PollerFrontEnd

PollerFrontEnd interface.

Version:

$Id: $

Author:

Mathew Brozowski

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PollerFrontEnd.PollerFrontEndStates

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 l) Register a property change listener.
void	addServicePollStateChangedListener(ServicePollStateChangedListener l) Register a listener for changes in an attribute of a PolledService
void	checkConfig()
String	getMonitorName() Return the monitor name of the poller or null if none exist
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() Returns whether some error occurred and an exit is necessary
boolean	isPaused() Returns whether or not the poller has been paused
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 monitoringLocationName) Register the poller if it has not been registered before.
void	removeConfigurationChangedListener(ConfigurationChangedListener l) Remove a config change listener
void	removePropertyChangeListener(PropertyChangeListener l) removePropertyChangeListener
void	removeServicePollStateChangedListener(ServicePollStateChangedListener l) removeServicePollStateChangedListener
void	setInitialPollTime(Integer polledServiceId, Date initialPollTime) Set the initial poll time for a polledService
void	stop() Stop polling.

Method Detail

checkConfig

void checkConfig()

getPolledServices

Collection<PolledService> getPolledServices()

getPolledServices

Returns:

a Collection object.

isRegistered

boolean isRegistered()

Is the poller currently registered with the server.

Returns:

true if and only if the server has been registered

getMonitorName

String getMonitorName()

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

Returns:

a String object.

register

void register(String monitoringLocationName)

Register the poller if it has not been registered before.

Parameters:

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

setInitialPollTime

void setInitialPollTime(Integer polledServiceId,
                        Date initialPollTime)

Set the initial poll time for a polledService

Parameters:

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

initialPollTime - the time to set its initialPollTime to

pollService

void pollService(Integer polledServiceId)

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

Parameters:

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

isStarted

boolean isStarted()

Returns whether or not the poller has been started

Returns:

a boolean.

isPaused

boolean isPaused()

Returns whether or not the poller has been paused

Returns:

a boolean.

isDisconnected

boolean isDisconnected()

Returns whether or not the poller has been disconnected

Returns:

a boolean.

isExitNecessary

boolean isExitNecessary()

Returns whether some error occurred and an exit is necessary

Returns:

a boolean.

initialize

void initialize()

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

stop

void stop()

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

getServicePollState

ServicePollState getServicePollState(int polledServiceId)

Returns the state of polling in this monitor.

Parameters:

polledServiceId - a int.

Returns:

a ServicePollState object.

getPollerPollState

List<ServicePollState> getPollerPollState()

getPollerPollState

Returns:

a List object.

addConfigurationChangedListener

void addConfigurationChangedListener(ConfigurationChangedListener l)

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

Parameters:

l - a ConfigurationChangedListener object.

removeConfigurationChangedListener

void removeConfigurationChangedListener(ConfigurationChangedListener l)

Remove a config change listener

Parameters:

l - a ConfigurationChangedListener object.

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener l)

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

Parameters:

l - a PropertyChangeListener object.

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener l)

removePropertyChangeListener

Parameters:

l - a PropertyChangeListener object.

addServicePollStateChangedListener

void addServicePollStateChangedListener(ServicePollStateChangedListener l)

Register a listener for changes in an attribute of a PolledService

Parameters:

l - a ServicePollStateChangedListener object.

removeServicePollStateChangedListener

void removeServicePollStateChangedListener(ServicePollStateChangedListener l)

removeServicePollStateChangedListener

Parameters:

l - a ServicePollStateChangedListener object.