alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Spring Framework example source code file (build.xml)

This example Spring Framework source code file (build.xml) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Spring Framework tags/keywords

build, clean, geronimo, geronimo, meta-inf, openjpa, openjpa, petclinic, web-inf, web-inf/classes, web-inf/classes, web-inf/jsp, web-inf/lib, web-inf/lib

The Spring Framework build.xml source code

<?xml version="1.0"?>

<project name="petclinic" basedir="." default="usage">

	<property name="name" value="petclinic"/>

	<property name="war.dir" value="war"/>
	<property name="ear.dir" value="ear"/>
	<property name="src.dir" value="src"/>
	<property name="build.dir" value=".classes"/>
	<property name="docs.dir" value="${war.dir}/docs"/>
	<property name="webclasses.dir" value="${war.dir}/WEB-INF/classes"/>
	<property name="weblib.dir" value="${war.dir}/WEB-INF/lib"/>
	<property name="dist.dir" value="dist"/>
	<property name="db.dir" value="db"/>

	<property name="testsrc.dir" value="test"/>
	<property name="testbuild.dir" value=".testclasses"/>
	<property name="testreports.dir" value="junit-reports"/>
	<property name="testhtml.dir" value="${testreports.dir}/html"/>

	<property name="spring.root" value="../.."/>
	<property name="domain.classes" value="org/springframework/samples/petclinic/*.class"/>
	<property name="tomcat.context" value="tomcat/META-INF"/>

	<property file="build.properties"/>


	<path id="master-classpath">
		<fileset dir="${spring.root}/lib/aspectj">
			<include name="aspectjweaver.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/hibernate">
			<include name="hibernate3.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/j2ee">
			<include name="persistence.jar"/>
			<include name="servlet-api.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/jakarta-commons">
			<include name="commons-logging.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/toplink">
			<include name="toplink-essentials.jar"/>
		</fileset>
		<fileset dir="${spring.root}/dist">
			<include name="spring.jar"/>
		</fileset>
		<fileset dir="${spring.root}/dist/modules">
			<include name="spring-webmvc.jar"/>
		</fileset>
	</path>

	<path id="build-classpath">
		<!-- Only link toplink-api.jar in for building -->
		<fileset dir="${spring.root}/lib/toplink">
			<include name="toplink-api.jar"/>
		</fileset>
	</path>

	<path id="test-classpath">
		<fileset dir="${db.dir}/mysql">
			<include name="mysql*.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/antlr">
			<include name="antlr*.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/cglib">
			<include name="cglib*.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/dom4j">
			<include name="dom4j*.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/ehcache">
			<include name="ehcache*.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/hibernate">
			<include name="hibernate-entitymanager.jar"/>
			<include name="hibernate-annotations.jar"/>
			<include name="hibernate-commons-annotations.jar"/>
			<include name="jboss-archive-browsing.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/hsqldb">
			<include name="hsqldb.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/j2ee">
			<!-- connector.jar only needed for OpenJPA -->
			<include name="connector.jar"/>
			<!-- jta.jar only needed for Hibernate -->
			<include name="jta.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/jakarta-commons">
			<include name="commons-collections.jar"/>
			<include name="commons-dbcp.jar"/>
			<include name="commons-lang.jar"/>
			<include name="commons-pool.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/openjpa">
			<include name="openjpa*.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/serp">
			<!-- Serp only needed for OpenJPA -->
			<include name="serp*.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/toplink">
      <include name="eclipselink.jar"/>
			<include name="toplink-essentials.jar"/>
		</fileset>
		<fileset dir="${spring.root}/lib/junit">
			<include name="junit-4.4.jar"/>
		</fileset>
		<fileset dir="${spring.root}/dist/modules">
			<include name="spring-test.jar"/>
		</fileset>
	</path>


	<target name="usage">
		<echo message=""/>
		<echo message="PetClinic build file"/>
		<echo message="------------------------------------------------------"/>
		<echo message=""/>
		<echo message="Available targets are:"/>
		<echo message=""/>
		<echo message="clean    --> Clean output dirs"/>
		<echo message="build    --> Compile main Java sources and copy libraries"/>
		<echo message="docs     --> Create complete Javadoc documentation"/>
		<echo message="warfile  --> Build the web application archive"/>
		<echo message="setupDB  --> Initialize the database"/>
		<echo message="tests    --> Run tests using initialized database"/>
		<echo message="all      --> Clean, build, docs, warfile, tests"/>
		<echo message=""/>
	</target>


	<target name="clean" description="Clean output dirs (build, docs, testbuild, testreports, weblib, dist)">
		<delete dir="${build.dir}"/>
		<delete dir="${docs.dir}"/>
		<delete>
			<fileset dir="${webclasses.dir}">
				<include name="*.hbm.xml"/>
				<include name="jdbc.properties"/>
			</fileset>
		</delete>
		<delete dir="${weblib.dir}"/>
		<delete dir="${testbuild.dir}"/>
		<delete dir="${testreports.dir}"/>
		<delete dir="${dist.dir}"/>
		<delete dir="${ear.dir}/package"/>
	</target>


	<target name="build" description="Compile main source tree java files into class files, generate jar files">

		<mkdir dir="${build.dir}"/>
		<mkdir dir="${weblib.dir}"/>

		<javac destdir="${build.dir}" source="1.5" target="1.5"
				debug="true" deprecation="false" optimize="false" failonerror="true">
			<src path="${src.dir}"/>
			<classpath refid="master-classpath"/>
			<classpath refid="build-classpath"/>
		</javac>

		<copy todir="${webclasses.dir}" preservelastmodified="true">
			<fileset dir="${src.dir}">
				<include name="*.hbm.xml"/>
				<include name="jdbc.properties"/>
			</fileset>
		</copy>

		<!-- petclinic-domain.jar -->
		<jar jarfile="${weblib.dir}/${name}-domain.jar" compress="true">
			<fileset dir="${src.dir}">
				<include name="META-INF/orm.xml"/>
				<include name="META-INF/persistence.xml"/>
			</fileset>
			<fileset dir="${build.dir}">
				<include name="${domain.classes}"/>
			</fileset>
		</jar>

		<!-- rest of PetClinic classes -->
		<jar jarfile="${weblib.dir}/${name}.jar" compress="true">
			<fileset dir="${src.dir}">
				<include name="META-INF/aop.xml"/>
			</fileset>
			<fileset dir="${build.dir}">
				<include name="**/*"/>
				<exclude name="${domain.classes}"/>
			</fileset>
		</jar>

		<!-- copy Tomcat META-INF -->
		<copy todir="${weblib.dir}" preservelastmodified="true">
			<fileset dir="${db.dir}/mysql">
				<include name="mysql*.jar"/>
			</fileset>
			<fileset dir="${spring.root}/lib/antlr">
				<include name="antlr*.jar"/>
			</fileset>
			<fileset dir="${spring.root}/lib/aspectj">
				<include name="aspectjrt.jar"/>
				<include name="aspectjweaver.jar"/>
			</fileset>
			<fileset dir="${spring.root}/lib/cglib">
				<include name="cglib*.jar"/>
			</fileset>
			<fileset dir="${spring.root}/lib/dom4j">
				<include name="dom4j*.jar"/>
			</fileset>
			<fileset dir="${spring.root}/lib/ehcache">
				<include name="ehcache*.jar"/>
			</fileset>
			<fileset dir="${spring.root}/lib/hibernate">
				<include name="hibernate3.jar"/>
				<include name="hibernate-entitymanager.jar"/>
				<include name="hibernate-annotations.jar"/>
				<include name="hibernate-commons-annotations.jar"/>
				<include name="jboss-archive-browsing.jar"/>
			</fileset>
			<fileset dir="${spring.root}/lib/hsqldb">
				<include name="hsqldb.jar"/>
			</fileset>
			<fileset dir="${spring.root}/lib/log4j">
				<include name="log4j*.jar"/>
			</fileset>
			<fileset dir="${spring.root}/lib/j2ee">
				<!-- connector.jar only needed for OpenJPA -->
				<include name="connector.jar"/>
				<include name="jstl.jar"/>
				<!-- jta.jar only needed for Hibernate -->
				<include name="jta.jar"/>
				<include name="persistence.jar"/>
			</fileset>
			<fileset dir="${spring.root}/lib/jakarta-commons">
				<include name="commons-collections.jar"/>
				<include name="commons-dbcp.jar"/>
				<include name="commons-lang.jar"/>
				<include name="commons-logging.jar"/>
				<include name="commons-pool.jar"/>
			</fileset>
			<fileset dir="${spring.root}/lib/jakarta-taglibs">
				<include name="standard.jar"/>
			</fileset>
			<fileset dir="${spring.root}/lib/openjpa">
				<include name="openjpa*.jar"/>
			</fileset>
			<fileset dir="${spring.root}/lib/serp">
				<!-- Serp only needed for OpenJPA -->
				<include name="serp*.jar"/>
			</fileset>
			<fileset dir="${spring.root}/lib/toplink">
        <include name="eclipselink.jar"/>
				<include name="toplink-essentials.jar"/>
			</fileset>
			<fileset dir="${spring.root}/dist">
				<include name="spring.jar"/>
			</fileset>
			<fileset dir="${spring.root}/dist/modules">
				<include name="spring-webmvc.jar"/>
			</fileset>
			<fileset dir="${spring.root}/dist/weaving">
				<include name="spring-aspects.jar"/>
			</fileset>
		</copy>

	</target>


	<target name="docs" description="Create complete Javadoc documentation">

		<delete dir="${docs.dir}"/>
		<mkdir dir="${docs.dir}"/>

		<javadoc sourcepath="${src.dir}" destdir="${docs.dir}" windowtitle="PetClinic"
				source="1.5" author="true" version="true" use="true" packagenames="*">
			<doctitle>PetClinic]]>
			<bottom>Ken Krebs and Juergen Hoeller, 2003-2007.]]>
			<classpath refid="master-classpath"/>
			<classpath refid="build-classpath"/>
		</javadoc>

	</target>


	<target name="dist" depends="warfile">
		<!--
			Delegate to warfile target by depending on it. dist is just to offer
			a generic target name across all Spring sample apps that may be used
			for autobuilds testing.
		-->
	</target>


	<target name="warfile" depends="build,docs" description="Build the web application archive">

		<mkdir dir="${dist.dir}"/>

		<war warfile="${dist.dir}/${name}.war" basedir="${war.dir}" webxml="${war.dir}/WEB-INF/web.xml">
			<include name="*"/>
			<include name="docs/**"/>
			<include name="html/**"/>
			<include name="styles/**"/>
			<include name="images/**"/>
			<include name="WEB-INF/*.*"/>
			<exclude name="WEB-INF/web.xml"/>
			<include name="WEB-INF/classes/*.*"/>
			<include name="WEB-INF/lib/**"/>
			<include name="WEB-INF/jsp/**"/>
			<include name="WEB-INF/classes/META-INF/*"/>
			<include name="META-INF/*"/>
			<exclude name="**/.*"/>
			<exclude name="WEB-INF/geronimo-web.xml"/>
		</war>

	</target>


	<!--
		If you are going to deploy the application into Geronimo (or an application server
		variant of Geronimo), run this target in preference to the plain 'warfile'.
		This is required in order to avoid Geronimo class loading issues.
	-->
	<target name="warfile-geronimo" depends="build,docs" description="Build the web application archive packaged specifically for Geronimo">

		<mkdir dir="${dist.dir}"/>

		<war warfile="${dist.dir}/${name}.war" basedir="${war.dir}" webxml="${war.dir}/WEB-INF/web.xml">
			<include name="*"/>
			<include name="docs/**"/>
			<include name="html/**"/>
			<include name="styles/**"/>
			<include name="images/**"/>
			<include name="WEB-INF/*.*"/>
			<exclude name="WEB-INF/web.xml"/>
			<include name="WEB-INF/classes/*.*"/>
			<include name="WEB-INF/lib/**"/>
			<include name="WEB-INF/jsp/**"/>
			<exclude name="**/.*"/>
			<exclude name="WEB-INF/lib/commons-logging.jar"/>
			<exclude name="WEB-INF/lib/cglib*.jar"/>
		</war>

	</target>


	<target name="earfile" depends="build,docs" description="Build the enterprise application archive">

		<mkdir dir="${dist.dir}"/>
		<mkdir dir="${ear.dir}/package"/>

		<copy file="${war.dir}/WEB-INF/lib/${name}-domain.jar" todir="${ear.dir}/package"/>

		<war warfile="${ear.dir}/package/${name}.war" basedir="${war.dir}" webxml="${war.dir}/WEB-INF/web.xml">
			<include name="*"/>
			<include name="docs/**"/>
			<include name="html/**"/>
			<include name="styles/**"/>
			<include name="images/**"/>
			<include name="WEB-INF/*.*"/>
			<exclude name="WEB-INF/web.xml"/>
			<include name="WEB-INF/classes/*.*"/>
			<include name="WEB-INF/lib/**"/>
			<include name="WEB-INF/jsp/**"/>
			<include name="META-INF/*"/>
			<exclude name="**/petclinic-domain.jar"/>
			<exclude name="**/.*"/>
			<exclude name="WEB-INF/geronimo-web.xml"/>
		</war>

		<ear earfile="${dist.dir}/${name}.ear" basedir="${ear.dir}/package" appxml="${ear.dir}/META-INF/application.xml" manifest="${ear.dir}/META-INF/MANIFEST.MF">
			<include name="${name}.war"/>
			<include name="${name}-domain.jar"/>
		</ear>

	</target>


	<target name="setupHSQL" description="Set up HSQL database properties" if="useHSQL">

		<property name="db.driver" value="${hsql.driver}"/>
		<property name="db.url" value="${hsql.url}"/>
		<property name="db.user" value="${hsql.user}"/>
		<property name="db.pw" value="${hsql.pw}"/>

	</target>


	<target name="setupMYSQL" description="Set up MYSQL database properties" if="useMYSQL">

		<property name="db.driver" value="${mysql.driver}"/>
		<property name="db.url" value="${mysql.url}"/>
		<property name="db.user" value="${mysql.user}"/>
		<property name="db.pw" value="${mysql.pw}"/>

	</target>


	<target name="setupDB" depends="setupHSQL,setupMYSQL" description="Initialize the selected database">

		<ant antfile="${db.dir}/build.xml"/>

	</target>


	<target name="tests" depends="build,setupDB" description="Run tests using initialized database">

		<delete dir="${testbuild.dir}"/>
		<mkdir dir="${testbuild.dir}"/>
		<delete dir="${testreports.dir}"/>
		<mkdir dir="${testreports.dir}"/>
		<delete dir="${testhtml.dir}"/>
		<mkdir dir="${testhtml.dir}"/>

		<javac srcdir="${testsrc.dir}" destdir="${testbuild.dir}" debug="true" deprecation="true">
			<classpath path="${build.dir}"/>
			<classpath refid="master-classpath"/>
			<classpath refid="test-classpath"/>
		</javac>

		<copy todir="${testbuild.dir}" preservelastmodified="true">
			<fileset dir="${src.dir}">
				<include name="**/*.xml"/>
				<include name="**/*.properties"/>
			</fileset>
			<fileset dir="${testsrc.dir}">
				<include name="**/*.xml"/>
				<include name="**/*.properties"/>
			</fileset>
		</copy>

		<junit forkmode="perBatch" printsummary="true" haltonfailure="yes" haltonerror="yes">
			<classpath path="${build.dir}"/>
			<classpath path="${testbuild.dir}"/>
			<classpath refid="master-classpath"/>
			<classpath refid="test-classpath"/>

			<!--
				<formatter type="plain" usefile="false"/>
			-->
			<formatter type="xml"/>

			<batchtest fork="yes" todir="${testreports.dir}">
				<fileset dir="${testbuild.dir}">
					<include name="**/*Tests.class"/>
					<exclude name="**/Abstract*Tests.class"/>
					<exclude name="**/*SuiteTests.class"/>
				</fileset>
			</batchtest>
		</junit>

		<junitreport todir="${testhtml.dir}">
			<fileset dir="${testreports.dir}">
				<include name="TEST-*.xml"/>
			</fileset>
			<report format="frames" todir="${testhtml.dir}"/>
		</junitreport>

		<!-- restore the database -->
		<ant antfile="${db.dir}/build.xml"/>

	</target>


	<target name="all" depends="clean,build,docs,warfile,tests" description="Clean,build,docs,warfile,tests"/>

</project>

Other Spring Framework examples (source code examples)

Here is a short list of links related to this Spring Framework build.xml source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2024 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.