org.codehaus.plexus.archiver.jar

Class JarArchiver

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

All Implemented Interfaces:

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

Direct Known Subclasses:

EarArchiver, WarArchiver

public class JarArchiver
extends ZipArchiver

Base class for tasks that build archives in JAR file format.

Version:

$Revision$ $Date$

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	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
JarArchiver() constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addConfiguredIndexJars(File indexJar)
void	addConfiguredManifest(Manifest newManifest) Allows the manifest for the archive file to be provided inline in the build file rather than in an external file.
protected void	cleanUp() Make sure we don't think we already have a MANIFEST next time this task gets executed.
protected boolean	createEmptyZip(File zipFile) Create an empty zip file
protected void	finalizeZipOutputStream(org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream zOut)
protected static String	findJarName(String fileName, String[] classpath) try to guess the name of the given file.
protected static void	grabFilesAndDirs(String file, List<String> dirs, List<String> files) Grab lists of all root-level files and all directories contained in the given archive.
protected boolean	hasVirtualFiles()
protected void	initZipOutputStream(org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream zOut) method for subclasses to override
void	reset() reset to default values.
void	setFilesetmanifest(JarArchiver.FilesetManifestConfig config) Behavior when a Manifest is found in a zipfileset or zipgroupfileset file.
void	setIndex(boolean flag) Set whether or not to create an index list for classes.
void	setManifest(File manifestFile) The manifest file to use.
void	setManifestEncoding(String manifestEncoding) Deprecated.
protected void	writeIndexLikeList(List<String> dirs, List<String> files, PrintWriter writer) Writes the directory entries from the first and the filenames from the second list to the given writer, one entry per line.
protected void	zipFile(InputStream is, org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream zOut, String vPath, long lastModified, File fromArchive, int mode, String symlinkDestination) Overridden from Zip class to deal with manifests and index lists.

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

JarArchiver

public JarArchiver()

constructor

Method Detail

setIndex

public void setIndex(boolean flag)

Set whether or not to create an index list for classes. This may speed up classloading in some cases.

Parameters:

flag - true to create an index

setManifestEncoding

@Deprecated
public void setManifestEncoding(String manifestEncoding)

Deprecated.

addConfiguredManifest

public void addConfiguredManifest(Manifest newManifest)
                           throws ManifestException

Allows the manifest for the archive file to be provided inline in the build file rather than in an external file.

Parameters:

newManifest - The new manifest

Throws:

ManifestException - .

setManifest

public void setManifest(File manifestFile)
                 throws ArchiverException

The manifest file to use. This can be either the location of a manifest, or the name of a jar added through a fileset. If its the name of an added jar, the task expects the manifest to be in the jar at META-INF/MANIFEST.MF.

Parameters:

manifestFile - the manifest file to use.

Throws:

ArchiverException - .

setFilesetmanifest

public void setFilesetmanifest(JarArchiver.FilesetManifestConfig config)

Behavior when a Manifest is found in a zipfileset or zipgroupfileset file. Valid values are "skip", "merge", and "mergewithoutmain". "merge" will merge all of manifests together, and merge this into any other specified manifests. "mergewithoutmain" merges everything but the Main section of the manifests. Default value is "skip".

Note: if this attribute's value is not "skip", the created jar will not be readable by using java.util.jar.JarInputStream

Parameters:

config - setting for found manifest behavior.

addConfiguredIndexJars

public void addConfiguredIndexJars(File indexJar)

Parameters:

indexJar - The indexjar

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 AbstractZipArchiver

Throws:

IOException

ArchiverException

hasVirtualFiles

protected boolean hasVirtualFiles()

Overrides:

hasVirtualFiles in class AbstractArchiver

finalizeZipOutputStream

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

Overrides:

finalizeZipOutputStream in class AbstractZipArchiver

Throws:

IOException

ArchiverException

zipFile

protected void zipFile(InputStream is,
           org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream zOut,
           String vPath,
           long lastModified,
           File fromArchive,
           int mode,
           String symlinkDestination)
                throws IOException,
                       ArchiverException

Overridden from Zip class to deal with manifests and index lists.

Overrides:

zipFile in class AbstractZipArchiver

Parameters:

is - the stream to read data for the entry from.

zOut - the stream to write to.

vPath - the name this entry shall have in the archive.

lastModified - last modification time for the entry.

fromArchive - the original archive we are copying this

Throws:

IOException

ArchiverException

createEmptyZip

protected boolean createEmptyZip(File zipFile)
                          throws ArchiverException

Description copied from class: AbstractZipArchiver

Create an empty zip file

Overrides:

createEmptyZip in class AbstractZipArchiver

Parameters:

zipFile - The file

Returns:

true for historic reasons

Throws:

ArchiverException

cleanUp

protected void cleanUp()

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

Overrides:

cleanUp in class AbstractZipArchiver

See Also:

AbstractZipArchiver.cleanUp()

reset

public void reset()

reset to default values.

Overrides:

reset in class AbstractZipArchiver

See Also:

AbstractZipArchiver.reset()

writeIndexLikeList

protected final void writeIndexLikeList(List<String> dirs,
                      List<String> files,
                      PrintWriter writer)

Writes the directory entries from the first and the filenames from the second list to the given writer, one entry per line.

Parameters:

dirs - The directories

files - The files

writer - The printwriter ;)

findJarName

protected static String findJarName(String fileName,
                 String[] classpath)

try to guess the name of the given file.

If this jar has a classpath attribute in its manifest, we can assume that it will only require an index of jars listed there. try to find which classpath entry is most likely the one the given file name points to.

In the absence of a classpath attribute, assume the other files will be placed inside the same directory as this jar and use their basename.

if there is a classpath and the given file doesn't match any of its entries, return null.

Parameters:

fileName - .

classpath - .

Returns:

The guessed name

grabFilesAndDirs

protected static void grabFilesAndDirs(String file,
                    List<String> dirs,
                    List<String> files)
                                throws IOException

Grab lists of all root-level files and all directories contained in the given archive.

Parameters:

file - .

files - .

dirs - .

Throws:

IOException - .