Package org.opennms.netmgt.poller.pollables

Class PollableNetwork

java.lang.Object

org.opennms.netmgt.poller.pollables.PollableElement

org.opennms.netmgt.poller.pollables.PollableContainer

org.opennms.netmgt.poller.pollables.PollableNetwork

public class PollableNetwork
extends PollableContainer

Represents a PollableNetwork

Author:

Mathew Brozowski

Nested Class Summary

Nested classes/interfaces inherited from class org.opennms.netmgt.poller.pollables.PollableContainer

PollableContainer.Accumulator<T>, PollableContainer.Iter, PollableContainer.SimpleIter<T>

Constructor Summary

Constructors

Constructor	Description
PollableNetwork(PollContext context)	Constructor for PollableNetwork.

Method Summary

Modifier and Type	Method	Description
Event	createDownEvent(java.util.Date date)	createDownEvent
PollableInterface	createInterface(int nodeId, java.lang.String nodeLabel, java.lang.String nodeLocation, java.net.InetAddress addr)	createInterface
protected java.lang.Object	createMemberKey(PollableElement member)	createMemberKey
PollableNode	createNode(int nodeId, java.lang.String nodeLabel, java.lang.String nodeLocation)	createNode
PollableNode	createNodeIfNecessary(int nodeId, java.lang.String nodeLabel, java.lang.String nodeLocation)	createNodeIfNecessary
PollableService	createService(int nodeId, java.lang.String nodeLabel, java.lang.String nodeLocation, java.net.InetAddress addr, java.lang.String svcName)	createService
Event	createUpEvent(java.util.Date date)	createUpEvent
void	delete()	delete
void	dump()	dump
PollEvent	extrapolateCause()	extrapolateCause
PollContext	getContext()	getContext
PollableInterface	getInterface(int nodeId, java.net.InetAddress addr)	getInterface
protected PollableElement	getLockRoot()	getLockRoot
PollableNode	getNode(int nodeId)	getNode
int	getNodeCount()	getNodeCount
java.util.List<java.lang.Long>	getNodeIds()
PollableService	getService(int nodeId, java.net.InetAddress addr, java.lang.String svcName)	getService
protected void	obtainTreeLock()	obtainTreeLock
protected void	obtainTreeLock(long timeout)	obtainTreeLock
PollStatus	poll(PollableElement elem)	poll
PollStatus	pollRemainingMembers(PollableElement member)	pollRemainingMembers
void	processStatusChange(java.util.Date date)	processStatusChange
void	propagateInitialCause()	propagateInitialCause
void	recalculateStatus()	recalculateStatus
protected void	releaseTreeLock()	releaseTreeLock
void	resetStatusChanged()	resetStatusChanged
protected void	visitThis(PollableVisitor v)	visitThis

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

addMember, deleteMember, deriveValueFromMembers, deriveValueFromMembers, doExtrapolateCause, doInheritParentalCause, forEachMember, forEachMember, getMember, getMemberCount, getMembers, getMemberStatus, poll, processCause, processMemberStatusChanges, processResolution, removeMember, resolveAllOutages, selectPollElement, visit, visitMembers

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

createOutage, doPoll, getCause, getParent, getScope, getStatus, hasOpenOutage, inheritParentalCause, isDeleted, isStatusChanged, processComingUp, processGoingDown, processLingeringCauses, 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

PollableNetwork

public PollableNetwork(PollContext context)

Constructor for PollableNetwork.

Parameters:

context - a PollContext object.

Method Detail

getContext

public PollContext getContext()

getContext

Specified by:

getContext in class PollableElement

Returns:

a PollContext object.

createNode

public PollableNode createNode(int nodeId,
                               java.lang.String nodeLabel,
                               java.lang.String nodeLocation)

createNode

Parameters:

nodeId - a int.

nodeLabel - a String object.

nodeLocation - a String object.

Returns:

a PollableNode object.

createNodeIfNecessary

public PollableNode createNodeIfNecessary(int nodeId,
                                          java.lang.String nodeLabel,
                                          java.lang.String nodeLocation)

createNodeIfNecessary

Parameters:

nodeId - a int.

nodeLabel - a String object.

