2001-04-03 12:49:54 +00:00
< html >
< head >
< meta http-equiv = "Content-Language" content = "en-us" >
2001-10-30 10:05:39 +00:00
< title > Apache Ant User Manual< / title >
2001-04-03 12:49:54 +00:00
< / head >
< body >
< h2 > < a name = "ear" > Ear< / 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 an Enterprise Application archive.< / p >
< p > (The Ear task is a shortcut for specifying the particular layout of a EAR 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 >
2001-04-04 13:35:05 +00:00
< 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 Ear task.< / p >
2001-04-03 12:49:54 +00:00
< 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 EAR file to create.< / td >
2001-04-03 12:49:54 +00:00
< td valign = "top" align = "center" > Yes< / td >
< / tr >
< tr >
< td valign = "top" > appxml< / td >
< td valign = "top" > The deployment descriptor to use (META-INF/application.xml).< / td >
2001-12-11 14:55:45 +00:00
< td valign = "top" align = "center" > Yes, unless update is set to true< / td >
2001-04-03 12:49:54 +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-04-03 12:49:54 +00:00
< tr >
< td valign = "top" > includes< / td >
< td valign = "top" > comma separated list of patterns of files that must be
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 >
< td valign = "top" > comma separated list of patterns of files that must be
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
the destination file if it already exists.< / td >
< td valign = "top" align = "center" > No< / td >
< / tr >
2001-04-03 12:49:54 +00:00
< / table >
2001-04-04 13:35:05 +00:00
< h3 > Nested elements< / h3 >
< 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 ear file. If this
fileset includes a file named < code > MANIFEST.MF< / code > , the file is
ignored and you will get a warning.< / p >
2001-04-03 12:49:54 +00:00
< h2 > Example< / h2 >
< pre >
2002-01-07 06:22:11 +00:00
< ear destfile=" ${build.dir}/myapp.ear" appxml=" ${src.dir}/metadata/application.xml" >
2001-08-30 13:23:14 +00:00
< fileset dir=" ${build.dir}" includes=" *.jar,*.war" />
2001-04-03 12:49:54 +00:00
< /ear>
< / pre >
< hr >
2002-01-10 08:48:33 +00:00
< p align = "center" > Copyright © 2001-2002 Apache Software Foundation. All rights
2001-04-03 12:49:54 +00:00
Reserved.< / p >
< / body >
< / html >
