Package org.opennms.netmgt.config

Class RTCConfigFactory

  • All Implemented Interfaces:
    org.springframework.beans.factory.InitializingBean
    public final class RTCConfigFactory
extends java.lang.Object
implements org.springframework.beans.factory.InitializingBean
    This is the singleton class used to load the configuration for the OpenNMS RTC from the rtc-configuration xml file. Note: Users of this class should make sure the init() is called before calling any other method to ensure the config is loaded before accessing other convenience methods.
    Author:
    Sowmya Nataraj , OpenNMS

    • Constructor Summary

      Constructors 
      Constructor Description
      RTCConfigFactory()
      Default constructor.
      RTCConfigFactory​(java.io.InputStream stream)
      Constructor for RTCConfigFactory.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void afterPropertiesSet()
      Load the config from the default config file and create the singleton instance of this factory.
      int getErrorsBeforeUrlUnsubscribe()
      Return the number of times posts are tried with errors before an URL is automatically unsubscribed.
      long getHighThresholdInterval()
      Return the high threshold interval at which data is to be resent.
      java.lang.String getHighThresholdIntervalStr()
      Return the high threshold interval at which data is to be resent.
      long getLowThresholdInterval()
      Return the low threshold interval at which data is to be resent.
      java.lang.String getLowThresholdIntervalStr()
      Return the low threshold interval at which data is to be resent.
      int getMaxEventsBeforeResend()
      Return the max number of events after which data is to resent.
      long getRollingWindow()
      Return the rolling window for which availability is to be computed.
      java.lang.String getRollingWindowStr()
      Return the rolling window for which availability is to be computed.
      int getSenders()
      Return the number of sender to be started.
      int getUpdaters()
      Return the number of updater threads to be started.
      long getUserRefreshInterval()
      Return the user refresh interval at which data is to be resent - this is the interval at which data is resent when no events are received.
      java.lang.String getUserRefreshIntervalStr()
      Return the user refresh interval at which data is to be resent - this is the interval at which data is resent when no events are received.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • RTCConfigFactory

        public RTCConfigFactory()
        Default constructor.

      • RTCConfigFactory

        public RTCConfigFactory​(java.io.InputStream stream)
                 throws java.io.IOException

        Constructor for RTCConfigFactory.

        Parameters:
        stream - a InputStream object.
        Throws:
        java.io.IOException - if any.

    • Method Detail

      • afterPropertiesSet

        public void afterPropertiesSet()
                        throws java.io.IOException
        Load the config from the default config file and create the singleton instance of this factory.
        Specified by:
        afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
        Throws:
        java.io.IOException - Thrown if the specified config file cannot be read/loaded
        java.io.IOException - if any.

      • getUpdaters

        public int getUpdaters()
        Return the number of updater threads to be started.
        Returns:
        the number of updater threads to be started

      • getSenders

        public int getSenders()
        Return the number of sender to be started.
        Returns:
        the number of sender threads to be started

      • getRollingWindowStr

        public java.lang.String getRollingWindowStr()
        Return the rolling window for which availability is to be computed.
        Returns:
        the rolling window for which availability is to be computed

      • getRollingWindow

        public long getRollingWindow()
        Return the rolling window for which availability is to be computed.
        Returns:
        the rolling window for which availability is to be computed

      • getMaxEventsBeforeResend

        public int getMaxEventsBeforeResend()
        Return the max number of events after which data is to resent.
        Returns:
        the max number of events after which data is to resent

      • getLowThresholdIntervalStr

        public java.lang.String getLowThresholdIntervalStr()
        Return the low threshold interval at which data is to be resent.
        Returns:
        the low threshold interval at which data is to be resent

      • getLowThresholdInterval

        public long getLowThresholdInterval()
        Return the low threshold interval at which data is to be resent.
        Returns:
        the low threshold interval at which data is to be resent

      • getHighThresholdIntervalStr

        public java.lang.String getHighThresholdIntervalStr()
        Return the high threshold interval at which data is to be resent.
        Returns:
        the high threshold interval at which data is to be resent

      • getHighThresholdInterval

        public long getHighThresholdInterval()
        Return the high threshold interval at which data is to be resent.
        Returns:
        the high threshold interval at which data is to be resent

      • getUserRefreshIntervalStr

        public java.lang.String getUserRefreshIntervalStr()
        Return the user refresh interval at which data is to be resent - this is the interval at which data is resent when no events are received.
        Returns:
        the user refresh interval at which data is to be resent

      • getUserRefreshInterval

        public long getUserRefreshInterval()
        Return the user refresh interval at which data is to be resent - this is the interval at which data is resent when no events are received.
        Returns:
        the user refresh interval at which data is to be resent

      • getErrorsBeforeUrlUnsubscribe

        public int getErrorsBeforeUrlUnsubscribe()
        Return the number of times posts are tried with errors before an URL is automatically unsubscribed. A negative value means URL is never unsubscribed
        Returns:
        the number of times posts are tried with errors before an URL is automatically unsubscribed