nodeLocation - a String object.

Returns:

a PollableNode object.

getNode

public PollableNode getNode(int nodeId)

getNode

Parameters:

nodeId - a int.

Returns:

a PollableNode object.

getNodeIds

public java.util.List<java.lang.Long> getNodeIds()

getNodeCount

public int getNodeCount()

getNodeCount

Returns:

a int.

createInterface

public PollableInterface createInterface(int nodeId,
                                         java.lang.String nodeLabel,
                                         java.lang.String nodeLocation,
                                         java.net.InetAddress addr)

createInterface

Parameters:

nodeId - a int.

nodeLabel - a String object.

nodeLocation - a String object.

addr - a InetAddress object.

Returns:

a PollableInterface object.

getInterface

public PollableInterface getInterface(int nodeId,
                                      java.net.InetAddress addr)

getInterface

Parameters:

nodeId - a int.

addr - a InetAddress object.

Returns:

a PollableInterface object.

createService

public PollableService createService(int nodeId,
                                     java.lang.String nodeLabel,
                                     java.lang.String nodeLocation,
                                     java.net.InetAddress addr,
                                     java.lang.String svcName)

createService

Parameters:

nodeId - a int.

nodeLabel - a String object.

nodeLocation - a String object.

addr - a InetAddress object.

svcName - a String object.

Returns:

a PollableService object.

getService

public PollableService getService(int nodeId,
                                  java.net.InetAddress addr,
                                  java.lang.String svcName)

getService

Parameters:

nodeId - a int.

addr - a InetAddress object.

svcName - a String object.

Returns:

a PollableService object.

createMemberKey

protected java.lang.Object createMemberKey(PollableElement member)

createMemberKey

Specified by:

createMemberKey in class PollableContainer

Parameters:

member - a PollableElement object.

Returns:

a Object object.

visitThis

protected void visitThis(PollableVisitor v)

visitThis

Overrides:

visitThis in class PollableContainer

Parameters:

v - a PollableVisitor object.

pollRemainingMembers

public PollStatus pollRemainingMembers(PollableElement member)

pollRemainingMembers

Overrides:

pollRemainingMembers in class PollableContainer

Parameters:

member - a PollableElement object.

Returns:

a PollStatus object.

createDownEvent

public Event createDownEvent(java.util.Date date)

createDownEvent

Specified by:

createDownEvent in class PollableElement

Parameters:

date - a Date object.

Returns:

a Event object.

createUpEvent

public Event createUpEvent(java.util.Date date)

createUpEvent

Specified by:

createUpEvent in class PollableElement

Parameters:

date - a Date object.

Returns:

a Event object.

dump

public void dump()

dump

delete

public void delete()

delete

Overrides:

delete in class PollableContainer

poll

public PollStatus poll(PollableElement elem)

poll

Overrides:

poll in class PollableContainer

Returns:

a PollStatus object.

processStatusChange

public void processStatusChange(java.util.Date date)

processStatusChange

Overrides:

processStatusChange in class PollableContainer

Parameters:

date - a Date object.

recalculateStatus

public void recalculateStatus()

recalculateStatus

Overrides:

recalculateStatus in class PollableContainer

resetStatusChanged

public void resetStatusChanged()

resetStatusChanged

Overrides:

resetStatusChanged in class PollableContainer

getLockRoot

protected PollableElement getLockRoot()

getLockRoot

Overrides:

getLockRoot in class PollableElement

Returns:

a PollableElement object.

obtainTreeLock

protected void obtainTreeLock()

obtainTreeLock

Overrides:

obtainTreeLock in class PollableElement

obtainTreeLock

protected void obtainTreeLock(long timeout)

obtainTreeLock

Overrides:

obtainTreeLock in class PollableElement

Parameters:

timeout - Lock timeout in milliseconds

releaseTreeLock

protected void releaseTreeLock()

releaseTreeLock

Overrides:

releaseTreeLock in class PollableElement

extrapolateCause

public PollEvent extrapolateCause()

extrapolateCause

Overrides:

extrapolateCause in class PollableElement

Returns:

a PollEvent object.

propagateInitialCause

public void propagateInitialCause()

propagateInitialCause