Package org.opennms.netmgt.dao.api
Interface AckdConfigurationDao
-
- All Known Implementing Classes:
DefaultAckdConfigurationDao
public interface AckdConfigurationDaoDAO interface for Ackd configuration- Version:
- $Id: $
- Author:
- David Hustace
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description BooleanacknowledgmentMatch(List<String> messageText)Utility method for determining if a reply email should acknowledge an acknowledgableBooleanclearMatch(List<String> messageText)Utility method for determining if a reply email should clear an acknowledgableBooleanescalationMatch(List<String> messageText)Utility method for determining if a reply email should escalate an acknowledgableAckdConfigurationgetConfig()getConfigintgetEnabledReaderCount()List<Parameter>getParametersForReader(String name)getParametersForReaderReadergetReader(String readerName)Utility method to retrieve a readers configuration by name.ReaderSchedulegetReaderSchedule(String readerName)Utility method to retrieve a schedule defined for a reader.booleanisReaderEnabled(String readerName)Utility method that determines if a named reader's configuration is enabled.voidreloadConfiguration()The underlying JAXB based DAO abstraction in the default implementation doesn't provide access to the container so this method is defined so that access to the container doesn't have to be exposed and a reload can still be controlled by the user.BooleanunAcknowledgmentMatch(List<String> messageText)Utility method for determining if a reply email should unacknoweledge an acknowledgable
-
-
-
Method Detail
-
getConfig
AckdConfiguration getConfig()
getConfig
- Returns:
- a
AckdConfigurationobject.
-
acknowledgmentMatch
Boolean acknowledgmentMatch(List<String> messageText)
Utility method for determining if a reply email should acknowledge an acknowledgable- Parameters:
messageText- aListobject.- Returns:
- Boolean
-
clearMatch
Boolean clearMatch(List<String> messageText)
Utility method for determining if a reply email should clear an acknowledgable- Parameters:
messageText- aListobject.- Returns:
- Boolean
-
escalationMatch
Boolean escalationMatch(List<String> messageText)
Utility method for determining if a reply email should escalate an acknowledgable- Parameters:
messageText- aListobject.- Returns:
- Boolean
-
unAcknowledgmentMatch
Boolean unAcknowledgmentMatch(List<String> messageText)
Utility method for determining if a reply email should unacknoweledge an acknowledgable- Parameters:
messageText- aListobject.- Returns:
- Boolean
-
getReaderSchedule
ReaderSchedule getReaderSchedule(String readerName)
Utility method to retrieve a schedule defined for a reader. EachAckdReaderrequires that a name property is defined and the configuration uses that name to retrieve configuration details for that named reader.- Parameters:
readerName- aStringobject.- Returns:
- a ReaderSchedule
-
getReader
Reader getReader(String readerName)
Utility method to retrieve a readers configuration by name. EachAckdReaderrequires that a name property is defined and the configuration uses that name to retrieve configuration details for that named reader.- Parameters:
readerName- aStringobject.- Returns:
- a Reader configuration
-
isReaderEnabled
boolean isReaderEnabled(String readerName)
Utility method that determines if a named reader's configuration is enabled. EachAckdReaderrequires that a name property is defined and the configuration uses that name to retrieve configuration details for that named reader.- Parameters:
readerName- aStringobject.- Returns:
- a boolean.
-
reloadConfiguration
void reloadConfiguration() throws org.springframework.dao.DataAccessResourceFailureExceptionThe underlying JAXB based DAO abstraction in the default implementation doesn't provide access to the container so this method is defined so that access to the container doesn't have to be exposed and a reload can still be controlled by the user. Automatically reading in new values if the file changes is a different use case from expecting the services to alter their state based on a configuration change. This method will most likely be used with event processing and possibly in the ReST API.- Throws:
org.springframework.dao.DataAccessResourceFailureException- if any.
-
getEnabledReaderCount
int getEnabledReaderCount()
-
-