org.opennms.netmgt.poller.pollables
Class PollableContainer

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

Direct Known Subclasses:

PollableInterface, PollableNetwork, PollableNode

public abstract class PollableContainer
extends PollableElement

Represents a PollableContainer

Version:

$Id: $

Author:

Mathew Brozowski

Nested Class Summary

protected class	PollableContainer.Accumulator<T>
protected static interface	PollableContainer.Iter
protected class	PollableContainer.SimpleIter<T>

Constructor Summary

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

Method Summary

protected void	addMember(PollableElement member) addMember
protected abstract Object	createMemberKey(PollableElement member) createMemberKey
void	delete() delete
void	deleteMember(PollableElement member) deleteMember
protected <T> T	deriveValueFromMembers(boolean withTreeLock, PollableContainer.SimpleIter<T> iter) deriveValueFromMembers
protected <T> T	deriveValueFromMembers(PollableContainer.SimpleIter<T> iter) deriveValueFromMembers
protected PollEvent	doExtrapolateCause() doExtrapolateCause
protected void	doInheritParentalCause() doInheritParentalCause
protected void	forEachMember(boolean withTreeLock, PollableContainer.Iter iter) forEachMember
protected void	forEachMember(PollableContainer.Iter iter) forEachMember
protected PollableElement	getMember(Object key) getMember
protected int	getMemberCount() getMemberCount
protected Collection<PollableElement>	getMembers() getMembers
PollStatus	getMemberStatus() getMemberStatus
PollStatus	poll() poll
protected PollStatus	poll(PollableElement elem) poll
PollStatus	pollRemainingMembers(PollableElement member) pollRemainingMembers
protected void	processCause(PollEvent cause) processCause
void	processMemberStatusChanges(Date date) processMemberStatusChanges
protected void	processResolution(PollEvent resolvedCause, PollEvent resolution) processResolution
void	processStatusChange(Date date) processStatusChange
void	recalculateStatus() recalculateStatus
void	removeMember(PollableElement member) removeMember
void	resetStatusChanged() resetStatusChanged
protected void	resolveAllOutages(PollEvent resolvedCause, PollEvent resolution) resolveAllOutages
PollableElement	selectPollElement() selectPollElement
void	visit(PollableVisitor v) visit
protected void	visitMembers(PollableVisitor v) visitMembers
protected void	visitThis(PollableVisitor v) visitThis

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

createDownEvent, createOutage, createUpEvent, doPoll, extrapolateCause, getCause, getContext, getLockRoot, getParent, getScope, getStatus, hasOpenOutage, inheritParentalCause, isDeleted, isStatusChanged, isTreeLockAvailable, obtainTreeLock, processComingUp, processGoingDown, processLingeringCauses, releaseTreeLock, resolveOutage, setCause, setParent, updateStatus, withTreeLock, withTreeLock, withTreeLock, withTreeLock

Methods inherited from class java.lang.Object

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

Constructor Detail

PollableContainer

public PollableContainer(PollableContainer parent,
                         Scope scope)

Constructor for PollableContainer.

Parameters:

parent - a PollableContainer object.

scope - a Scope object.

Method Detail

getMember

protected PollableElement getMember(Object key)

getMember

Parameters:

key - a Object object.

Returns:

a PollableElement object.

getMemberCount

protected int getMemberCount()

getMemberCount

Returns:

a int.

getMembers

protected Collection<PollableElement> getMembers()

getMembers

Returns:

a Collection object.

createMemberKey

protected abstract Object createMemberKey(PollableElement member)

createMemberKey

Parameters:

member - a PollableElement object.

Returns:

a Object object.

addMember

protected void addMember(PollableElement member)

addMember

Parameters:

member - a PollableElement object.

removeMember

public void removeMember(PollableElement member)

removeMember

Parameters:

member - a PollableElement object.

deleteMember

public void deleteMember(PollableElement member)

deleteMember

Parameters:

member - a PollableElement object.

delete

public void delete()

delete

Overrides:

delete in class PollableElement

visit

public void visit(PollableVisitor v)

visit

Overrides:

visit in class PollableElement

Parameters:

v - a PollableVisitor object.

visitThis

protected void visitThis(PollableVisitor v)

visitThis

Overrides:

visitThis in class PollableElement

Parameters:

v - a PollableVisitor object.

visitMembers

protected void visitMembers(PollableVisitor v)

visitMembers

Parameters:

v - a PollableVisitor object.

forEachMember

protected void forEachMember(PollableContainer.Iter iter)

forEachMember

Parameters:

iter - a PollableContainer.Iter object.

deriveValueFromMembers

protected <T> T deriveValueFromMembers(PollableContainer.SimpleIter<T> iter)

deriveValueFromMembers

Type Parameters:

T - a T object.

Parameters:

iter - a PollableContainer.SimpleIter object.

Returns:

a T object.

deriveValueFromMembers

protected <T> T deriveValueFromMembers(boolean withTreeLock,
                                       PollableContainer.SimpleIter<T> iter)

deriveValueFromMembers

Type Parameters:

T - a T object.

Parameters:

withTreeLock - a boolean.

iter - a PollableContainer.SimpleIter object.

Returns:

a T object.

forEachMember

protected void forEachMember(boolean withTreeLock,
                             PollableContainer.Iter iter)

forEachMember

Parameters:

withTreeLock - a boolean.

iter - a PollableContainer.Iter object.

recalculateStatus

public void recalculateStatus()

recalculateStatus

Overrides:

recalculateStatus in class PollableElement

resetStatusChanged

public void resetStatusChanged()

resetStatusChanged

Overrides:

resetStatusChanged in class PollableElement

poll

protected PollStatus poll(PollableElement elem)

poll

Overrides:

poll in class PollableElement

Parameters:

elem - a PollableElement object.

Returns:

a PollStatus object.

pollRemainingMembers

public PollStatus pollRemainingMembers(PollableElement member)

pollRemainingMembers

Parameters:

member - a PollableElement object.

Returns:

a PollStatus object.

getMemberStatus

public PollStatus getMemberStatus()

getMemberStatus

Returns:

a PollStatus object.

poll

public PollStatus poll()

poll

Specified by:

poll in class PollableElement

Returns:

a PollStatus object.

selectPollElement

public PollableElement selectPollElement()

selectPollElement

Overrides:

selectPollElement in class PollableElement

Returns:

a PollableElement object.

processStatusChange

public void processStatusChange(Date date)

processStatusChange

Overrides:

processStatusChange in class PollableElement

Parameters:

date - a Date object.

processMemberStatusChanges

public void processMemberStatusChanges(Date date)

processMemberStatusChanges

Parameters:

date - a Date object.

processResolution

protected void processResolution(PollEvent resolvedCause,
                                 PollEvent resolution)

processResolution

Overrides:

processResolution in class PollableElement

Parameters:

resolvedCause - a PollEvent object.

resolution - a PollEvent object.

processCause

protected void processCause(PollEvent cause)

processCause

Overrides:

processCause in class PollableElement

Parameters:

cause - a PollEvent object.

resolveAllOutages

protected void resolveAllOutages(PollEvent resolvedCause,
                                 PollEvent resolution)

resolveAllOutages

Overrides:

resolveAllOutages in class PollableElement

Parameters:

resolvedCause - a PollEvent object.

resolution - a PollEvent object.

doExtrapolateCause

protected PollEvent doExtrapolateCause()

doExtrapolateCause

Overrides:

doExtrapolateCause in class PollableElement

Returns:

a PollEvent object.

doInheritParentalCause

protected void doInheritParentalCause()

doInheritParentalCause

Overrides:

doInheritParentalCause in class PollableElement