| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.MatchingTask
org.apache.tools.ant.taskdefs.Zip
org.apache.tools.ant.taskdefs.Jar
org.apache.tools.ant.taskdefs.War
public class War
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| Nested Class Summary | 
|---|
| Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.Jar | 
|---|
| Jar.FilesetManifestConfig, Jar.StrictMode | 
| Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.Zip | 
|---|
| Zip.ArchiveState, Zip.Duplicate, Zip.UnicodeExtraField, Zip.WhenEmpty, Zip.Zip64ModeAttribute | 
| Field Summary | 
|---|
| Fields inherited from class org.apache.tools.ant.taskdefs.Zip | 
|---|
| addedDirs, archiveType, doubleFilePass, duplicate, emptyBehavior, entries, skipWriting, zipFile | 
| Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask | 
|---|
| fileset | 
| Fields inherited from class org.apache.tools.ant.Task | 
|---|
| target, taskName, taskType, wrapper | 
| Fields inherited from class org.apache.tools.ant.ProjectComponent | 
|---|
| description, location, project | 
| Constructor Summary | |
|---|---|
| War()Constructor for the War Task. | |
| Method Summary | |
|---|---|
|  void | addClasses(ZipFileSet fs)add files under WEB-INF/classes | 
|  void | addLib(ZipFileSet fs)add files under WEB-INF/lib/ | 
|  void | addWebinf(ZipFileSet fs)files to add under WEB-INF; | 
| protected  void | cleanUp()Make sure we don't think we already have a web.xml next time this task gets executed. | 
| protected  void | initZipOutputStream(ZipOutputStream zOut)override of parent; validates configuration before initializing the output stream. | 
|  void | setNeedxmlfile(boolean needxmlfile)Set the policy on the web.xml file, that is, whether or not it is needed | 
|  void | setWarfile(java.io.File warFile)Deprecated. since 1.5.x. Use setDestFile(File) instead | 
|  void | setWebxml(java.io.File descr)set the deployment descriptor to use (WEB-INF/web.xml); required unless update=true | 
| protected  void | zipFile(java.io.File file,
        ZipOutputStream zOut,
        java.lang.String vPath,
        int mode)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 | 
| Methods inherited from class org.apache.tools.ant.taskdefs.Jar | 
|---|
| addConfiguredIndexJars, addConfiguredManifest, addConfiguredService, addMetainf, createEmptyZip, finalizeZipOutputStream, findJarName, getResourcesToAdd, grabFilesAndDirs, reset, setFilesetmanifest, setFlattenAttributes, setIndex, setIndexMetaInf, setJarfile, setManifest, setManifestEncoding, setMergeClassPathAttributes, setStrict, setWhenempty, setWhenmanifestonly, writeIndexLikeList, zipFile | 
| Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask | 
|---|
| add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems | 
| Methods inherited from class org.apache.tools.ant.Task | 
|---|
| bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType | 
| Methods inherited from class org.apache.tools.ant.ProjectComponent | 
|---|
| clone, getDescription, getLocation, getProject, setDescription, setLocation | 
| Methods inherited from class java.lang.Object | 
|---|
| equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
|---|
public War()
| Method Detail | 
|---|
@Deprecated public void setWarfile(java.io.File warFile)
warFile - the destination filepublic void setWebxml(java.io.File descr)
descr - the deployment descriptor filepublic void setNeedxmlfile(boolean needxmlfile)
needxmlfile - whether a web.xml file is needed. Default: truepublic void addLib(ZipFileSet fs)
fs - the zip file set to addpublic void addClasses(ZipFileSet fs)
fs - the zip file set to addpublic void addWebinf(ZipFileSet fs)
fs - the zip file set to add
protected void initZipOutputStream(ZipOutputStream zOut)
                            throws java.io.IOException,
                                   BuildException
initZipOutputStream in class JarzOut - the zip output stream
java.io.IOException - on output error
BuildException - if invalid configuration
protected void zipFile(java.io.File file,
                       ZipOutputStream zOut,
                       java.lang.String vPath,
                       int mode)
                throws java.io.IOException
zipFile in class Zipfile - the file to add to the archivezOut - the stream to write tovPath - the name this entry shall have in the archivemode - the Unix permissions to set.
java.io.IOException - on output errorprotected void cleanUp()
cleanUp in class JarZip.cleanUp()| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||