Google

War (Apache Ant API)

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:
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
Author:
Stefan Bodewig
See Also:
Jar

Nested Class Summary
 
Nested classes inherited from class org.apache.tools.ant.taskdefs.Jar
Jar.FilesetManifestConfig
 
Nested classes inherited from class org.apache.tools.ant.taskdefs.Zip
Zip.Duplicate, Zip.WhenEmpty
 
Field Summary
 
Fields inherited from class org.apache.tools.ant.taskdefs.Zip
addedDirs, archiveType, duplicate, emptyBehavior, entries, zipFile
 
Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
fileset, useDefaultExcludes
 
Fields inherited from class org.apache.tools.ant.Task
description, location, target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
 
Constructor Summary
War()
           
 
required unless update=true
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()
gets executed.
protected  void initZipOutputStream(ZipOutputStream zOut)
          override of parent; validates configuration before initializing the output stream.
 void setWarfile(java.io.File warFile)
          Deprecated. Use setDestFile(File) instead
 void
protected  void zipFile(java.io.File file, ZipOutputStream zOut, java.lang.String vPath)
          add another file to the stream
 
Methods inherited from class org.apache.tools.ant.taskdefs.Jar
addConfiguredManifest, addMetainf, createEmptyZip, finalizeZipOutputStream, isUpToDate, reset, setIndex, setJarfile, setManifest, setWhenempty, zipFile
 
Methods inherited from class org.apache.tools.ant.taskdefs.Zip
addFiles, addFiles, addFileset, addParentDirs, addZipEntries, addZipfileset, addZipGroupFileset, execute, grabFileNames, grabFiles, grabFiles, isAddingNewFiles, isInUpdateMode, setBasedir, setCompress, setDestFile, setDuplicate, setEncoding, setFile, setFilesonly, setUpdate, setZipfile, zipDir
 
Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
addAnd, addContains, addCustom, addDate, addDepend, addDepth, addFilename, addMajority, addNone, addNot, addOr, addPresent, addSelector, addSize, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

War


public War()
Method Detail

setWarfile


public void setWarfile(java.io.File warFile)
Deprecated. Use setDestFile(File) instead

Deprecated name of the file to create -use destfile instead.




required unless update=true


addLib


public void addLib(ZipFileSet fs)
add files under WEB-INF/lib/


addClasses


public void addClasses(ZipFileSet fs)
add files under WEB-INF/classes


addWebinf


public void addWebinf(ZipFileSet fs)
files to add under WEB-INF;


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
java.io.IOException
BuildException

zipFile


protected void zipFile(java.io.File file,
                       ZipOutputStream zOut,
                       java.lang.String vPath)
                throws java.io.IOException
add another file to the stream

Overrides:
zipFile in class Jar
java.io.IOException

cleanUp


protected void cleanUp()
gets executed.

Overrides:
cleanUp in class Jar
See Also:
Zip.cleanUp()


Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.