README

FAE Utility Project

PROJECT DEPENDENCIES

The following libraries must be in the CLASSPATH:

* HTMLUnit version 2.13 (http://sourceforge.net/projects/htmlunit/)
* Apache Commons CLI 1.2 (http://commons.apache.org/cli/)

BUILD INFORMATION

* You can use the build script in the main project directory (i.e. trunk) to build the project:

  $ ./build

RUN INFORMATION

* You can use the run script in the main project directory (i.e. trunk) to run the project:

  $ . run -u http://msn.com/

* Examples of use of config file:

  $ ./run -c msn.properties

  $ ./run -c uiuc.properties

* The command line options are as follows:

 -a,--authorization <arg>                 Optional: filename of authorization information
 -browserVersion,--browserVersion <arg>   Optional: browserVersion to use; chrome, firefox (default), ie
 -c,--config <arg>                        Optional: filename of configuration parameters
 -D,--debug                               Optional: turn on debugging output
 -d,--depth <arg>                         Optional: maximium depth to traverse (number: 1 | 2 | 3, default = 1, which means no traversing)
 -e,--excludeDomains <arg>                Optional: do not traverse these domains (comma-separated list; valid only if -s is specified; each domain must be a subdomain of an entry in spanDomains)
 -i,--includeDomains <arg>                Optional: traverse these domains (comma-separated list) in addition to the domain specified by the URL
 -l,--evaluationLevels <arg>              Optional: Rule levels to include in the evaluation ('A' | 'A_AA', default='A_AA')
 -m,--multipleUrls <arg>                  Required (unless -u, --url is specified): filename containing URLs to evaluate
 -o,--outputDirectory <arg>               Required: directory for results files
 -r,--ruleset <arg>                       Optional: OAA ruleset ID ('ARIA_TRANS' | 'ARIA_STRICT', default = 'ARIA_TRANS')
 -s,--spanDomains <arg>                   Optional: traverse the subdomains of these domains (comma-separated list), in addition to the domain specified by the URL
 -scripts,--scripts <arg>                 Required: file with names of script files
 -testMode,--testMode                     Optional: testmode; will not find events or evaluate scripts
 -u,--url <arg>                           Required (unless -m, --multipleUrls is specified): starting URL
 -V,--verbose                             Optional: turn on HtmlUnit logging output
 -w,--wait <arg>                          Optional: maximium time in milliseconds to wait when processing a page, default = 30000 msec. (30 seconds)

* Notes:
  1. The --outputDirectory directory must not already exist.
  2. The --scripts and --multipleUrls files must have one filename or URL per line;
     blank lines are ignored.
  3. Lines in the --multipleUrls file that begin with # are considered comments and
     are ignored.
  4. When --debug is specified, all results are printed to the console and
     the --outputDirectory directory is not created.

SOURCE FILES

* org/fae/util/FaeUtil.java
* org/fae/util/URLProcessor.java
* org/fae/util/Controller.java
* org/fae/util/FileUtil.java

OTHER FILES

* README (this file)
* build
* run
* org/fae/util/classpath
* test/script1.js
* test/script2.js
* test/scripts.txt
* test/urls.txt