Package org.codehaus.plexus.archiver.jar

Class JarArchiver

    • 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

      • setMinimalDefaultManifest

        public void setMinimalDefaultManifest​(boolean minimalDefaultManifest)
        Set whether the default manifest is minimal, thus having only Manifest-Version: 1.0 in it.
        Parameters:
        minimalDefaultManifest - true to create minimal default manifest

      • 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

      • createManifest

        protected Manifest createManifest()
                           throws ArchiverException
        Creates the manifest to be added to the JAR archive. Sub-classes may choose to override this method in order to inspect or modify the JAR manifest file.
        Returns:
        the manifest for the JAR archive.
        Throws:
        ArchiverException

      • 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
        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
        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

      • 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

      • setZipEntryTime

        protected void setZipEntryTime​(org.apache.commons.compress.archivers.zip.ZipArchiveEntry zipEntry,
                               long lastModifiedTime)
        Override the behavior of the Zip Archiver to match the output of the JAR tool.
        Overrides:
        setZipEntryTime in class AbstractZipArchiver
        Parameters:
        zipEntry - to set the last modified time
        lastModifiedTime - to set in the zip entry only if AbstractArchiver.getLastModifiedTime() returns null