org.codehaus.plexus.archiver.ear

Class EarArchiver

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.ear.EarArchiver

All Implemented Interfaces:

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

public class EarArchiver
extends JarArchiver

Creates a EAR archive. Based on WAR task

Nested Class Summary

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

JarArchiver.FilesetManifestConfig

Field Summary

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

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

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
EarArchiver() Create an Ear.

Method Summary

Methods

Modifier and Type	Method and Description
void	addArchive(File fileName) Adds archive.
void	addArchives(File directoryName, String[] includes, String[] excludes) Adds archives.
protected void	cleanUp() Make sure we don't think we already have a application.xml next time this task gets executed.
protected void	initZipOutputStream(org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream zOut) method for subclasses to override
void	setAppxml(File descr) File to incorporate as application.xml.
protected void	zipFile(ArchiveEntry entry, org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream zOut, String vPath, int mode) Overridden from ZipArchiver class to deal with application.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

addParentDirs, addResources, close, copy, execute, getArchiveType, getComment, getEncoding, getZipEntryNames, isCompress, isFileAdded, isFilesonly, isFileUpdated, isInUpdateMode, isRecompressAddedZips, isSupportingForced, revert, setComment, setCompress, setEncoding, setFilesonly, setRecompressAddedZips, setUpdateMode, zipDir, zipFile

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

addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchiveFinalizer, addDirectory, addDirectory, addDirectory, addDirectory, addFile, addFile, addFileSet, addResource, addResources, addSymlink, addSymlink, asArchiveEntry, asArchiveEntry, asResourceCollection, checkForced, contextualize, createArchive, getArchiveFinalizers, getDefaultDirectoryMode, getDefaultFileMode, getDestFile, getDirectoryMode, getDirs, getDuplicateBehavior, getFileMode, getFiles, getIncludeEmptyDirs, getLogger, getOverrideDirectoryMode, getOverrideFileMode, getRawDefaultDirectoryMode, getRawDefaultFileMode, getResources, isForced, isIgnorePermissions, isUptodate, isUseJvmChmod, runArchiveFinalizers, setArchiveFilters, 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

Constructor Detail

EarArchiver

public EarArchiver()

Create an Ear.

Method Detail

setAppxml

public void setAppxml(File descr)
               throws ArchiverException

File to incorporate as application.xml.

Throws:

ArchiverException

addArchive

public void addArchive(File fileName)
                throws ArchiverException

Adds archive.

Throws:

ArchiverException

addArchives

public void addArchives(File directoryName,
               String[] includes,
               String[] excludes)
                 throws ArchiverException

Adds archives.

Throws:

ArchiverException

initZipOutputStream

protected void initZipOutputStream(org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream zOut)
                            throws IOException,
                                   ArchiverException

Description copied from class: AbstractZipArchiver

method for subclasses to override

Overrides:

initZipOutputStream in class JarArchiver

Throws:

IOException

ArchiverException

zipFile

protected void zipFile(ArchiveEntry entry,
           org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream zOut,
           String vPath,
           int mode)
                throws IOException,
                       ArchiverException

Overridden from ZipArchiver class to deal with application.xml

Throws:

IOException

ArchiverException

cleanUp

protected void cleanUp()

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

Overrides:

cleanUp in class JarArchiver

See Also:

AbstractZipArchiver.cleanUp()