build.xml for deploying java servlet on tomcat container

build.xml for deploying java servlet on tomcat container

i have written a simple build.xml file for java servlet. it can compile the source code to predefined directories"and" notify the servlet container to reload the compiled context.

<project name="my project" default="restart" basedir=".">



<!-- ===================== Property Definitions =========================== -->


<!--

Each of the following properties are used in the build script.
Values for these properties are set by the first place they are
defined, from the following list:

Definitions on the "ant" command line (ant -Dfoo=bar compile).

Definitions from a "build.properties" file in the top level
source directory of this application.

Definitions from a "build.properties" file in the developer's
home directory.

Default definitions in this build.xml file.

You will note below that property values can be composed based on the
contents of previously defined properties. This is a powerful technique
that helps you minimize the number of changes required when your development
environment is modified. Note that property composition is allowed within
"build.properties" files as well as in the "build.xml" script.

-->

<property file="build.properties"/>
<property file="${user.home}/build.properties"/>


<!-- ==================== File and Directory Names ======================== -->


<!--

These properties generally define file and directory names (or paths) that
affect where the build process stores its outputs.

app.name Base name of this application, used to
construct filenames and directories.
Defaults to "myapp".

app.path Context path to which this application should be
deployed (defaults to "/" plus the value of the
"app.name" property).

app.version Version number of this iteration of the application.

build.home The directory into which the "prepare" and
"compile" targets will generate their output.
Defaults to "build".

catalina.home The directory in which you have installed
a binary distribution of Tomcat 4. This will
be used by the "deploy" target.

dist.home The name of the base directory in which
distribution files are created.
Defaults to "dist".

manager.password The login password of a user that is assigned the
"manager" role (so that he or she can execute
commands via the "/manager" web application)

manager.url The URL of the "/manager" web application on the
Tomcat installation to which we will deploy web
applications and web services.

manager.username The login username of a user that is assigned the
"manager" role (so that he or she can execute
commands via the "/manager" web application)

-->

<property name="build.home" value="${basedir}"/>
<property name="catalina.home" value="/local/dir/to/tomcat/home"/> <!-- UPDATE THIS! -->
<property name="src.home" value="${basedir}/src"/>
<property name="manager.url" value="http://tomcat.host/manager"/>
<property name="manager.username" value="tomcat"/>
<property name="manager.password" value="tomcat"/>
<property name="app.name" value="myapp"/>
<property name="app.path" value="/${app.name}"/>


<!-- ================== Custom Ant Task Definitions ======================= -->


<!--

These properties define custom tasks for the Ant build tool that interact
with the "/manager" web application installed with Tomcat 4. Before they
can be successfully utilized, you must perform the following steps:

- Copy the file "server/lib/catalina-ant.jar" from your Tomcat 4
installation into the "lib" directory of your Ant installation.

- Create a "build.properties" file in your application's top-level
source directory (or your user login home directory) that defines
appropriate values for the "manager.password", "manager.url", and
"manager.username" properties described above.

For more information about the Manager web application, and the functionality
of these tasks, see <http://localhost:8080/tomcat-docs/manager-howto.html>.

-->
<taskdef name="install" classname="org.apache.catalina.ant.InstallTask"/>
<taskdef name="list" classname="org.apache.catalina.ant.ListTask"/>
<taskdef name="reload" classname="org.apache.catalina.ant.ReloadTask"/>
<taskdef name="remove" classname="org.apache.catalina.ant.RemoveTask"/>
<taskdef name="start" classname="org.apache.catalina.ant.StartTask"/>
<taskdef name="stop" classname="org.apache.catalina.ant.StopTask"/>



<!-- ==================== Compilation Control Options ==================== -->

<!--

These properties control option settings on the Javac compiler when it
is invoked using the <javac> task.

compile.debug Should compilation include the debug option?

compile.deprecation Should compilation include the deprecation option?

compile.optimize Should compilation include the optimize option?

-->

<property name="compile.debug" value="true"/>
<property name="compile.deprecation" value="false"/>
<property name="compile.optimize" value="true"/>



<!-- ==================== External Dependencies =========================== -->


<!--

Use property values to define the locations of external JAR files on which
your application will depend. In general, these values will be used for
two purposes:
Inclusion on the classpath that is passed to the Javac compiler
Being copied into the "/WEB-INF/lib" directory during execution
of the "deploy" target.

