JRat Configuration

The Configuration File

JRat loads its configuration from a file named jrat.xml in the current directory of your application. This file contains system-wide configuration parameters, and also JRat handlers to be configured and assigned to sets of classes and methods.

The Default File

If JRat starts up and can't find it's configuration file, it will create one. The default file provides sensible defaults and provides a good sample for new users.

The XML Format

A Simple Example

The following is is a very simple configuration file.

<?xml version="1.0" encoding="UTF-8"?>
<jrat>
    <settings>
        <property name="httpServerEnabled" value="true"/>
    </settings>

    <profile name="my code">

        <criteria>
            <include/>
        </criteria>

        <handlers>

            <handler factory="org.shiftone.jrat.provider.tree.TreeMethodHandlerFactory">
                <property name="outputFile" value="my_code_tree.jrat"/>
            </handler>

        </handlers>

    </profile>
</jrat> 

Settings (Global)

Profiles

• A profile is a grouping of your application code.
• A class or method may belong to more than one profile.
• A class or method's membership in a profile is based on the profile's criteria.
• A profile may have one or more handlers.

Profiles can be given names, however these names are optional and are only used for logging and error messages.

Criteria

Multiple include and exclude tags may be used to build complex matching criteria. A profile matches if the include clauses match and none of the exclude clauses match.

Handlers