fail2ban.server.filterpoll module
*********************************

class fail2ban.server.filterpoll.FilterPoll(jail)

   Bases: "fail2ban.server.filter.FileFilter"

   Attributes:
      "daemon"
         A boolean value indicating whether this thread is a daemon
         thread.

      "ident"
         Thread identifier of this thread or None if it has not been
         started.

      **ignoreCache**
      **ignoreCommand**
      **ignoreSelf**
      **jailName**
      **mlfidCache**
      "name"
         A string used for identification purposes only.

      **prefRegex**
   -[ Methods ]-

   +------------+--------------------------------------------------------------------------------------------+
   | "addAttem  | Generate a failed attempt for ip                                                           |
   | pt"(self,  |                                                                                            |
   | ip,        |                                                                                            |
   | \*matches) |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "clearAll  | Clear all lists/dicts parameters (used by reloading)                                       |
   | Params"(s  |                                                                                            |
   | elf)       |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "getModif  |                                                                                            |
   | ied"(self, |                                                                                            |
   | modlst)    |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "isAlive"  | Return whether the thread is alive.                                                        |
   | (self)     |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "is_alive  | Return whether the thread is alive.                                                        |
   | "(self)    |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "join"(se  | Safer join, that could be called also for not started (or ended) threads (used for         |
   | lf)        | cleanup).                                                                                  |
   +------------+--------------------------------------------------------------------------------------------+
   | "performB  | Performs a ban for IPs (or given ip) that are reached maxretry of the jail.                |
   | an"(self[, |                                                                                            |
   | ip])       |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "processL  | Split the time portion from log msg and return findFailures on them                        |
   | ine"(self, |                                                                                            |
   | line[,     |                                                                                            |
   | date])     |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "processL  | Processes the line for failures and populates failManager                                  |
   | ineAndAdd  |                                                                                            |
   | "(self,    |                                                                                            |
   | line[,     |                                                                                            |
   | date])     |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "reload"(  | Begin or end of reloading resp.                                                            |
   | self[,     |                                                                                            |
   | begin])    |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "run"(sel  | Abstract - Called when thread starts, thread stops when returns.                           |
   | f)         |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "start"(s  | Sets active flag and starts thread.                                                        |
   | elf)       |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "status"(  | Status of Filter plus files being monitored.                                               |
   | self[,     |                                                                                            |
   | flavor])   |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "stop"(se  | Stop monitoring of log-file(s)                                                             |
   | lf)        |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+

   +---------------------+------------+
   | **addFailRegex**    |            |
   +---------------------+------------+
   | **addIgnoreIP**     |            |
   +---------------------+------------+
   | **addIgnoreRegex**  |            |
   +---------------------+------------+
   | **addLogPath**      |            |
   +---------------------+------------+
   | **commonError**     |            |
   +---------------------+------------+
   | **containsLogPath** |            |
   +---------------------+------------+
   | **delFailRegex**    |            |
   +---------------------+------------+
   | **delIgnoreIP**     |            |
   +---------------------+------------+
   | **delIgnoreRegex**  |            |
   +---------------------+------------+
   | **delLogPath**      |            |
   +---------------------+------------+
   | **findFailure**     |            |
   +---------------------+------------+
   | **getDatePattern**  |            |
   +---------------------+------------+
   | **getFailRegex**    |            |
   +---------------------+------------+
   | **getFailures**     |            |
   +---------------------+------------+
   | **getFindTime**     |            |
   +---------------------+------------+
   | **getIgnoreIP**     |            |
   +---------------------+------------+
   | **getIgnoreRegex**  |            |
   +---------------------+------------+
   | **getLog**          |            |
   +---------------------+------------+
   | **getLogCount**     |            |
   +---------------------+------------+
   | **getLogEncoding**  |            |
   +---------------------+------------+
   | **getLogPaths**     |            |
   +---------------------+------------+
   | **getLogTimeZone**  |            |
   +---------------------+------------+
   | **getLogs**         |            |
   +---------------------+------------+
   | **getMaxLines**     |            |
   +---------------------+------------+
   | **getMaxRetry**     |            |
   +---------------------+------------+
   | **getName**         |            |
   +---------------------+------------+
   | **getPendingPaths** |            |
   +---------------------+------------+
   | **getUseDns**       |            |
   +---------------------+------------+
   | **ignoreLine**      |            |
   +---------------------+------------+
   | **inIgnoreIPList**  |            |
   +---------------------+------------+
   | **isDaemon**        |            |
   +---------------------+------------+
   | **isModified**      |            |
   +---------------------+------------+
   | **logIgnoreIp**     |            |
   +---------------------+------------+
   | **seekToTime**      |            |
   +---------------------+------------+
   | **setDaemon**       |            |
   +---------------------+------------+
   | **setDatePattern**  |            |
   +---------------------+------------+
   | **setFindTime**     |            |
   +---------------------+------------+
   | **setLogEncoding**  |            |
   +---------------------+------------+
   | **setLogTimeZone**  |            |
   +---------------------+------------+
   | **setMaxLines**     |            |
   +---------------------+------------+
   | **setMaxRetry**     |            |
   +---------------------+------------+
   | **setName**         |            |
   +---------------------+------------+
   | **setUseDns**       |            |
   +---------------------+------------+

   addAttempt(self, ip, *matches)

      Generate a failed attempt for ip

   addFailRegex(self, value)

   addIgnoreIP(self, ipstr)

   addIgnoreRegex(self, value)

   addLogPath(self, path, tail=False, autoSeek=True)

   clearAllParams(self)

      Clear all lists/dicts parameters (used by reloading)

   commonError(self)

   containsLogPath(self, path)

   property daemon

      A boolean value indicating whether this thread is a daemon
      thread.

      This must be set before start() is called, otherwise
      RuntimeError is raised. Its initial value is inherited from the
      creating thread; the main thread is not a daemon thread and
      therefore all threads created in the main thread default to
      daemon = False.

      The entire Python program exits when only daemon threads are
      left.

   delFailRegex(self, index=None)

   delIgnoreIP(self, ip=None)

   delIgnoreRegex(self, index=None)

   delLogPath(self, path)

   findFailure(self, tupleLine, date=None)

   getDatePattern(self)

   getFailRegex(self)

   getFailures(self, filename)

   getFindTime(self)

   getIgnoreIP(self)

   getIgnoreRegex(self)

   getLog(self, path)

   getLogCount(self)

   getLogEncoding(self)

   getLogPaths(self)

   getLogTimeZone(self)

   getLogs(self)

   getMaxLines(self)

   getMaxRetry(self)

   getModified(self, modlst)

   getName(self)

   getPendingPaths(self)

   getUseDns(self)

   property ident

      Thread identifier of this thread or None if it has not been
      started.

      This is a nonzero integer. See the get_ident() function. Thread
      identifiers may be recycled when a thread exits and another
      thread is created. The identifier is available even after the
      thread has exited.

   property ignoreCache

   property ignoreCommand

   ignoreLine(self, tupleLines)

   property ignoreSelf

   inIgnoreIPList(self, ip, log_ignore=True)

   isAlive(self)

      Return whether the thread is alive.

      This method is deprecated, use is_alive() instead.

   isDaemon(self)

   isModified(self, filename)

   is_alive(self)

      Return whether the thread is alive.

      This method returns True just before the run() method starts
      until just after the run() method terminates. The module
      function enumerate() returns a list of all alive threads.

   property jailName

   join(self)

      Safer join, that could be called also for not started (or ended)
      threads (used for cleanup).

   logIgnoreIp(self, ip, log_ignore, ignore_source='unknown source')

   property mlfidCache

   property name

      A string used for identification purposes only.

      It has no semantics. Multiple threads may be given the same
      name. The initial name is set by the constructor.

   performBan(self, ip=None)

      Performs a ban for IPs (or given ip) that are reached maxretry
      of the jail.

   property prefRegex

   processLine(self, line, date=None)

      Split the time portion from log msg and return findFailures on
      them

   processLineAndAdd(self, line, date=None)

      Processes the line for failures and populates failManager

   reload(self, begin=True)

      Begin or end of reloading resp. refreshing of all parameters

   run(self)

      Abstract - Called when thread starts, thread stops when returns.

   seekToTime(self, container, date, accuracy=3)

   setDaemon(self, daemonic)

   setDatePattern(self, pattern)

   setFindTime(self, value)

   setLogEncoding(self, encoding)

   setLogTimeZone(self, tz)

   setMaxLines(self, value)

   setMaxRetry(self, value)

   setName(self, name)

   setUseDns(self, value)

   start(self)

      Sets active flag and starts thread.

   status(self, flavor='basic')

      Status of Filter plus files being monitored.

   stop(self)

      Stop monitoring of log-file(s)