Because we will automatically include all of the Java classes that Tomcat 4
exposes to web applications, we will not need to explicitly list any of those
dependencies. You only need to worry about external dependencies for JAR
files that you are going to include inside your "/WEB-INF/lib" directory.

-->

<!-- Dummy external dependency -->
<!--
<property name="foo.jar"
value="/path/to/foo.jar"/>
-->


<!-- ==================== Compilation Classpath =========================== -->

<!--

Rather than relying on the CLASSPATH environment variable, Ant includes
features that makes it easy to dynamically construct the classpath you
need for each compilation. The example below constructs the compile
classpath to include the servlet.jar file, as well as the other components
that Tomcat makes available to web applications automatically, plus anything
that you explicitly added.

-->

<path id="compile.classpath">

<!-- Include all JAR files that will be included in /WEB-INF/lib -->
<!-- ** CUSTOMIZE HERE AS REQUIRED BY YOUR APPLICATION ** -->
<!--
<pathelement location="${foo.jar}"/>
-->

<!-- Include all elements that Tomcat exposes to applications -->
<pathelement location="${catalina.home}/common/classes"/>
<fileset dir="${catalina.home}/common/endorsed">
<include name="*.jar"/>
</fileset>
<fileset dir="${catalina.home}/common/lib">
<include name="*.jar"/>
</fileset>
<pathelement location="${catalina.home}/shared/classes"/>
<fileset dir="${catalina.home}/shared/lib">
<include name="*.jar"/>
</fileset>

</path>



<!-- ==================== All Target ====================================== -->

<!--

The "all" target is a shortcut for running the "clean" target followed
by the "compile" target, to force a complete recompile.

-->

<target name="all" depends="clean,compile"
description="Clean build and dist directories, then compile"/>



<!-- ==================== Clean Target ==================================== -->

<!--

The "clean" target deletes any previous "build" and "dist" directory,
so that you can be ensured the application can be built from scratch.

-->

<target name="clean"
description="Delete old build and dist directories">
<delete dir="${build.home}/WEB-INF/classes"/>
</target>



<!-- ==================== Compile Target ================================== -->

<!--

The "compile" target transforms source files (from your "src" directory)
into object files in the appropriate location in the build directory.
This example assumes that you will be including your classes in an
unpacked directory hierarchy under "/WEB-INF/classes".

-->

<target name="compile" depends="prepare"
description="Compile Java sources">

<!-- Compile Java classes as necessary -->
<mkdir dir="${build.home}/WEB-INF/classes"/>
<javac srcdir="${src.home}"
destdir="${build.home}/WEB-INF/classes"
debug="${compile.debug}"
deprecation="${compile.deprecation}"
optimize="${compile.optimize}">
<classpath refid="compile.classpath"/>
</javac>

<!-- Copy application resources -->
<copy todir="${build.home}/WEB-INF/classes">
<fileset dir="${src.home}" excludes="**/*.java"/>
</copy>

</target>



<!-- ==================== Prepare Target ================================== -->

<!--

The "prepare" target is used to create the "build" destination directory,
and copy the static contents of your web application to it. If you need
to copy static files from external dependencies, you can customize the
contents of this task.

Normally, this task is executed indirectly when needed.

-->

<target name="prepare">

<!-- Create build directories as needed -->
<mkdir dir="${build.home}/WEB-INF/classes"/>


<!-- Copy external dependencies as required -->
<!-- ** CUSTOMIZE HERE AS REQUIRED BY YOUR APPLICATION ** -->
<mkdir dir="${build.home}/WEB-INF/lib"/>
<!--
<copy todir="${build.home}/WEB-INF/lib" file="${foo.jar}"/>
-->

<!-- Copy static files from external dependencies as needed -->
<!-- ** CUSTOMIZE HERE AS REQUIRED BY YOUR APPLICATION ** -->

</target>


<target name="restart" depends="compile"
description="Restart application on servlet container">

<stop url="${manager.url}"
username="${manager.username}"
password="${manager.password}"
path="${app.path}"/>
<start url="${manager.url}"
username="${manager.username}"
password="${manager.password}"
path="${app.path}"/>

</target>

</project>