AA-RR mini-HOWTO

Index


Getting AA-RR

By the moment, AA-RR is only accesible at the RedIRIS CVS repository. You can download the most recent version from this link.


Compiling AA-RR

Requisites

AA-RR needs at least Java 2 to be compiled. The current version has been tested only under Linux, but it might be also possible to build and run AA-RR in other systems. Windows .bat files will be added in a near future.

Please notice that there are a number of libraries necessary for building AA-RR. Here's a list of the .jar files needed for building the current AA-RR version:

log4j-1.2.5.jar
ant.jar
opensaml.jar
servlet-2.3.jar
dom3-xercesImpl-2.4.0.jar
xalan-2.4.1.jar
xmlsec-1.0.5.jar
xmlsec-1.2RC1.jar
dom3-xercesImpl-2.5.0.jar
dom3-xml-apis-2.5.0.jar
commons-logging.jar
jalopy/aelfred-1.2.jar
jalopy/jalopy-1.0b11.jar
jalopy/jalopy-ant-0.6.2.jar
jalopy/jaxp-1.2.jar
jalopy/jdom-1.0b8.jar
jalopy/log4j-1.2.5.jar
jalopy/oro-2.0.6.jar
jalopy/sax-2.0.1.jar

[ TODO: review the list; figure out missing package versions ]

You also need OpenSAML (1.0.1) to run the test(s).

Ant tasks

There are ant tasks for building AA-RR. Here's a list of the options included in the ant script:

- targets Lists the build targets
- clean Cleans the build and distribution directories
- all Cleans and builds all the packages and examples
- release Cleans and builds all the release packages (JAR, source, doc, tarball) in the dist directory
- aarr Builds the aarr packages (including debugging info)
- tests Builds testing classes (TODO: integrate the tests with the rest of the distribution)
- jar Builds the binary JAR in the dist directory
- doc Builds the documentation
- javadoc Builds the API JavaDocs
- beautify Cleans up the Java code
- source Builds the source tarball in the dist directory
- tarball Builds the binary distribution in the dist directory

Building AA-RR

For simply getting the AA-RR jar (it compiles the sources before), just write:

$ ./ant jar

Once compiled, the run_ant.sh script can be used to run the application. An specific configuration can be passed as a parameter. There's a default configuration in conf directory.


Testing AA-RR

Use run_aarr.sh to run AA-RR. The application listens on port 80, so it must be executed by a privileged user.

Test(s) must be compiled previously. Now the only test class is named SOAPBindingTest.java, and can be compiled like any other class in the test direcory of OpenSAML. There will be an ant task for doing this (TODO).

Once compiled, just run the provided script(s) (soap.sh). Notice that AA-RR must be running before running the test(s).


Debugging

If you want to see the results just look at the logfile in the logs directory. A more decent log format is on the way... :)