Create BSFDetector documenation

The BSF Detector lets you run arbitrary scripts using the Bean Scripting Framework to determine the availability of a service. This can be a script written in any of the languages supported by BSF, the only requirement is that the script returns the string "OK" if it passes.

For information on writing a BSF script for OpenNMS, see the BSF Monitor page.

Unlike the BSF Monitor, the BSF Detector only passes in the "map," "ip_addr," "svc_name," and "results" variables as beans to the script.


fileName
    The path to the file (on the OpenNMS server) which contains the BSF-compatible script to run.
langClass
    The short name of the language the script is written in.
    choices: javascript, beanshell, groovy, etc.
bsfEngine
    The BSF engine to use when running the script.
    choices: bsh.util.BeanShellBSFEngine, org.codehaus.groovy.bsf.GroovyEngine
fileExtensions
    A comma-separated list of file extensions to consider a valid script for this BSF instance.
runType
    Which way to run the BSF script.
    choices: eval (expects the script to print the OK/error status to), exec (expects the script to manipulate the provided results hashmap directly)