org.codehaus.plexus.archiver.war

Class WarArchiver

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.codehaus.plexus.archiver.AbstractArchiver

org.codehaus.plexus.archiver.zip.AbstractZipArchiver

org.codehaus.plexus.archiver.zip.ZipArchiver

org.codehaus.plexus.archiver.jar.JarArchiver

org.codehaus.plexus.archiver.war.WarArchiver

All Implemented Interfaces:

Archiver, FinalizerEnabled, org.codehaus.plexus.logging.LogEnabled, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

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

Nested Class Summary

Nested classes/interfaces inherited from class org.codehaus.plexus.archiver.jar.JarArchiver

JarArchiver.FilesetManifestConfig

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	deploymentDescriptor our web.xml deployment descriptor
private boolean	descriptorAdded flag set if the descriptor is added
private boolean	expectWebXml flag set if finding the webxml is to be expected.

Fields inherited from class org.codehaus.plexus.archiver.zip.AbstractZipArchiver

addedDirs, addingNewFiles, archiveType, doubleFilePass, duplicate, entries, skipWriting, zipArchiveOutputStream

Fields inherited from interface org.codehaus.plexus.archiver.Archiver

DEFAULT_DIR_MODE, DEFAULT_FILE_MODE, DEFAULT_SYMLILNK_MODE, DUPLICATES_ADD, DUPLICATES_FAIL, DUPLICATES_PRESERVE, DUPLICATES_SKIP, DUPLICATES_VALID_BEHAVIORS, ROLE

Constructor Summary

Constructors

Constructor and Description
WarArchiver()

Method Summary

Modifier and Type	Method and Description
void	addClass(java.io.File fileName) add a file under WEB-INF/lib/
void	addClasses(java.io.File directoryName, java.lang.String[] includes, java.lang.String[] excludes) add files under WEB-INF/classes
void	addLib(java.io.File fileName) add a file under WEB-INF/lib/
void	addLibs(java.io.File directoryName, java.lang.String[] includes, java.lang.String[] excludes) add files under WEB-INF/lib/
void	addWebinf(java.io.File directoryName, java.lang.String[] includes, java.lang.String[] excludes) 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(ConcurrentJarCreator zOut) override of parent; validates configuration before initializing the output stream.
void	setExpectWebXml(boolean expectWebXml) Indicates if the client is required to supply web.xml
void	setIgnoreWebxml(boolean excpectWebXml) Deprecated. Use setExpectWebXml instead !
void	setWebxml(java.io.File descr) set the deployment descriptor to use (WEB-INF/web.xml); required unless update=true
protected void	zipFile(ArchiveEntry entry, ConcurrentJarCreator zOut, java.lang.String vPath) Overridden from ZipArchiver class to deal with web.xml

Methods inherited from class org.codehaus.plexus.archiver.jar.JarArchiver

addConfiguredIndexJars, addConfiguredManifest, createEmptyZip, finalizeZipOutputStream, findJarName, grabFilesAndDirs, hasVirtualFiles, reset, setFilesetmanifest, setIndex, setManifest, setManifestEncoding, writeIndexLikeList, zipFile

Methods inherited from class org.codehaus.plexus.archiver.zip.AbstractZipArchiver

addResources, close, createInputStreamSupplier, execute, getArchiveType, getComment, getEncoding, isCompress, isFilesonly, isInUpdateMode, isRecompressAddedZips, isSupportingForced, revert, setComment, setCompress, setEncoding, setFilesonly, setRecompressAddedZips, setUpdateMode, zipDir

Methods inherited from class org.codehaus.plexus.archiver.AbstractArchiver

addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchiveFinalizer, addDirectory, addDirectory, addDirectory, addDirectory, addFile, addFile, addFileSet, addResource, addResources, addSymlink, addSymlink, asArchiveEntry, asResourceCollection, checkForced, contextualize, createArchive, getDefaultDirectoryMode, getDefaultFileMode, getDestFile, getDirectoryMode, getDuplicateBehavior, getFileMode, getFiles, getIncludeEmptyDirs, getLogger, getOverrideDirectoryMode, getOverrideFileMode, getRawDefaultFileMode, getResources, isForced, isIgnorePermissions, isUptodate, isUseJvmChmod, runArchiveFinalizers, setArchiveFinalizers, setDefaultDirectoryMode, setDefaultFileMode, setDestFile, setDirectoryMode, setDotFileDirectory, setDuplicateBehavior, setFileMode, setForced, setIgnorePermissions, setIncludeEmptyDirs, setUseJvmChmod, validate

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

deploymentDescriptor

private java.io.File deploymentDescriptor

our web.xml deployment descriptor

expectWebXml

private boolean expectWebXml

flag set if finding the webxml is to be expected.

descriptorAdded

private boolean descriptorAdded

flag set if the descriptor is added

Constructor Detail

WarArchiver

public WarArchiver()

Method Detail

setIgnoreWebxml

@Deprecated
public void setIgnoreWebxml(boolean excpectWebXml)

Deprecated. Use setExpectWebXml instead !

Parameters:

excpectWebXml - true if web xml is *expected* from the client

setExpectWebXml

public void setExpectWebXml(boolean expectWebXml)

Indicates if the client is required to supply web.xml

Parameters:

excpectWebXml - true if web xml is *expected* from the client

setWebxml

public void setWebxml(java.io.File descr)
               throws ArchiverException

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

Throws:

ArchiverException

addLib

public void addLib(java.io.File fileName)
            throws ArchiverException

add a file under WEB-INF/lib/

Throws:

ArchiverException

addLibs

public void addLibs(java.io.File directoryName,
                    java.lang.String[] includes,
                    java.lang.String[] excludes)
             throws ArchiverException

add files under WEB-INF/lib/

Throws:

ArchiverException

addClass

public void addClass(java.io.File fileName)
              throws ArchiverException

add a file under WEB-INF/lib/

Throws:

ArchiverException

addClasses

public void addClasses(java.io.File directoryName,
                       java.lang.String[] includes,
                       java.lang.String[] excludes)
                throws ArchiverException

add files under WEB-INF/classes

Throws:

ArchiverException

addWebinf

public void addWebinf(java.io.File directoryName,
                      java.lang.String[] includes,
                      java.lang.String[] excludes)
               throws ArchiverException

files to add under WEB-INF;

Throws:

ArchiverException

initZipOutputStream

protected void initZipOutputStream(ConcurrentJarCreator zOut)
                            throws ArchiverException,
                                   java.io.IOException

override of parent; validates configuration before initializing the output stream.

Overrides:

initZipOutputStream in class JarArchiver

Parameters:

zOut -

Throws:

ArchiverException

java.io.IOException

zipFile

protected void zipFile(ArchiveEntry entry,
                       ConcurrentJarCreator zOut,
                       java.lang.String vPath)
                throws java.io.IOException,
                       ArchiverException

Overridden from ZipArchiver class to deal with web.xml

Overrides:

zipFile in class AbstractZipArchiver

Parameters:

entry - the file to add to the archive

zOut - the stream to write to

vPath - the name this entry shall have in the archive

Throws:

java.io.IOException

ArchiverException

cleanUp

protected void cleanUp()
                throws java.io.IOException

Make sure we don't think we already have a web.xml next time this task gets executed.

Overrides:

cleanUp in class JarArchiver

Throws:

java.io.IOException

See Also:

AbstractZipArchiver.cleanUp()