Package org.opennms.netmgt.config

Class SyslogdConfigFactory

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getBatchIntervalMs()
      Messages are aggregated in batches before being dispatched.
      int getBatchSize()
      Messages are aggregated in batches before being dispatched.
      java.lang.String getDiscardUei()
      getDiscardUei
      java.lang.String getForwardingRegexp()
      getForwardingRegexp
      java.util.List<HideMatch> getHideMessages()
      A collection of Strings we do not want to attach to the event.
      java.lang.String getListenAddress()
      getListenAddress
      java.lang.Integer getMatchingGroupHost()
      getMatchingGroupHost
      java.lang.Integer getMatchingGroupMessage()
      getMatchingGroupMessage
      boolean getNewSuspectOnMessage()
      Return whether or not a newSuspect event should be sent when a trap is received from an unknown IP address.
      int getNumThreads()
      Number of threads used for consuming/dispatching messages.
      java.lang.String getParser()
      getParser
      int getQueueSize()
      Maximum number of messages to keep in memory while waiting to be dispatched.
      int getSyslogPort()
      Return the port on which SNMP traps should be received.
      java.util.TimeZone getTimeZone()
      Optional: - if not null it will be used as default time zone if no time zone is given - if not set the system time zone will be used
      java.util.List<UeiMatch> getUeiList()
      A collection of Strings->UEI's
      void reload()
      Reload the config from the default config file
      boolean shouldIncludeRawSyslogmessage()
      Indicates whether or not to include the raw syslog message as an event parameter on events generated by Syslogd.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SyslogdConfigFactory

        public SyslogdConfigFactory()
                     throws java.io.IOException
        Private constructor
        Throws:
        java.io.IOException - Thrown if the specified config file cannot be read

      • SyslogdConfigFactory

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

        Constructor for SyslogdConfigFactory.

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

    • Method Detail

      • reload

        public void reload()
            throws java.io.IOException
        Reload the config from the default config file
        Specified by:
        reload in interface SyslogdConfig
        Throws:
        java.io.IOException - Thrown if the specified config file cannot be read/loaded

      • getSyslogPort

        public int getSyslogPort()
        Return the port on which SNMP traps should be received.
        Specified by:
        getSyslogPort in interface SyslogdConfig
        Returns:
        the port on which SNMP traps should be received

      • getListenAddress

        public java.lang.String getListenAddress()

        getListenAddress

        Specified by:
        getListenAddress in interface SyslogdConfig
        Returns:
        a String object.
        Since:
        1.8.1

      • getNewSuspectOnMessage

        public boolean getNewSuspectOnMessage()
        Return whether or not a newSuspect event should be sent when a trap is received from an unknown IP address.
        Specified by:
        getNewSuspectOnMessage in interface SyslogdConfig
        Returns:
        whether to generate newSuspect events on traps.

      • getForwardingRegexp

        public java.lang.String getForwardingRegexp()

        getForwardingRegexp

        Specified by:
        getForwardingRegexp in interface SyslogdConfig
        Returns:
        a String object.

      • getMatchingGroupHost

        public java.lang.Integer getMatchingGroupHost()

        getMatchingGroupHost

        Specified by:
        getMatchingGroupHost in interface SyslogdConfig
        Returns:
        a int.

      • getMatchingGroupMessage

        public java.lang.Integer getMatchingGroupMessage()

        getMatchingGroupMessage

        Specified by:
        getMatchingGroupMessage in interface SyslogdConfig
        Returns:
        a int.

      • getParser

        public java.lang.String getParser()

        getParser

        Specified by:
        getParser in interface SyslogdConfig
        Returns:
        the parser class to use when parsing syslog messages, as a string.

      • getDiscardUei

        public java.lang.String getDiscardUei()

        getDiscardUei

        Specified by:
        getDiscardUei in interface SyslogdConfig
        Returns:
        a String object.

      • getNumThreads

        public int getNumThreads()
        Description copied from interface: SyslogdConfig
        Number of threads used for consuming/dispatching messages.
        Specified by:
        getNumThreads in interface SyslogdConfig
        Returns:
        number of threads

      • getQueueSize

        public int getQueueSize()
        Description copied from interface: SyslogdConfig
        Maximum number of messages to keep in memory while waiting to be dispatched.
        Specified by:
        getQueueSize in interface SyslogdConfig
        Returns:
        queue size

      • getBatchSize

        public int getBatchSize()
        Description copied from interface: SyslogdConfig
        Messages are aggregated in batches before being dispatched. When the batch reaches this size, it will be dispatched.
        Specified by:
        getBatchSize in interface SyslogdConfig
        Returns:
        batch size

      • getBatchIntervalMs

        public int getBatchIntervalMs()
        Description copied from interface: SyslogdConfig
        Messages are aggregated in batches before being dispatched. When the batch has been created for longer than this interval it will be dispatched, regardless of the size.
        Specified by:
        getBatchIntervalMs in interface SyslogdConfig
        Returns:
        interval in ms

      • getTimeZone

        public java.util.TimeZone getTimeZone()
        Description copied from interface: SyslogdConfig
        Optional: - if not null it will be used as default time zone if no time zone is given - if not set the system time zone will be used
        Specified by:
        getTimeZone in interface SyslogdConfig

      • shouldIncludeRawSyslogmessage

        public boolean shouldIncludeRawSyslogmessage()
        Description copied from interface: SyslogdConfig
        Indicates whether or not to include the raw syslog message as an event parameter on events generated by Syslogd.

        Default behavior is false unless configured otherwise.

        Specified by:
        shouldIncludeRawSyslogmessage in interface SyslogdConfig
        Returns:
        whether or not to include the raw syslog message as an event parameter on events generated by Syslogd