Save This Page
Home » apache-ant-1.7.1-src » org.apache.tools » ant » taskdefs » [javadoc | source]
org.apache.tools.ant.taskdefs
public class: War [javadoc | source]
java.lang.Object
   org.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

All Implemented Interfaces:
    SelectorContainer, Cloneable

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.

Fields inherited from org.apache.tools.ant.taskdefs.Zip:
zipFile,  entries,  duplicate,  archiveType,  emptyBehavior,  addedDirs,  doubleFilePass,  skipWriting
Fields inherited from org.apache.tools.ant.taskdefs.MatchingTask:
fileset
Fields inherited from org.apache.tools.ant.Task:
target,  taskName,  taskType,  wrapper
Fields inherited from org.apache.tools.ant.ProjectComponent:
project,  location,  description
Constructor:
 public War() 
Method from org.apache.tools.ant.taskdefs.War Summary:
addClasses,   addLib,   addWebinf,   cleanUp,   initZipOutputStream,   setNeedxmlfile,   setWarfile,   setWebxml,   zipFile
Methods from org.apache.tools.ant.taskdefs.Jar:
addConfiguredIndexJars,   addConfiguredManifest,   addConfiguredService,   addMetainf,   cleanUp,   createEmptyZip,   finalizeZipOutputStream,   findJarName,   getResourcesToAdd,   grabFilesAndDirs,   initZipOutputStream,   reset,   setFilesetmanifest,   setIndex,   setJarfile,   setManifest,   setManifestEncoding,   setStrict,   setWhenempty,   setWhenmanifestonly,   writeIndexLikeList,   zipFile
Methods from org.apache.tools.ant.taskdefs.Zip:
add,   addFileset,   addParentDirs,   addResources,   addResources,   addZipGroupFileset,   addZipfileset,   cleanUp,   createEmptyZip,   execute,   executeMain,   finalizeZipOutputStream,   getComment,   getDestFile,   getEncoding,   getLevel,   getNonFileSetResourcesToAdd,   getResourcesToAdd,   getResourcesToAdd,   grabNonFileSetResources,   grabResources,   hasUpdatedFile,   initZipOutputStream,   isAddingNewFiles,   isCompress,   isEmpty,   isInUpdateMode,   reset,   selectFileResources,   setBasedir,   setComment,   setCompress,   setDestFile,   setDuplicate,   setEncoding,   setFile,   setFilesonly,   setKeepCompression,   setLevel,   setRoundUp,   setUpdate,   setWhenempty,   setZipfile,   zipDir,   zipDir,   zipFile,   zipFile
Methods from org.apache.tools.ant.taskdefs.MatchingTask:
XsetIgnore,   XsetItems,   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
Methods from org.apache.tools.ant.Task:
bindToOwner,   execute,   getOwningTarget,   getRuntimeConfigurableWrapper,   getTaskName,   getTaskType,   getWrapper,   handleErrorFlush,   handleErrorOutput,   handleFlush,   handleInput,   handleOutput,   init,   isInvalid,   log,   log,   log,   log,   markInvalid,   maybeConfigure,   perform,   reconfigure,   setOwningTarget,   setRuntimeConfigurableWrapper,   setTaskName,   setTaskType
Methods from org.apache.tools.ant.ProjectComponent:
clone,   getDescription,   getLocation,   getProject,   log,   log,   setDescription,   setLocation,   setProject
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.tools.ant.taskdefs.War Detail:
 public  void addClasses(ZipFileSet fs) 
    add files under WEB-INF/classes
 public  void addLib(ZipFileSet fs) 
    add files under WEB-INF/lib/
 public  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) throws IOException, BuildException 
    override of parent; validates configuration before initializing the output stream.
 public  void setNeedxmlfile(boolean needxmlfile) 
    Set the policy on the web.xml file, that is, whether or not it is needed
 public  void setWarfile(File warFile) 
Deprecated! since - 1.5.x. Use setDestFile(File) instead

    Deprecated name of the file to create -use destfile instead.
 public  void setWebxml(File descr) 
    set the deployment descriptor to use (WEB-INF/web.xml); required unless update=true
 protected  void zipFile(File file,
    ZipOutputStream zOut,
    String vPath,
    int mode) throws IOException 
    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