You are here: Before You Use the API > Preparatory Tasks > About the Java Reference Application

About the Java Reference Application

The Java reference application is based on Apache Axis 1.4 and JDK 5.0 (Java 2 Platform Standard Edition Development Kit 5.0). For more information on Apache Axis 1.4, see http://ws.apache.org/axis/.

The reference application can be downloaded as a compressed file from a link provided in the Sandbox. The compressed file includes the Axis libraries and a properties file. The properties file contains sample data for use by the reference application.

Running the Java Reference Application

There are two different ways you can run the Java version of the reference application.

Option 1: Use Apache Ant to Run the Java Reference Application

If you have Apache Ant installed, you can run the reference application by invoking

ant test run

Ant is a Java-based build tool that uses XML-formatted files to perform the same types of functions as a make file. In addition to running the code, the build.xml file generates the object stubs and compiles and runs the code.

Option 2: Run the Java Reference Application In Windows

If you want to run the Java reference in Windows, you will need to have a Java development environment installed. Of course, if you are coding in a different language, you can still view the reference application in an editor to see how the calls are made.

To run the Java reference application in Windows,

Uncompress the reference application into a directory of your choice.
Open the properties file in that directory and prepare sample data by entering your own login credentials and the RatePlan data (RatePlan ID, RatePlanChargeId, and so on; see the Sandbox pages for more information). Save the properties file with your data.
In that same directory, invoke the run bat file from the command line. This is a batch file that runs the reference application using the properties file.

Open topic with navigation