PollableElement (OpenNMS 2021.1.1 API)

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

Constructors
Modifier Constructor and Description

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

Constructors
Modifier	Constructor and Description
`protected`	`PollableElement(PollableContainer parent, Scope scope)` Constructor for PollableElement.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`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
`protected PollableElement`	`getLockRoot()` getLockRoot
`PollableContainer`	`getParent()` getParent
`Scope`	`getScope()` getScope
`PollStatus`	`getStatus()` getStatus
`boolean`	`hasOpenOutage()` hasOpenOutage
`void`	`inheritParentalCause()` inheritParentalCause
`boolean`	`isDeleted()` isDeleted
`boolean`	`isStatusChanged()` isStatusChanged
`protected void`	`obtainTreeLock()` obtainTreeLock
`protected 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
`protected 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
`protected <T> T`	`withTreeLock(Callable<T> c)` withTreeLock
`protected <T> T`	`withTreeLock(Callable<T> c, long timeout)` withTreeLock
`void`	`withTreeLock(Runnable r)` withTreeLock
`protected 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:
    
    elemvrendmunalv02 - a PollableElement object.
    
    Returns:
    
    a PollStatus object.
  - getLockRoot
```
protected PollableElement getLockRoot()
```
    getLockRoot
    
    Returns:
    
    a PollableElement object.
  - obtainTreeLock
```
protected void obtainTreeLock()
```
    obtainTreeLock
  - obtainTreeLock
```
protected void obtainTreeLock(long timeout)
                       throws LockUnavailable
```
    obtainTreeLock
    
    Parameters:
    
    timeout - Lock timeout in milliseconds
    
    Throws:
    
    LockUnavailable
  - releaseTreeLock
```
protected void releaseTreeLock()
```
    releaseTreeLock
  - withTreeLock
```
public final void withTreeLock(Runnable r)
```
    withTreeLock
    
    Parameters:
    
    r - a Runnable object.
  - withTreeLock
```
protected final <T> T withTreeLock(Callable<T> c)
```
    withTreeLock
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    c - a Callable object.
    
    Returns:
    
    a T object.
  - withTreeLock
```
protected final void withTreeLock(Runnable r,
                                  long timeout)
                           throws LockUnavailable
```
    withTreeLock
    
    Parameters:
    
    r - a Runnable object.
    
    timeout - Lock timeout in milliseconds
    
    Throws:
    
    LockUnavailable
  - withTreeLock
```
protected final <T> T withTreeLock(Callable<T> c,
                                   long timeout)
                            throws LockUnavailable
```
    withTreeLock
    
    Type Parameters:
    
    T - a T object.
    
    Parameters:
    
    c - a Callable object.
    
    timeout - Lock timeout in milliseconds
    
    Returns:
    
    a T object.
    
    Throws:
    
    LockUnavailable
  - poll
```
public abstract PollStatus poll()
```
    poll
    
    Returns:
    
    a PollStatus object.
  - poll
```
protected PollStatus poll(PollableElement elem)
```
    poll
    
    Parameters:
    
    elemvrendmunalv02 - 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

Class PollableElement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PollableElement

Method Detail

getParent

setParent

getScope

visit

visitThis

getStatus

isStatusChanged

updateStatus

resetStatusChanged

recalculateStatus

getContext

doPoll

getLockRoot

obtainTreeLock

obtainTreeLock

releaseTreeLock

withTreeLock

withTreeLock

withTreeLock

withTreeLock

poll

poll

selectPollElement

createDownEvent

createUpEvent

createOutage

resolveOutage

hasOpenOutage

setCause

getCause

processStatusChange

processComingUp

processResolution

processGoingDown

processCause

resolveAllOutages

isDeleted

delete

processLingeringCauses

extrapolateCause

doExtrapolateCause

inheritParentalCause

doInheritParentalCause