2001-02-13 12:32:01 +00:00
< html >
< head >
< meta http-equiv = "Content-Language" content = "en-us" >
2002-02-03 22:00:42 +00:00
< title > WAR Task< / title >
2001-02-13 12:32:01 +00:00
< / head >
< body >
< h2 > < a name = "war" > War< / a > < / h2 >
< h3 > Description< / h3 >
< p > An extension of the < a href = "jar.html" > Jar< / a > task with special
treatment for files that should end up in the
< code > WEB-INF/lib< / code > , < code > WEB-INF/classes< / code > or
< code > WEB-INF< / code > directories of the Web Application Archive.< / p >
< p > (The War task is a shortcut for specifying the particular layout of a WAR file.
The same thing can be accomplished by using the < i > prefix< / i > and < i > fullpath< / i >
attributes of zipfilesets in a Zip or Jar task.)< / p >
< p > The extended zipfileset element from the zip task (with attributes < i > prefix< / i > , < i > fullpath< / i > , and < i > src< / i > ) is available in the War task.< / p >
< h3 > Parameters< / h3 >
< table border = "1" cellpadding = "2" cellspacing = "0" >
< tr >
< td valign = "top" > < b > Attribute< / b > < / td >
< td valign = "top" > < b > Description< / b > < / td >
< td align = "center" valign = "top" > < b > Required< / b > < / td >
< / tr >
< tr >
2002-01-07 06:22:11 +00:00
< td valign = "top" > destfile< / td >
< td valign = "top" > the WAR file to create.< / td >
2003-04-17 13:09:19 +00:00
< td align = "center" valign = "top" rowspan = "2" > Exactly one of the two.< / td >
2001-02-13 12:32:01 +00:00
< / tr >
2002-06-22 23:38:38 +00:00
< tr >
< td valign = "top" > warfile< / td >
< td valign = "top" > < i > Deprecated< i > name of the file to create
-use < tt > destfile< / tt > instead.< / td >
< / tr >
2001-02-13 12:32:01 +00:00
< tr >
< td valign = "top" > webxml< / td >
< td valign = "top" > The deployment descriptor to use (WEB-INF/web.xml).< / td >
2001-12-11 14:55:45 +00:00
< td valign = "top" align = "center" > Yes, unless update is set to true< / td >
2001-02-13 12:32:01 +00:00
< / tr >
< tr >
< td valign = "top" > basedir< / td >
< td valign = "top" > the directory from which to jar the files.< / td >
< td valign = "top" align = "center" > No< / td >
< / tr >
< tr >
< td valign = "top" > compress< / td >
< td valign = "top" > Not only store data but also compress them, defaults to true< / td >
< td align = "center" valign = "top" > No< / td >
< / tr >
2001-07-05 13:10:26 +00:00
< tr >
< td valign = "top" > encoding< / td >
< td valign = "top" > The character encoding to use for filenames
inside the archive. Defaults to UTF8. < strong > It is not
recommended to change this value as the created archive will most
likely be unreadable for Java otherwise.< / strong > < / td >
< td align = "center" valign = "top" > No< / td >
< / tr >
2001-07-12 07:36:50 +00:00
< tr >
< td valign = "top" > filesonly< / td >
< td valign = "top" > Store only file entries, defaults to false< / td >
< td align = "center" valign = "top" > No< / td >
< / tr >
2001-02-13 12:32:01 +00:00
< tr >
< td valign = "top" > includes< / td >
2002-06-22 23:38:38 +00:00
< td valign = "top" > comma- or space-separated list of patterns of files that must be
2001-02-13 12:32:01 +00:00
included. All files are included when omitted.< / td >
< td valign = "top" align = "center" > No< / td >
< / tr >
< tr >
< td valign = "top" > includesfile< / td >
< td valign = "top" > the name of a file. Each line of this file is
taken to be an include pattern< / td >
< td valign = "top" align = "center" > No< / td >
< / tr >
< tr >
< td valign = "top" > excludes< / td >
2002-06-22 23:38:38 +00:00
< td valign = "top" > comma- or space-separated list of patterns of files that must be
2001-02-13 12:32:01 +00:00
excluded. No files (except default excludes) are excluded when omitted.< / td >
< td valign = "top" align = "center" > No< / td >
< / tr >
< tr >
< td valign = "top" > excludesfile< / td >
< td valign = "top" > the name of a file. Each line of this file is
taken to be an exclude pattern< / td >
< td valign = "top" align = "center" > No< / td >
< / tr >
< tr >
< td valign = "top" > defaultexcludes< / td >
< td valign = "top" > indicates whether default excludes should be used or not
(" yes" /" no" ). Default excludes are used when omitted.< / td >
< td valign = "top" align = "center" > No< / td >
< / tr >
< tr >
< td valign = "top" > manifest< / td >
< td valign = "top" > the manifest file to use.< / td >
< td valign = "top" align = "center" > No< / td >
< / tr >
2001-08-30 13:23:14 +00:00
< tr >
< td valign = "top" > update< / td >
< td valign = "top" > indicates whether to update or overwrite
2003-04-11 13:31:18 +00:00
the destination file if it already exists. Default is " false" .< / td >
2001-08-30 13:23:14 +00:00
< td valign = "top" align = "center" > No< / td >
< / tr >
2002-07-30 10:38:56 +00:00
< tr >
< td valign = "top" > duplicate< / td >
< td valign = "top" > behavior when a duplicate file is found. Valid values are " add" , " preserve" , and " fail" . The default value is " add" . < / td >
< td valign = "top" align = "center" > No< / td >
< / tr >
2001-02-13 12:32:01 +00:00
< / table >
< h3 > Nested elements< / h3 >
< h4 > lib< / h4 >
< p > The nested < code > lib< / code > element specifies a < a
href="../CoreTypes/fileset.html">FileSet< / a > . All files included in this fileset will
end up in the < code > WEB-INF/lib< / code > directory of the war file.< / p >
< h4 > classes< / h4 >
< p > The nested < code > classes< / code > element specifies a < a
href="../CoreTypes/fileset.html">FileSet< / a > . All files included in this fileset will
end up in the < code > WEB-INF/classes< / code > directory of the war file.< / p >
< h4 > webinf< / h4 >
< p > The nested < code > webinf< / code > element specifies a < a
href="../CoreTypes/fileset.html">FileSet< / a > . All files included in this fileset will
end up in the < code > WEB-INF< / code > directory of the war file. If this
fileset includes a file named < code > web.xml< / code > , the file is
ignored and you will get a warning.< / p >
2001-04-04 13:35:05 +00:00
< h4 > metainf< / h4 >
< p > The nested < code > metainf< / code > element specifies a < a
href="../CoreTypes/fileset.html">FileSet< / a > . All files included in this fileset will
end up in the < code > META-INF< / code > directory of the war file. If this
fileset includes a file named < code > MANIFEST.MF< / code > , the file is
ignored and you will get a warning.< / p >
2001-02-13 12:32:01 +00:00
< h3 > Examples< / h3 >
< p > Assume the following structure in the project's base directory:< / p >
< pre >
thirdparty/libs/jdbc1.jar
thirdparty/libs/jdbc2.jar
build/main/com/myco/myapp/Servlet.class
src/metadata/myapp.xml
src/html/myapp/index.html
src/jsp/myapp/front.jsp
src/graphics/images/gifs/small/logo.gif
src/graphics/images/gifs/large/logo.gif
< / pre >
then the war file < code > myapp.war< / code > created with
< pre >
2002-01-07 06:22:11 +00:00
< war destfile=" myapp.war" webxml=" src/metadata/myapp.xml" >
2001-02-13 12:32:01 +00:00
< fileset dir=" src/html/myapp" />
< fileset dir=" src/jsp/myapp" />
< lib dir=" thirdparty/libs" >
< exclude name=" jdbc1.jar" />
< /lib>
< classes dir=" build/main" />
< zipfileset dir=" src/graphics/images/gifs"
prefix=" images" />
< /war>
< / pre >
will consist of
< pre >
WEB-INF/web.xml
WEB-INF/lib/jdbc2.jar
WEB-INF/classes/com/myco/myapp/Servlet.class
META-INF/MANIFEST.MF
index.html
front.jsp
images/small/logo.gif
images/large/logo.gif
< / pre >
using Ant's default manifest file. The content of
< code > WEB-INF/web.xml< / code > is identical to
< code > src/metadata/myapp.xml< / code > .
2002-10-31 07:23:50 +00:00
We regulary receive bug reports that this task is creating the WEB-INF
directory, and thus it is our fault your webapp doesn't work. The cause
of these complaints lies in WinZip, which turns an all upper-case
directory into an all lower case one in a fit of helpfulness. Please check that
jar xvf yourwebapp.war shows the same behaviour before filing another
report.
2001-02-13 12:32:01 +00:00
< hr >
2003-04-11 13:31:18 +00:00
< p align = "center" > Copyright © 2000-2003 Apache Software Foundation. All rights
2001-02-13 12:32:01 +00:00
Reserved.< / p >
< / body >
< / html >
