{"id":276,"date":"2026-10-13T07:21:42","date_gmt":"2026-10-13T07:21:42","guid":{"rendered":"http:\/\/www.scmgalaxy.com\/tutorials\/2010\/07\/22\/a-sample-ant-build-script-that-builds-a-war-file\/"},"modified":"2026-10-13T07:21:42","modified_gmt":"2026-10-13T07:21:42","slug":"a-sample-ant-build-script-that-builds-a-war-file","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/a-sample-ant-build-script-that-builds-a-war-file\/","title":{"rendered":"Ant build.xml for WAR Packaging and Tomcat Deployment (Annotated Reference)"},"content":{"rendered":"\n

Originally published on 2010-07-22; fully revised and updated.<\/em><\/p>\n\n\n\n

If you maintain or modernize Java web applications that still use Apache Ant, this walkthrough shows how a WAR-oriented build.xml<\/code> works end to end: from cleanup and compilation to packaging and deployment into a Tomcat webapps<\/code> directory.<\/p>\n\n\n\n

This revision is based on the original sample post: A sample Ant build script that builds a WAR file<\/a>.<\/p>\n\n\n\n

Ant build script WAR file example<\/p>\n\n\n\n

WAR build workflow in this Ant script<\/h2>\n\n\n\n

The script defines two deployment paths: a full WAR build\/install path and a faster JSP\/static-only refresh path.<\/p>\n\n\n\n

\nflowchart TD\n    A[Run Ant target] --> B{Target selected}\n    B -->|install| C[clean and prepare]\n    C --> D[compile sources]\n    D --> E[copy descriptors and resources]\n    E --> F[build WAR archive]\n    F --> G[copy WAR to app server webapps]\n    B -->|jsps| H[copy JSP and static assets only]\n<\/pre>\n\n\n\n
Expected properties and project layout<\/h2>\n\n\n\n
The build relies on conventional directories for source, web pages, resources, and libraries. During packaging, it stages content into a temporary WAR-like folder structure under temp\/WEB-INF<\/code>.<\/p>\n\n\n\n
  • src<\/code>: Java source files<\/li>
  • src-tests<\/code>: test or auxiliary Java sources (compiled by this sample)<\/li>
  • pages<\/code>: JSP and static web content<\/li>
  • resources<\/code>: web.xml<\/code>, manifest, and app XML files<\/li>
  • lib<\/code>: JAR dependencies for compile and WAR inclusion<\/li>
  • target<\/code>: final WAR output directory<\/li><\/ul>\n\n\n
    project-root\/\n\u251c\u2500\u2500 build.xml\n\u251c\u2500\u2500 lib\/\n\u251c\u2500\u2500 pages\/\n\u251c\u2500\u2500 resources\/\n\u2502   \u251c\u2500\u2500 MANIFEST.MF\n\u2502   \u251c\u2500\u2500 web.xml\n\u2502   \u251c\u2500\u2500 managed-beans.xml\n\u2502   \u2514\u2500\u2500 navigation-rules.xml\n\u251c\u2500\u2500 src\/\n\u251c\u2500\u2500 src-tests\/\n\u2514\u2500\u2500 target\/<\/code><\/span><\/pre>\n\n\n
    Reference build.xml (based on the original sample)<\/h2>\n\n\n\n
    The following is a cleaned, readable version of the sample logic from the original post.<\/p>\n\n\n
    <project<\/span> name<\/span>='MyWebApplication'<\/span> basedir<\/span>='..'<\/span> default<\/span>='install'<\/span>><\/span>\n\n  <!-- project-specific variables --><\/span>\n  <property<\/span> name<\/span>='jsp.dir.name'<\/span> value<\/span>='myapp'<\/span> \/><\/span>\n  <property<\/span> name<\/span>='package.name'<\/span> value<\/span>='${jsp.dir.name}.war'<\/span> \/><\/span>\n  <property<\/span> name<\/span>='webapp.dir'<\/span> value<\/span>='\/Users\/al\/tomcat-6.0.16\/webapps'<\/span> \/><\/span>\n\n  <property<\/span> environment<\/span>='env'<\/span> \/><\/span>\n  <property<\/span> name<\/span>='build.dir'<\/span> value<\/span>='build'<\/span> \/><\/span>\n  <property<\/span> file<\/span>='${build.dir}\/build.${env.HOSTNAME}'<\/span> \/><\/span>\n\n  <property<\/span> name<\/span>='lib.dir'<\/span> value<\/span>='lib'<\/span> \/><\/span>\n  <property<\/span> name<\/span>='pages.dir'<\/span> value<\/span>='pages'<\/span> \/><\/span>\n  <property<\/span> name<\/span>='src.dir'<\/span> value<\/span>='src'<\/span> \/><\/span>\n  <property<\/span> name<\/span>='src.tests.dir'<\/span> value<\/span>='src-tests'<\/span> \/><\/span>\n  <property<\/span> name<\/span>='resources.dir'<\/span> value<\/span>='resources'<\/span> \/><\/span>\n  <property<\/span> name<\/span>='dest.dir'<\/span> value<\/span>='target'<\/span> \/><\/span>\n\n  <!-- temporary staging structure --><\/span>\n  <property<\/span> name<\/span>='temp.dir'<\/span> value<\/span>='temp'<\/span> \/><\/span>\n  <property<\/span> name<\/span>='temp.dir.web-inf'<\/span> value<\/span>='${temp.dir}\/WEB-INF'<\/span> \/><\/span>\n  <property<\/span> name<\/span>='temp.dir.lib'<\/span> value<\/span>='${temp.dir.web-inf}\/lib'<\/span> \/><\/span>\n  <property<\/span> name<\/span>='temp.dir.classes'<\/span> value<\/span>='${temp.dir.web-inf}\/classes'<\/span> \/><\/span>\n  <property<\/span> name<\/span>='temp.dir.meta-inf'<\/span> value<\/span>='${temp.dir}\/META-INF'<\/span> \/><\/span>\n\n  <property<\/span> name<\/span>='package.file'<\/span> value<\/span>='${dest.dir}\/${package.name}'<\/span> \/><\/span>\n\n  <path<\/span> id<\/span>='build.class.path'<\/span>><\/span>\n    <fileset<\/span> dir<\/span>='${lib.dir}'<\/span>><\/span>\n      <include<\/span> name<\/span>='**\/*.jar'<\/span> \/><\/span>\n    <\/fileset<\/span>><\/span>\n  <\/path<\/span>><\/span>\n\n  <target<\/span> name<\/span>='clean'<\/span>><\/span>\n    <delete<\/span>><\/span>\n      <fileset<\/span> dir<\/span>='${dest.dir}'<\/span> includes<\/span>='**\/*'<\/span> \/><\/span>\n    <\/delete<\/span>><\/span>\n    <delete<\/span> dir<\/span>='${temp.dir}'<\/span> \/><\/span>\n    <delete<\/span> dir<\/span>='${temp.dir.classes}'<\/span> \/><\/span>\n    <delete<\/span> dir<\/span>='${temp.dir.meta-inf}'<\/span> \/><\/span>\n    <delete<\/span> dir<\/span>='${temp.dir.web-inf}'<\/span> \/><\/span>\n  <\/target<\/span>><\/span>\n\n  <target<\/span> name<\/span>='prepare'<\/span> depends<\/span>='clean'<\/span>><\/span>\n    <mkdir<\/span> dir<\/span>='${dest.dir}'<\/span> \/><\/span>\n    <mkdir<\/span> dir<\/span>='${temp.dir}'<\/span> \/><\/span>\n    <mkdir<\/span> dir<\/span>='${temp.dir.lib}'<\/span> \/><\/span>\n    <mkdir<\/span> dir<\/span>='${temp.dir.meta-inf}'<\/span> \/><\/span>\n    <mkdir<\/span> dir<\/span>='${temp.dir.web-inf}'<\/span> \/><\/span>\n    <mkdir<\/span> dir<\/span>='${temp.dir.classes}'<\/span> \/><\/span>\n  <\/target<\/span>><\/span>\n\n  <target<\/span> name<\/span>='compile'<\/span> depends<\/span>='prepare'<\/span>><\/span>\n    <echo<\/span>><\/span>=== COMPILE ===<\/echo<\/span>><\/span>\n    <javac<\/span> debug<\/span>='on'<\/span> srcdir<\/span>='${src.dir}'<\/span> destdir<\/span>='${temp.dir.classes}'<\/span> includes<\/span>='**\/*'<\/span>><\/span>\n      <classpath<\/span> refid<\/span>='build.class.path'<\/span> \/><\/span>\n    <\/javac<\/span>><\/span>\n\n    <javac<\/span> debug<\/span>='on'<\/span> srcdir<\/span>='${src.tests.dir}'<\/span> destdir<\/span>='${temp.dir.classes}'<\/span> includes<\/span>='com\/**'<\/span>><\/span>\n      <classpath<\/span> refid<\/span>='build.class.path'<\/span> \/><\/span>\n    <\/javac<\/span>><\/span>\n  <\/target<\/span>><\/span>\n\n  <target<\/span> name<\/span>='package'<\/span> depends<\/span>='compile'<\/span>><\/span>\n    <echo<\/span>><\/span>=== PACKAGE ===<\/echo<\/span>><\/span>\n\n    <copy<\/span> file<\/span>='${resources.dir}\/MANIFEST.MF'<\/span> tofile<\/span>='${temp.dir.meta-inf}\/MANIFEST.MF'<\/span> overwrite<\/span>='true'<\/span> \/><\/span>\n    <copy<\/span> file<\/span>='${resources.dir}\/web.xml'<\/span> tofile<\/span>='${temp.dir.web-inf}\/web.xml'<\/span> overwrite<\/span>='true'<\/span> \/><\/span>\n    <copy<\/span> file<\/span>='${resources.dir}\/managed-beans.xml'<\/span> tofile<\/span>='${temp.dir.web-inf}\/managed-beans.xml'<\/span> overwrite<\/span>='true'<\/span> \/><\/span>\n    <copy<\/span> file<\/span>='${resources.dir}\/navigation-rules.xml'<\/span> tofile<\/span>='${temp.dir.web-inf}\/navigation-rules.xml'<\/span> overwrite<\/span>='true'<\/span> \/><\/span>\n\n    <copy<\/span> todir<\/span>='${temp.dir.classes}'<\/span>><\/span>\n      <fileset<\/span> dir<\/span>='${src.dir}'<\/span>><\/span>\n        <include<\/span> name<\/span>='**\/*.xml'<\/span> \/><\/span>\n        <include<\/span> name<\/span>='**\/*.xsl'<\/span> \/><\/span>\n      <\/fileset<\/span>><\/span>\n    <\/copy<\/span>><\/span>\n\n    <war<\/span> destfile<\/span>='${package.file}'<\/span> webxml<\/span>='${temp.dir.web-inf}\/web.xml'<\/span> basedir<\/span>='${temp.dir}'<\/span>><\/span>\n      <fileset<\/span> dir<\/span>='${pages.dir}'<\/span> \/><\/span>\n      <lib<\/span> dir<\/span>='${lib.dir}'<\/span> \/><\/span>\n      <classes<\/span> dir<\/span>='${temp.dir.classes}'<\/span> \/><\/span>\n    <\/war<\/span>><\/span>\n  <\/target<\/span>><\/span>\n\n  <target<\/span> name<\/span>='jsps'<\/span>><\/span>\n    <echo<\/span>><\/span>=== DEPLOY JSPS ===<\/echo<\/span>><\/span>\n    <copy<\/span> todir<\/span>='${webapp.dir}\/${jsp.dir.name}'<\/span>><\/span>\n      <fileset<\/span> dir<\/span>='${pages.dir}'<\/span>><\/span>\n        <include<\/span> name<\/span>='**\/*.jsp'<\/span> \/><\/span>\n        <include<\/span> name<\/span>='**\/*.html'<\/span> \/><\/span>\n        <include<\/span> name<\/span>='**\/*.css'<\/span> \/><\/span>\n        <include<\/span> name<\/span>='**\/*.gif'<\/span> \/><\/span>\n        <include<\/span> name<\/span>='**\/*.jpg'<\/span> \/><\/span>\n        <include<\/span> name<\/span>='**\/*.png'<\/span> \/><\/span>\n        <include<\/span> name<\/span>='**\/*.js'<\/span> \/><\/span>\n      <\/fileset<\/span>><\/span>\n    <\/copy<\/span>><\/span>\n  <\/target<\/span>><\/span>\n\n  <target<\/span> name<\/span>='install'<\/span> depends<\/span>='package'<\/span>><\/span>\n    <echo<\/span>><\/span>=== INSTALL ===<\/echo<\/span>><\/span>\n    <copy<\/span> file<\/span>='${package.file}'<\/span> tofile<\/span>='${webapp.dir}\/${package.name}'<\/span> overwrite<\/span>='true'<\/span> \/><\/span>\n  <\/target<\/span>><\/span>\n\n<\/project<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
    Run the build targets<\/h2>\n\n\n\n
    Use Ant target names directly. Override environment-specific paths with -D<\/code> properties to avoid editing build.xml<\/code> per machine.<\/p>\n\n\n
    # Full build and WAR creation<\/span>\nant package\n\n# Build and copy WAR into Tomcat webapps<\/span>\nant install -Dwebapp.dir=\/opt\/tomcat\/webapps\n\n# Fast JSP\/static-only refresh<\/span>\nant jsps -Dwebapp.dir=\/opt\/tomcat\/webapps -Djsp.dir.name=myapp\n\n# Clean output directories<\/span>\nant clean<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
    Target comparison<\/h2>\n\n\n\n
    Target<\/th>Depends on<\/th>Primary output<\/th>Best for<\/th><\/tr><\/thead>
    clean<\/td>None<\/td>Removes temp and target artifacts<\/td>Resetting state before a new build<\/td><\/tr>
    prepare<\/td>clean<\/td>Creates staging\/output directories<\/td>Pre-compilation setup<\/td><\/tr>
    compile<\/td>prepare<\/td>Compiled classes in temp\/WEB-INF\/classes<\/td>Verifying code compiles<\/td><\/tr>
    package<\/td>compile<\/td>WAR file in target\/<\/td>Artifact creation for CI\/CD<\/td><\/tr>
    install<\/td>package<\/td>WAR copied to server webapps<\/td>Local or direct server deployment<\/td><\/tr>
    jsps<\/td>None<\/td>JSP\/static files copied to deployed app dir<\/td>Fast UI\/content-only updates<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Common pitfalls and best practices<\/h2>\n\n\n\n
    • Avoid hard-coded server paths.<\/strong> Externalize webapp.dir<\/code> using -D<\/code> properties or environment-specific property files.<\/li>
    • Keep test outputs separate from production classes.<\/strong> In this sample, src-tests<\/code> compiles into the same classes directory used in the WAR.<\/li>
    • Be deliberate with bundled libraries.<\/strong> lib\/**\/*.jar<\/code> is broad; verify you are not packaging container-provided JARs.<\/li>
    • Prefer CI artifact publishing over direct server copy.<\/strong> Use package<\/code> to generate the WAR, then deploy through your pipeline.<\/li>
    • Fail fast on missing descriptors.<\/strong> Ensure required files like web.xml<\/code> exist before packaging.<\/li><\/ul>\n\n\n\n
      For legacy Ant projects, this pattern is still workable: keep targets small, parameterize environment values, and treat the generated WAR as the primary deployable artifact.<\/p>\n","protected":false},"excerpt":{"rendered":"
      This guide turns a legacy Ant WAR build sample into a practical reference you can reuse. You will learn the target flow, required layout, runnable commands, and common pitfalls before using it in CI\/CD.<\/p>\n","protected":false},"author":1,"featured_media":4408,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_joinchat":[],"footnotes":""},"categories":[2],"tags":[209,3827,4215,4212,4214,4209,4211,4216,4213,4219,378,4210,1122,3113,593,4218,213,4217],"class_list":["post-276","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-uncategorised","tag-ant","tag-ant-build","tag-ant-build-script","tag-ant-build-script-for-war-file","tag-ant-script-to-build-war-file","tag-ant-war-task","tag-ant-war-task-meta-inf-example","tag-build-war-file","tag-build-war-file-using-ant","tag-build-war-file-with-ant","tag-commands","tag-create-war-file-using-ant-command","tag-guide","tag-how-to","tag-process","tag-sample","tag-tutorial","tag-war-file"],"_links":{"self":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/276","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/comments?post=276"}],"version-history":[{"count":3,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/276\/revisions"}],"predecessor-version":[{"id":79105,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/276\/revisions\/79105"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media\/4408"}],"wp:attachment":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media?parent=276"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/categories?post=276"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/tags?post=276"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}