Setting up the classpath

The libraries which the generated classes depend on can be found in the binary distribution of the torque-runtime module. To add these dependencies to your project, create the directory lib/runtime in the top level directory of the project. Add all libraries from the lib dir of the torque-runtime binary distribution and also the torque-runtime-${version}.jar from its root directory. Additionally copy the mysql driver jar and the log4j jar from lib/ant to lib/runtime.

Note: There is no need to include the torque-generator or torque-templates dependencies to the runtime of your project.

Building the sample application

Now that you've generated your object model with Torque, and created a sample application, you are now ready to compile and build everything. Again, ant is used to control the build process. You can build your application by typing the following in the top-level directory of your project:

ant

If you've done everything correctly, this should build without any errors. This means all of the source files will have been compiled to the target/classes folder. If the compiler misses any external libraries, review your application code and the libraries in lib/runtime.

Running the sample application

Before you run the sample application, you must first set your classpath. The classpath must include most of the jars in the lib/runtime folder (There are some jars which are transitive dependencies to other jars which are not used, but there is no harm in including these). The classpath must include all of your application and object model classes located in target/classes. To run the application, change into the root directory of the application and type (exchange the mysql driver jar for the one which you are actually using)

linux:
java -cp target/classes:lib/runtime/commons-beanutils-core-1.9.4.jar:lib/runtime/commons-dbcp2-2.7.jar:lib/runtime/commons-collections-3.2.2.jar:lib/runtime/commons-configuration2-2.7.jar:lib/runtime/commons-lang3-3.10.jar:lib/runtime/commons-logging-1.2.jar:lib/runtime/commons-pool2-2.7.0.jar:lib/runtime/log4j-1.2-api-2.16.0.jar:lib/runtime/mysql-connector-java-8.0.27.jar:lib/runtime/torque-runtime-5.0.jar org.apache.torque.tutorial.om.Bookstore

windows:
java -cp target/classes;lib/runtime/commons-beanutils-core-1.9.4.jar;lib/runtime/commons-dbcp2-2.7.jar;lib/runtime/commons-collections-3.2.2.jar;lib/runtime/commons-configuration2-2.7.jar;lib/runtime/commons-lang3-3.10.jar;lib/runtime/commons-logging-1.2.jar;lib/runtime/commons-pool2-2.7.0.jar;lib/runtime/log4j-1.2-api-2.16.0.jar;lib/runtime/mysql-connector-java-8.0.27.jar;lib/runtime/torque-runtime-5.0.jar org.apache.torque.tutorial.om.Bookstore

If all goes well, you should see the following output:

  Full booklist:

  Title:     TCP/IP Illustrated, Volume 1
  ISBN:      0-201-63346-9
  Publisher: Addison Wesley Professional
  Author:    Stevens, W.

  Title:     Effective Java
  ISBN:      0-618-12902-2
  Publisher: Addison Wesley Professional
  Author:    Bloch, Joshua

  Booklist (specific ISBN):

  Title:     TCP/IP Illustrated, Volume 1
  ISBN:      0-201-63346-9
  Publisher: Addison Wesley Professional
  Author:    Stevens, W.

  Booklist (authors swapped):

  Title:     TCP/IP Illustrated, Volume 1
  ISBN:      0-201-63346-9
  Publisher: Addison Wesley Professional
  Author:    Bloch, Joshua

  Title:     Effective Java
  ISBN:      0-618-12902-2
  Publisher: Addison Wesley Professional
  Author:    Stevens, W.

  Booklist (should be empty):

If your application throws an exception, it could be for one of many reasons, most of which are not very descriptive unfortunately. Do not be discouraged if your application does not run the first time. Carefully retrace all of the steps outlined in this tutorial. If you are still not able to get your application to run, use the Torque user mailing list to your advantage.