org.opennms.netmgt.poller.pollables
Class PollableElement

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

Direct Known Subclasses:

PollableContainer, PollableService

public abstract class PollableElement
extends Object

Represents a PollableElement

Version:

$Id: $

Author:

Mathew Brozowski

Constructor Summary

protected

PollableElement(PollableContainer parent, Scope scope) Constructor for PollableElement.

Method Summary

abstract Event	createDownEvent(Date date) createDownEvent
protected void	createOutage(PollEvent cause) createOutage
abstract Event	createUpEvent(Date date) createUpEvent
void	delete() delete
protected PollEvent	doExtrapolateCause() doExtrapolateCause
protected void	doInheritParentalCause() doInheritParentalCause
PollStatus	doPoll(PollableElement elem) doPoll
PollEvent	extrapolateCause() extrapolateCause
PollEvent	getCause() getCause
abstract PollContext	getContext() getContext
PollableElement	getLockRoot() getLockRoot
PollableContainer	getParent() getParent
Scope	getScope() getScope
PollStatus	getStatus() getStatus
boolean	hasOpenOutage() hasOpenOutage
void	inheritParentalCause() inheritParentalCause
boolean	isDeleted() isDeleted
boolean	isStatusChanged() isStatusChanged
boolean	isTreeLockAvailable() isTreeLockAvailable
void	obtainTreeLock(long timeout) obtainTreeLock
abstract PollStatus	poll() poll
protected PollStatus	poll(PollableElement elem) poll
protected void	processCause(PollEvent cause) processCause
protected void	processComingUp(Date date) processComingUp
protected void	processGoingDown(Date date) processGoingDown
protected void	processLingeringCauses(PollEvent resolvedCause, PollEvent resolution) processLingeringCauses
protected void	processResolution(PollEvent cause, PollEvent resolution) processResolution
void	processStatusChange(Date date) processStatusChange
void	recalculateStatus() recalculateStatus
void	releaseTreeLock() releaseTreeLock
void	resetStatusChanged() resetStatusChanged
protected void	resolveAllOutages(PollEvent resolvedCause, PollEvent resolution) resolveAllOutages
protected void	resolveOutage(PollEvent resolution) resolveOutage
PollableElement	selectPollElement() selectPollElement
void	setCause(PollEvent cause) setCause
protected void	setParent(PollableContainer newParent) setParent
void	updateStatus(PollStatus newStatus) updateStatus
void	visit(PollableVisitor v) visit
protected void	visitThis(PollableVisitor v) visitThis
<T> T	withTreeLock(Callable<T> c) withTreeLock
<T> T	withTreeLock(Callable<T> c, long timeout) withTreeLock
void	withTreeLock(Runnable r) withTreeLock
void	withTreeLock(Runnable r, long timeout) withTreeLock

Methods inherited from class java.lang.Object

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

Constructor Detail

PollableElement

protected PollableElement(PollableContainer parent,
                          Scope scope)

Constructor for PollableElement.

Parameters:

parent - a PollableContainer object.

scope - a Scope object.

Method Detail

getParent

public PollableContainer getParent()

getParent

Returns:

a PollableContainer object.

setParent

protected void setParent(PollableContainer newParent)

setParent

Parameters:

newParent - a PollableContainer object.

getScope

public Scope getScope()

getScope

Returns:

a Scope object.

visit

public void visit(PollableVisitor v)

visit

Parameters:

v - a PollableVisitor object.

visitThis

protected void visitThis(PollableVisitor v)

visitThis

Parameters:

v - a PollableVisitor object.

getStatus

public PollStatus getStatus()

getStatus

Returns:

a PollStatus object.

isStatusChanged

public boolean isStatusChanged()

isStatusChanged

Returns:

a boolean.

updateStatus

public void updateStatus(PollStatus newStatus)

updateStatus

Parameters:

newStatus - a PollStatus object.

resetStatusChanged

public void resetStatusChanged()

resetStatusChanged

recalculateStatus

public void recalculateStatus()

recalculateStatus

getContext

public abstract PollContext getContext()

