Ackd (OpenNMS 16.0.1 API)

java.lang.Object
- org.opennms.netmgt.ackd.Ackd

All Implemented Interfaces:

SpringServiceDaemon, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean
```
public class Ackd
extends Object
implements SpringServiceDaemon, org.springframework.beans.factory.DisposableBean
```
Acknowledgment management Daemon

Author:

David Hustace, Jeff Gehlbach

Field Summary

Fields
Modifier and Type Field and Description

static String NAME
Constant NAME="Ackd"

Fields
Modifier and Type	Field and Description
`static String`	`NAME` Constant `NAME="Ackd"`

Constructor Summary

Constructors
Constructor and Description

Ackd()

Constructors
Constructor and Description
`Ackd()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()` afterPropertiesSet
`void`	`destroy()` destroy
`AcknowledgmentDao`	`getAcknowledgmentDao()`
`protected List<AckReader>`	`getAckReaders()` getAckReaders
`AckdConfigurationDao`	`getConfigDao()` getConfigDao
`EventForwarder`	`getEventForwarder()` getEventForwarder
`ScheduledThreadPoolExecutor`	`getExecutor()` getExecutor
`String`	`getName()` getName
`void`	`handleAckEvent(Event event)` Handles the event driven access to acknowledging `OnmsAcknowledgable`s.
`void`	`handleReloadConfigEvent(Event event)` handleReloadConfigEvent
`protected void`	`pauseReaders()` pauseReaders
`protected void`	`restartReaders(boolean reloadConfigs)` restartReaders
`protected void`	`resumeReaders()` resumeReaders
`void`	`setAcknowledgmentDao(AcknowledgmentDao ackDao)`
`void`	`setAckReaders(List<AckReader> ackReaders)` setAckReaders
`void`	`setConfigDao(AckdConfigurationDao config)` setConfigDao
`void`	`setEventForwarder(EventForwarder eventForwarder)` setEventForwarder
`void`	`setExecutor(ScheduledThreadPoolExecutor executor)` setExecutor
`void`	`start()` start
`protected void`	`startReaders()` Starts the AckReaders without indicating a reload of their configuration is necessary.
`protected void`	`startReaders(boolean reloadConfig)` Starts the AckReaders indicating a reload of their configuration is necessary.
`protected void`	`stopReaders()` stopReaders

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final String NAME
```
    Constant NAME="Ackd"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Ackd
```
public Ackd()
```
- Method Detail
  - start
```
public void start()
```
    start
    
    Specified by:
    
    start in interface SpringServiceDaemon
  - destroy
```
public void destroy()
```
    destroy
    
    Specified by:
    
    destroy in interface org.springframework.beans.factory.DisposableBean
  - startReaders
```
protected void startReaders()
```
    Starts the AckReaders without indicating a reload of their configuration is necessary.
  - startReaders
```
protected void startReaders(boolean reloadConfig)
```
    Starts the AckReaders indicating a reload of their configuration is necessary.
    
    Parameters:
    
    reloadConfig - a boolean.
  - stopReaders
```
protected void stopReaders()
```
    stopReaders
  - pauseReaders
```
protected void pauseReaders()
```
    pauseReaders
  - resumeReaders
```
protected void resumeReaders()
```
    resumeReaders
  - restartReaders
```
protected void restartReaders(boolean reloadConfigs)
```
    restartReaders
    
    Parameters:
    
    reloadConfigs - a boolean.
  - handleAckEvent
```
public void handleAckEvent(Event event)
```
    Handles the event driven access to acknowledging OnmsAcknowledgables. The acknowledgment event contains 4 parameters: ackUser: The user acknowledging the OnmsAcknowledgable ackAction: ack, unack, esc, clear ackType: AckTypeOnmsAlarm, OnmsNotification, etc. refId: The ID of the OnmsAcknowledgable
    
    Parameters:
    
    event - a Event object.
  - handleReloadConfigEvent
```
public void handleReloadConfigEvent(Event event)
```
    handleReloadConfigEvent
    
    Parameters:
    
    event - a Event object.
  - setExecutor
```
public void setExecutor(ScheduledThreadPoolExecutor executor)
```
    setExecutor
    
    Parameters:
    
    executor - a ScheduledThreadPoolExecutor object.
  - getExecutor
```
public ScheduledThreadPoolExecutor getExecutor()
```
    getExecutor
    
    Returns:
    
    a ScheduledThreadPoolExecutor object.
  - getEventForwarder
```
public EventForwarder getEventForwarder()
```
    getEventForwarder
    
    Returns:
    
    a EventForwarder object.
  - setEventForwarder
```
public void setEventForwarder(EventForwarder eventForwarder)
```
    setEventForwarder
    
    Parameters:
    
    eventForwarder - a EventForwarder object.
  - getAckReaders
```
protected List<AckReader> getAckReaders()
```
    getAckReaders
    
    Returns:
    
    a List object.
  - setAckReaders
```
public void setAckReaders(List<AckReader> ackReaders)
```
    setAckReaders
    
    Parameters:
    
    ackReaders - a List object.
  - getAcknowledgmentDao
```
public AcknowledgmentDao getAcknowledgmentDao()
```
    Returns:
    
    a AcknowledgmentDao object.
  - setAcknowledgmentDao
```
public void setAcknowledgmentDao(AcknowledgmentDao ackDao)
```
    Parameters:
    
    ackDao - a AcknowledgmentDao object.
  - getConfigDao
```
public AckdConfigurationDao getConfigDao()
```
    getConfigDao
    
    Returns:
    
    a AckdConfigurationDao object.
  - setConfigDao
```
public void setConfigDao(AckdConfigurationDao config)
```
    setConfigDao
    
    Parameters:
    
    config - a AckdConfigurationDao object.
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    afterPropertiesSet
    
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    Exception - if any.
  - getName
```
public String getName()
```
    getName
    
    Returns:
    
    a String object.

Class Ackd

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME

Constructor Detail

Ackd

Method Detail

start

destroy

startReaders

startReaders

stopReaders

pauseReaders

resumeReaders

restartReaders

handleAckEvent

handleReloadConfigEvent

setExecutor

getExecutor

getEventForwarder

setEventForwarder

getAckReaders

setAckReaders

getAcknowledgmentDao

setAcknowledgmentDao

getConfigDao

setConfigDao

afterPropertiesSet

getName