Class lucene_monitor

Description

A monitor class to check if Lucene is up and about

Located in /monitor-defs.php (line 621)

generic_monitor
   |
   --lucene_monitor
Variable Summary
 mixed $luhits
 mixed $luhost
 mixed $luport
 mixed $lusearch
Method Summary
 lucene_monitor lucene_monitor (string $lusearch, integer $luhits, [string $luhost = ""], [string $luport = ""])
 boolean check ()
Variables
mixed $luhits = 0 (line 629)

Expected no. of hits

mixed $luhost = "" (line 632)

Lucene host

mixed $luhost_abbrev = "" (line 638)

Lucene host abbreviation

mixed $luport = "" (line 635)

Lucene port

mixed $lusearch (line 626)

The lucene search object

Methods
Constructor lucene_monitor (line 650)

Define a new Lucene monitor object. We register the Lucene query to use and the number of hits we expect. You can also specify the hostname and port of the Lucene server here, although Axyl users can leave these out (blank) if they have configured them with setup-system.php.

lucene_monitor lucene_monitor (string $lusearch, integer $luhits, [string $luhost = ""], [string $luport = ""])
  • string $lusearch: Lucene search object, ready to execute
  • integer $luhits: No of results expected back from Lucene
  • string $luhost: Hostname of the Lucene server
  • string $luport: Port number of the Lucene server
check (line 671)

Make the check on Lucene by firing the query off and checking for the expected number of hits coming back.

  • return: True if Lucene delivered correct number of hits.
boolean check ()

Documentation generated by phpDocumentor 1.3.0RC3