getContext

Returns:

a PollContext object.

doPoll

public PollStatus doPoll(PollableElement elem)

doPoll

Parameters:

elem - a PollableElement object.

Returns:

a PollStatus object.

getLockRoot

public PollableElement getLockRoot()

getLockRoot

Returns:

a PollableElement object.

isTreeLockAvailable

public boolean isTreeLockAvailable()

isTreeLockAvailable

Returns:

a boolean.

obtainTreeLock

public void obtainTreeLock(long timeout)

obtainTreeLock

Parameters:

timeout - a long.

releaseTreeLock

public void releaseTreeLock()

releaseTreeLock

withTreeLock

public void withTreeLock(Runnable r)

withTreeLock

Parameters:

r - a Runnable object.

withTreeLock

public <T> T withTreeLock(Callable<T> c)

withTreeLock

Type Parameters:

T - a T object.

Parameters:

c - a Callable object.

Returns:

a T object.

withTreeLock

public void withTreeLock(Runnable r,
                         long timeout)

withTreeLock

Parameters:

r - a Runnable object.

timeout - a long.

withTreeLock

public <T> T withTreeLock(Callable<T> c,
                          long timeout)

withTreeLock

Type Parameters:

T - a T object.

Parameters:

c - a Callable object.

timeout - a long.

Returns:

a T object.

poll

public abstract PollStatus poll()

poll

Returns:

a PollStatus object.

poll

protected PollStatus poll(PollableElement elem)

poll

Parameters:

elem - a PollableElement object.

Returns:

a PollStatus object.

selectPollElement

public PollableElement selectPollElement()

selectPollElement

Returns:

a PollableElement object.

createDownEvent

public abstract Event createDownEvent(Date date)

createDownEvent

Parameters:

date - a Date object.

Returns:

a Event object.

createUpEvent

public abstract Event createUpEvent(Date date)

createUpEvent

Parameters:

date - a Date object.

Returns:

a Event object.

createOutage

protected void createOutage(PollEvent cause)

createOutage

Parameters:

cause - TODO

resolveOutage

protected void resolveOutage(PollEvent resolution)

resolveOutage

Parameters:

resolution - TODO

hasOpenOutage

public boolean hasOpenOutage()

hasOpenOutage

Returns:

a boolean.

setCause

public void setCause(PollEvent cause)

setCause

Parameters:

cause - a PollEvent object.

getCause

public PollEvent getCause()

getCause

Returns:

a PollEvent object.

processStatusChange

public void processStatusChange(Date date)

processStatusChange

Parameters:

date - a Date object.

processComingUp

protected void processComingUp(Date date)

processComingUp

Parameters:

date - a Date object.

processResolution

protected void processResolution(PollEvent cause,
                                 PollEvent resolution)

processResolution

Parameters:

cause - a PollEvent object.

resolution - a PollEvent object.

processGoingDown

protected void processGoingDown(Date date)

processGoingDown

Parameters:

date - a Date object.

processCause

protected void processCause(PollEvent cause)

processCause

Parameters:

cause - a PollEvent object.

resolveAllOutages

protected void resolveAllOutages(PollEvent resolvedCause,
                                 PollEvent resolution)

resolveAllOutages

Parameters:

resolvedCause - a PollEvent object.

resolution - a PollEvent object.

isDeleted

public boolean isDeleted()

isDeleted

Returns:

a boolean.

delete

public void delete()

delete

processLingeringCauses

protected void processLingeringCauses(PollEvent resolvedCause,
                                      PollEvent resolution)

processLingeringCauses

Parameters:

resolvedCause - a PollEvent object.

resolution - a PollEvent object.

extrapolateCause

public PollEvent extrapolateCause()

extrapolateCause

Returns:

a PollEvent object.

doExtrapolateCause

protected PollEvent doExtrapolateCause()

doExtrapolateCause

Returns:

a PollEvent object.

inheritParentalCause

public void inheritParentalCause()

inheritParentalCause

doInheritParentalCause

protected void doInheritParentalCause()

doInheritParentalCause