Start page / Plug-In Development / Implementation and Deployment / Module Architecture / The Ant Build File

Ant Build File

The file build.xml defines the Ant targets that will be used to compile the module's Java classes and create an FSM file. Its format follows the standards described in the Apache Ant documentation.

The build file provided by the ContentCreator Example module framework defines the following targets (all paths are relative to the module framework's root):

  • clean
    deletes the directory target
  • compile
    compiles all .java files located in src/impl and its subdirectories; the compiled .class files will be placed in target/impl
  • jar
    generates a Java Archive (JAR) file that includes the compiled Java classes located in target/impl and subdirectories; the JAR file will be placed in target/jar
  • fsm
    generates a FirstSpirit Module (FSM) file that includes the compiled Java classes in target/impl, the JAR file located in target/jar as well as any supporting files (files stored in src/impl that do not end in .java and files located in src/web); the FSM file will be placed in target/fsm

The target "fsm" causes all other targets listed above to be executed in the correct order (clean, compile, jar). As such, in order to create an FSM file, it is normally possible to simply execute the target "fsm".

Please note that the conventions of Ant target structure and naming shown here are only suggestions. Developers are free to structure Ant build files as they see fit, but it is recommended that a workflow of subsequent Ant target calls similar to those in the provided module source code packages is implemented to appropriately group build file functionality and maintain readable build file code.

© 2005 - 2024 Crownpeak Technology GmbH | All rights reserved. | FirstSpirit 2024.12 | Data privacy