org.opennms.netmgt.poller.pollables
Class PollableService

java.lang.Object
  org.opennms.netmgt.poller.pollables.PollableElement
      org.opennms.netmgt.poller.pollables.PollableService

All Implemented Interfaces:

Runnable, MonitoredService, ReadyRunnable

public class PollableService
extends PollableElement
implements ReadyRunnable, MonitoredService

Represents a PollableService

Version:

$Id: $

Author:

Mathew Brozowski

Constructor Summary

PollableService(PollableInterface iface, String svcName)
Constructor for PollableService.

Method Summary

Event	createDownEvent(Date date) createDownEvent
void	createOutage(PollEvent cause) createOutage
Event	createResponsiveEvent(Date date) createResponsiveEvent
Event	createUnresponsiveEvent(Date date) createUnresponsiveEvent
Event	createUpEvent(Date date) createUpEvent
void	delete() delete
PollStatus	doPoll() doPoll
PollStatus	doRun() doRun
InetAddress	getAddress() getAddress
PollContext	getContext() getContext
PollableInterface	getInterface() getInterface
String	getIpAddr() getIpAddr
NetworkInterface<InetAddress>	getNetInterface() getNetInterface
PollableNetwork	getNetwork() getNetwork
PollableNode	getNode() getNode
int	getNodeId() getNodeId
String	getNodeLabel() getNodeLabel
Schedule	getSchedule() getSchedule
long	getStatusChangeTime() getStatusChangeTime
String	getSvcName() getSvcName
String	getSvcUrl() Returns a URL representation of the service to monitor and its parameters
boolean	isReady() isReady
PollStatus	poll() poll
void	processStatusChange(Date date) processStatusChange
void	refreshConfig() refreshConfig
void	refreshThresholds() refreshThresholds
protected void	resolveOutage(PollEvent resolution) resolveOutage
void	run() run
void	schedule() schedule
void	sendDeleteEvent() sendDeleteEvent
void	setPollConfig(PollableServiceConfig pollConfig) setPollConfig
void	setSchedule(Schedule schedule) setSchedule
String	toString() toString
void	updateStatus(PollStatus newStatus) updateStatus
protected void	visitThis(PollableVisitor v) visitThis

Methods inherited from class org.opennms.netmgt.poller.pollables.PollableElement

doExtrapolateCause, doInheritParentalCause, doPoll, extrapolateCause, getCause, getLockRoot, getParent, getScope, getStatus, hasOpenOutage, inheritParentalCause, isDeleted, isStatusChanged, isTreeLockAvailable, obtainTreeLock, poll, processCause, processComingUp, processGoingDown, processLingeringCauses, processResolution, recalculateStatus, releaseTreeLock, resetStatusChanged, resolveAllOutages, selectPollElement, setCause, setParent, visit, withTreeLock, withTreeLock, withTreeLock, withTreeLock

Methods inherited from class java.lang.Object

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

Constructor Detail

PollableService

public PollableService(PollableInterface iface,
                       String svcName)

Constructor for PollableService.

Parameters:

svcName - a String object.

iface - a PollableInterface object.

Method Detail

getInterface

public PollableInterface getInterface()

getInterface

Returns:

a PollableInterface object.

getNode

public PollableNode getNode()

getNode

Returns:

a PollableNode object.

getNetwork

public PollableNetwork getNetwork()

getNetwork

Returns:

a PollableNetwork object.

getContext

public PollContext getContext()

getContext

Specified by:

getContext in class PollableElement

Returns:

a PollContext object.

getSvcName

public String getSvcName()

getSvcName

Specified by:

getSvcName in interface MonitoredService

Returns:

a String object.

getIpAddr

public String getIpAddr()

getIpAddr

Specified by:

getIpAddr in interface MonitoredService

Returns:

a String object.

getNodeId

public int getNodeId()

getNodeId

Specified by:

getNodeId in interface MonitoredService

Returns:

a int.

getNodeLabel

public String getNodeLabel()

getNodeLabel

Specified by:

getNodeLabel in interface MonitoredService

Returns:

a String object.

visitThis

protected void visitThis(PollableVisitor v)

visitThis

Overrides:

visitThis in class PollableElement

Parameters:

v - a PollableVisitor object.

setPollConfig

public void setPollConfig(PollableServiceConfig pollConfig)

setPollConfig

Parameters:

pollConfig - a PollableServiceConfig object.

poll

public PollStatus poll()

poll

Specified by:

poll in class PollableElement

Returns:

a PollStatus object.

getNetInterface

public NetworkInterface<InetAddress> getNetInterface()

getNetInterface

Specified by:

getNetInterface in interface MonitoredService

Returns:

a NetworkInterface object.

Throws:

UnknownHostException - if any.

getAddress

public InetAddress getAddress()

getAddress

Specified by:

getAddress in interface MonitoredService

Returns:

a InetAddress object.

doPoll

public PollStatus doPoll()

doPoll

Returns:

the top changed element whose status changes needs to be processed

createDownEvent

public Event createDownEvent(Date date)

createDownEvent

Specified by:

createDownEvent in class PollableElement

Parameters:

date - a Date object.

Returns:

a Event object.

createUpEvent

public Event createUpEvent(Date date)

createUpEvent

Specified by:

createUpEvent in class PollableElement

Parameters:

date - a Date object.

Returns:

a Event object.

createUnresponsiveEvent

public Event createUnresponsiveEvent(Date date)

createUnresponsiveEvent

Parameters:

date - a Date object.

Returns:

a Event object.

createResponsiveEvent

public Event createResponsiveEvent(Date date)

createResponsiveEvent

Parameters:

date - a Date object.

Returns:

a Event object.

createOutage

public void createOutage(PollEvent cause)

createOutage

Overrides:

createOutage in class PollableElement

Parameters:

cause - TODO

resolveOutage

protected void resolveOutage(PollEvent resolution)

resolveOutage

Overrides:

resolveOutage in class PollableElement

Parameters:

resolution - TODO

toString

public String toString()

toString

Overrides:

toString in class Object

Returns:

a String object.

processStatusChange

public void processStatusChange(Date date)

processStatusChange

Overrides:

processStatusChange in class PollableElement

Parameters:

date - a Date object.

updateStatus

public void updateStatus(PollStatus newStatus)

updateStatus

Overrides:

updateStatus in class PollableElement

Parameters:

newStatus - a PollStatus object.

setSchedule

public void setSchedule(Schedule schedule)

setSchedule

Parameters:

schedule - a Schedule object.

getSchedule

public Schedule getSchedule()

getSchedule

Returns:

a Schedule object.

getStatusChangeTime

public long getStatusChangeTime()

getStatusChangeTime

Returns:

a long.

isReady

public boolean isReady()

isReady

Specified by:

isReady in interface ReadyRunnable

Returns:

a boolean.

run

public void run()

run

Specified by:

run in interface Runnable

doRun

public PollStatus doRun()

doRun

Returns:

a PollStatus object.

delete

public void delete()

delete

Overrides:

delete in class PollableElement

schedule

public void schedule()

schedule

sendDeleteEvent

public void sendDeleteEvent()

sendDeleteEvent

refreshConfig

public void refreshConfig()

refreshConfig

refreshThresholds

public void refreshThresholds()

refreshThresholds

getSvcUrl

public String getSvcUrl()

Description copied from interface: MonitoredService

Returns a URL representation of the service to monitor and its parameters

Specified by:

getSvcUrl in interface MonitoredService