Package org.apache.tools.ant.taskdefs

Class War

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:
java.lang.Cloneable, SelectorContainer
public class War
extends Jar

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.

Since:
Ant 1.2
See Also:
Jar

  • Constructor Details

    • War

      public War()
      Constructor for the War Task.

  • Method Details

    • setWarfile

      @Deprecated public void setWarfile​(java.io.File warFile)
      Deprecated.
      since 1.5.x. Use setDestFile(File) instead
      Deprecated name of the file to create -use destfile instead.
      Parameters:
      warFile - the destination file

    • setWebxml

      public void setWebxml​(java.io.File descr)
      set the deployment descriptor to use (WEB-INF/web.xml); required unless update=true
      Parameters:
      descr - the deployment descriptor file

    • setNeedxmlfile

      public void setNeedxmlfile​(boolean needxmlfile)
      Set the policy on the web.xml file, that is, whether or not it is needed
      Parameters:
      needxmlfile - whether a web.xml file is needed. Default: true

    • addLib

      public void addLib​(ZipFileSet fs)
      add files under WEB-INF/lib/
      Parameters:
      fs - the zip file set to add

    • addClasses

      public void addClasses​(ZipFileSet fs)
      add files under WEB-INF/classes
      Parameters:
      fs - the zip file set to add

    • addWebinf

      public void addWebinf​(ZipFileSet fs)
      files to add under WEB-INF;
      Parameters:
      fs - the zip file set to add

    • initZipOutputStream

      protected void initZipOutputStream​(ZipOutputStream zOut) throws java.io.IOException, BuildException
      override of parent; validates configuration before initializing the output stream.
      Overrides:
      initZipOutputStream in class Jar
      Parameters:
      zOut - the zip output stream
      Throws:
      java.io.IOException - on output error
      BuildException - if invalid configuration

    • zipFile

      protected void zipFile​(java.io.File file, ZipOutputStream zOut, java.lang.String vPath, int mode) throws java.io.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
      Overrides:
      zipFile in class Zip
      Parameters:
      file - the file to add to the archive
      zOut - the stream to write to
      vPath - the name this entry shall have in the archive
      mode - the Unix permissions to set.
      Throws:
      java.io.IOException - on output error

    • cleanUp

      protected void cleanUp()
      Make sure we don't think we already have a web.xml next time this task gets executed.
      Overrides:
      cleanUp in class Jar
      See Also:
      Zip.cleanUp()