An extension of <jar> to create a WAR archive.
Contains special treatment for files that should end up in the
WEB-INF/lib, WEB-INF/classes or
WEB-INF directories of the Web Application Archive.
(The War task is a shortcut for specifying the particular layout of a WAR file. The same thing can be accomplished by using the prefix and fullpath attributes of zipfilesets in a Zip or Jar task.)
The extended zipfileset element from the zip task (with attributes prefix, fullpath, and src) is available in the War task.
Jar
| Modifier and Type | Field and Description |
|---|---|
| private File | |
| private File | deploymentDescriptor
our web.xml deployment descriptor |
| private static final FileUtils | |
| private boolean | needxmlfile
flag set if the descriptor is added |
| private static final String | XML_DESCRIPTOR_PATH
path to web.xml file |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | |
| public void | |
| public void | |
| protected void | cleanUp()
Overrides org. |
| protected void | initZipOutputStream(ZipOutputStream
the zip output stream zOut)Overrides org. |
| public void | setNeedxmlfile(boolean
whether a web.xml file is needed. Default: true needxmlfile)Set the policy on the web.xml file, that is, whether or not it is needed |
| public void | setWarfile(File
the destination file warFile)
Deprecated
since 1.5.x.
Use setDestFile(File) instead
Deprecated name of the file to create
-use destfile instead.
|
| public void | |
| protected void | zipFile(File
the file to add to the archive file, ZipOutputStream the stream to write to zOut, String the name this entry shall have in the archive vPath, int the Unix permissions to set. mode)Overrides org. |
| addedWebXmlFile | back to summary |
|---|---|
| private File addedWebXmlFile | |
| deploymentDescriptor | back to summary |
|---|---|
| private File deploymentDescriptor our web.xml deployment descriptor | |
| FILE_UTILS | back to summary |
|---|---|
| private static final FileUtils FILE_UTILS | |
| needxmlfile | back to summary |
|---|---|
| private boolean needxmlfile flag set if the descriptor is added | |
| XML_DESCRIPTOR_PATH | back to summary |
|---|---|
| private static final String XML_DESCRIPTOR_PATH path to web.xml file | |
| War | back to summary |
|---|---|
| public War() Constructor for the War Task. | |
| addClasses | back to summary |
|---|---|
| public void addClasses(ZipFileSet fs) add files under WEB-INF/classes
| |
| addLib | back to summary |
|---|---|
| public void addLib(ZipFileSet fs) add files under WEB-INF/lib/
| |
| addWebinf | back to summary |
|---|---|
| public void addWebinf(ZipFileSet fs) files to add under WEB-INF;
| |
| cleanUp | back to summary |
|---|---|
| protected void cleanUp() Overrides org. Make sure we don't think we already have a web.xml next time this task gets executed.
| |
| initZipOutputStream | back to summary |
|---|---|
| protected void initZipOutputStream(ZipOutputStream zOut) throws IOException, BuildException Overrides org. override of parent; validates configuration before initializing the output stream.
| |
| setNeedxmlfile | back to summary |
|---|---|
| public void setNeedxmlfile(boolean needxmlfile) Set the policy on the web.xml file, that is, whether or not it is needed
| |
| setWarfile | back to summary |
|---|---|
| public void setWarfile(File warFile)
Deprecated since 1.5.x. Use setDestFile(File) instead Deprecated name of the file to create
-use
| |
| setWebxml | back to summary |
|---|---|
| public void setWebxml(File descr) set the deployment descriptor to use (WEB-INF/web.xml);
required unless
| |
| zipFile | back to summary |
|---|---|
| protected void zipFile(File file, ZipOutputStream zOut, String vPath, int mode) throws IOException Overrides org. Overridden from Zip class to deal with web.xml Here are cases that can arise -not a web.xml file : add -first web.xml : add, remember we added it -same web.xml again: skip -alternate web.xml : warn and skip
| |