org.codehaus.plexus.archiver.war

Class WarArchiver

public class WarArchiver extends JarArchiver

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.

See Also: JarArchiver

Field Summary
FiledeploymentDescriptor
our web.xml deployment descriptor
booleandescriptorAdded
flag set if the descriptor is added
booleanignoreWebxml
flag set if finding the webxml is to be expected.
Constructor Summary
WarArchiver()
Method Summary
voidaddClass(File fileName)
add a file under WEB-INF/lib/
voidaddClasses(File directoryName, String[] includes, String[] excludes)
add files under WEB-INF/classes
voidaddLib(File fileName)
add a file under WEB-INF/lib/
voidaddLibs(File directoryName, String[] includes, String[] excludes)
add files under WEB-INF/lib/
voidaddWebinf(File directoryName, String[] includes, String[] excludes)
files to add under WEB-INF;
protected voidcleanUp()
Make sure we don't think we already have a web.xml next time this task gets executed.
protected voidinitZipOutputStream(ZipOutputStream zOut)
override of parent; validates configuration before initializing the output stream.
voidsetIgnoreWebxml(boolean ignore)
voidsetWebxml(File descr)
set the deployment descriptor to use (WEB-INF/web.xml); required unless update=true
protected voidzipFile(ArchiveEntry entry, ZipOutputStream zOut, String vPath, int mode)
Overridden from ZipArchiver class to deal with web.xml

Field Detail

deploymentDescriptor

private File deploymentDescriptor
our web.xml deployment descriptor

descriptorAdded

private boolean descriptorAdded
flag set if the descriptor is added

ignoreWebxml

private boolean ignoreWebxml
flag set if finding the webxml is to be expected.

Constructor Detail

WarArchiver

public WarArchiver()

Method Detail

addClass

public void addClass(File fileName)
add a file under WEB-INF/lib/

addClasses

public void addClasses(File directoryName, String[] includes, String[] excludes)
add files under WEB-INF/classes

addLib

public void addLib(File fileName)
add a file under WEB-INF/lib/

addLibs

public void addLibs(File directoryName, String[] includes, String[] excludes)
add files under WEB-INF/lib/

addWebinf

public void addWebinf(File directoryName, String[] includes, String[] excludes)
files to add under WEB-INF;

cleanUp

protected void cleanUp()
Make sure we don't think we already have a web.xml next time this task gets executed.

initZipOutputStream

protected void initZipOutputStream(ZipOutputStream zOut)
override of parent; validates configuration before initializing the output stream.

setIgnoreWebxml

public void setIgnoreWebxml(boolean ignore)

setWebxml

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

zipFile

protected void zipFile(ArchiveEntry entry, ZipOutputStream zOut, String vPath, int mode)
Overridden from ZipArchiver class to deal with web.xml