Package org.opennms.netmgt.dao.api

Interface AckdConfigurationDao

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Boolean acknowledgmentMatch​(java.util.List<java.lang.String> messageText)
      Utility method for determining if a reply email should acknowledge an acknowledgable
      java.lang.Boolean clearMatch​(java.util.List<java.lang.String> messageText)
      Utility method for determining if a reply email should clear an acknowledgable
      java.lang.Boolean escalationMatch​(java.util.List<java.lang.String> messageText)
      Utility method for determining if a reply email should escalate an acknowledgable
      AckdConfiguration getConfig()
      getConfig
      int getEnabledReaderCount()  
      java.util.List<Parameter> getParametersForReader​(java.lang.String name)
      getParametersForReader
      Reader getReader​(java.lang.String readerName)
      Utility method to retrieve a readers configuration by name.
      ReaderSchedule getReaderSchedule​(java.lang.String readerName)
      Utility method to retrieve a schedule defined for a reader.
      boolean isReaderEnabled​(java.lang.String readerName)
      Utility method that determines if a named reader's configuration is enabled.
      void reloadConfiguration()
      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.
      java.lang.Boolean unAcknowledgmentMatch​(java.util.List<java.lang.String> messageText)
      Utility method for determining if a reply email should unacknoweledge an acknowledgable

    • Method Detail

      • acknowledgmentMatch

        java.lang.Boolean acknowledgmentMatch​(java.util.List<java.lang.String> messageText)
        Utility method for determining if a reply email should acknowledge an acknowledgable
        Parameters:
        messageText - a List object.
        Returns:
        Boolean

      • clearMatch

        java.lang.Boolean clearMatch​(java.util.List<java.lang.String> messageText)
        Utility method for determining if a reply email should clear an acknowledgable
        Parameters:
        messageText - a List object.
        Returns:
        Boolean

      • escalationMatch

        java.lang.Boolean escalationMatch​(java.util.List<java.lang.String> messageText)
        Utility method for determining if a reply email should escalate an acknowledgable
        Parameters:
        messageText - a List object.
        Returns:
        Boolean

      • unAcknowledgmentMatch

        java.lang.Boolean unAcknowledgmentMatch​(java.util.List<java.lang.String> messageText)
        Utility method for determining if a reply email should unacknoweledge an acknowledgable
        Parameters:
        messageText - a List object.
        Returns:
        Boolean

      • getReaderSchedule

        ReaderSchedule getReaderSchedule​(java.lang.String readerName)
        Utility method to retrieve a schedule defined for a reader. Each AckdReader requires that a name property is defined and the configuration uses that name to retrieve configuration details for that named reader.
        Parameters:
        readerName - a String object.
        Returns:
        a ReaderSchedule

      • getReader

        Reader getReader​(java.lang.String readerName)
        Utility method to retrieve a readers configuration by name. Each AckdReader requires that a name property is defined and the configuration uses that name to retrieve configuration details for that named reader.
        Parameters:
        readerName - a String object.
        Returns:
        a Reader configuration

      • isReaderEnabled

        boolean isReaderEnabled​(java.lang.String readerName)
        Utility method that determines if a named reader's configuration is enabled. Each AckdReader requires that a name property is defined and the configuration uses that name to retrieve configuration details for that named reader.
        Parameters:
        readerName - a String object.
        Returns:
        a boolean.

      • reloadConfiguration

        void reloadConfiguration()
                  throws org.springframework.dao.DataAccessResourceFailureException
        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. 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()

      • getParametersForReader

        java.util.List<Parameter> getParametersForReader​(java.lang.String name)

        getParametersForReader

        Parameters:
        name - a String object.
        Returns:
        a List object.