Package org.codehaus.plexus.archiver.jar

Class JarToolModularJarArchiver

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.jar.ModularJarArchiver

org.codehaus.plexus.archiver.jar.JarToolModularJarArchiver

All Implemented Interfaces:

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

public class JarToolModularJarArchiver
extends ModularJarArchiver

A ModularJarArchiver implementation that uses the jar tool provided by java.util.spi.ToolProvider to create modular JAR files.

The basic JAR archive is created by JarArchiver and the jar tool is used to upgrade it to modular JAR.

If the JAR file does not contain module descriptor or the JDK does not provide the jar tool (for example JDK prior to Java 9), then the archive created by JarArchiver is left unchanged.

Nested Class Summary

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

JarArchiver.FilesetManifestConfig

Field Summary

Fields

Modifier and Type	Field	Description
private Object	jarTool
private static final String	MODULE_DESCRIPTOR_FILE_NAME
private boolean	moduleDescriptorFound
private static final Pattern	MRJAR_VERSION_AREA

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	Description
JarToolModularJarArchiver()

Method Summary

Modifier and Type	Method	Description
private String[]	getJarToolArguments()	Prepares the arguments for the jar tool.
private boolean	isModuleDescriptor(String path)	Returns true if path is a module descriptor.
protected void	postCreateArchive()	This method is called after the archive creation completes successfully (no exceptions are thrown).
protected void	zipFile(org.apache.commons.compress.parallel.InputStreamSupplier is, ConcurrentJarCreator zOut, String vPath, long lastModified, File fromArchive, int mode, String symlinkDestination, boolean addInParallel)	Overridden from Zip class to deal with manifests and index lists.

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

createManifest, getManifestMainClass, getModuleMainClass, getModuleVersion, reset, setModuleMainClass, setModuleVersion

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

addConfiguredIndexJars, addConfiguredManifest, cleanUp, createEmptyZip, finalizeZipOutputStream, findJarName, grabFilesAndDirs, hasVirtualFiles, initZipOutputStream, setFilesetmanifest, setIndex, setManifest, setManifestEncoding, setMinimalDefaultManifest, writeIndexLikeList

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

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

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, configureReproducible, contextualize, createArchive, getDefaultDirectoryMode, getDefaultFileMode, getDestFile, getDirectoryMode, getDuplicateBehavior, getFileMode, getFilenameComparator, getFiles, getIncludeEmptyDirs, getLastModifiedDate, getLogger, getOverrideDirectoryMode, getOverrideFileMode, getOverrideGid, getOverrideGroupName, getOverrideUid, getOverrideUserName, getRawDefaultFileMode, getResources, isForced, isIgnorePermissions, isUptodate, isUseJvmChmod, runArchiveFinalizers, setArchiveFinalizers, setDefaultDirectoryMode, setDefaultFileMode, setDestFile, setDirectoryMode, setDotFileDirectory, setDuplicateBehavior, setFileMode, setFilenameComparator, setForced, setIgnorePermissions, setIncludeEmptyDirs, setLastModifiedDate, setOverrideGid, setOverrideGroupName, setOverrideUid, setOverrideUserName, 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 Details

MODULE_DESCRIPTOR_FILE_NAME

private static final String MODULE_DESCRIPTOR_FILE_NAME

See Also:

• Constant Field Values

MRJAR_VERSION_AREA

private static final Pattern MRJAR_VERSION_AREA

jarTool

private Object jarTool

moduleDescriptorFound

private boolean moduleDescriptorFound

Constructor Details

JarToolModularJarArchiver

public JarToolModularJarArchiver()

Method Details

zipFile

protected void zipFile(org.apache.commons.compress.parallel.InputStreamSupplier is,
 ConcurrentJarCreator zOut,
 String vPath,
 long lastModified,
 File fromArchive,
 int mode,
 String symlinkDestination,
 boolean addInParallel)
                throws IOException,
ArchiverException

Description copied from class: JarArchiver

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

Overrides:

zipFile in class JarArchiver

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

addInParallel - Indicates if the entry should be add in parallel. If set to false it is added synchronously. If the entry is symbolic link this parameter is ignored.

Throws:

IOException

ArchiverException

postCreateArchive

protected void postCreateArchive()
                          throws ArchiverException

Description copied from class: AbstractArchiver

This method is called after the archive creation completes successfully (no exceptions are thrown). Subclasses may override this method in order to augment or validate the archive after it is created.

Overrides:

postCreateArchive in class AbstractArchiver

Throws:

ArchiverException

isModuleDescriptor

private boolean isModuleDescriptor(String path)

Returns true if path is a module descriptor.

getJarToolArguments

private String[] getJarToolArguments()
                              throws IOException

Prepares the arguments for the jar tool. It takes into account the module version, main class, etc.

Throws:

IOException