Package org.apache.commons.compress.archivers.zip

Class ZipFile

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    Direct Known Subclasses:
    ZipSecureFile
    public class ZipFile
extends java.lang.Object
implements java.io.Closeable
    Replacement for java.util.ZipFile.

    This class adds support for file name encodings other than UTF-8 (which is required to work on ZIP files created by native ZIP tools and is able to skip a preamble like the one found in self extracting archives. Furthermore it returns instances of org.apache.commons.compress.archivers.zip.ZipArchiveEntry instead of java.util.zip.ZipEntry.

    It doesn't extend java.util.zip.ZipFile as it would have to reimplement all methods anyway. Like java.util.ZipFile, it uses SeekableByteChannel under the covers and supports compressed and uncompressed entries. As of Apache Commons Compress 1.3 it also transparently supports Zip64 extensions and thus individual entries and archives larger than 4 GB or with more than 65536 entries.

    The method signatures mimic the ones of java.util.zip.ZipFile, with a couple of exceptions:

    • There is no getName method.
    • entries has been renamed to getEntries.
    • getEntries and getEntry return org.apache.commons.compress.archivers.zip.ZipArchiveEntry instances.
    • close is allowed to throw IOException.

    • Constructor Summary

      Constructors 
      Constructor Description
      ZipFile​(java.io.File f)
      Opens the given file for reading, assuming "UTF8" for file names.
      ZipFile​(java.io.File f, java.lang.String encoding)
      Opens the given file for reading, assuming the specified encoding for file names and scanning for Unicode extra fields.
      ZipFile​(java.io.File f, java.lang.String encoding, boolean useUnicodeExtraFields)
      Opens the given file for reading, assuming the specified encoding for file names.
      ZipFile​(java.io.File f, java.lang.String encoding, boolean useUnicodeExtraFields, boolean ignoreLocalFileHeader)
      Opens the given file for reading, assuming the specified encoding for file names.
      ZipFile​(java.lang.String name)
      Opens the given file for reading, assuming "UTF8".
      ZipFile​(java.lang.String name, java.lang.String encoding)
      Opens the given file for reading, assuming the specified encoding for file names, scanning unicode extra fields.
      ZipFile​(java.nio.channels.SeekableByteChannel channel)
      Opens the given channel for reading, assuming "UTF8" for file names.
      ZipFile​(java.nio.channels.SeekableByteChannel channel, java.lang.String encoding)
      Opens the given channel for reading, assuming the specified encoding for file names.
      ZipFile​(java.nio.channels.SeekableByteChannel channel, java.lang.String archiveName, java.lang.String encoding, boolean useUnicodeExtraFields)
      Opens the given channel for reading, assuming the specified encoding for file names.
      ZipFile​(java.nio.channels.SeekableByteChannel channel, java.lang.String archiveName, java.lang.String encoding, boolean useUnicodeExtraFields, boolean ignoreLocalFileHeader)
      Opens the given channel for reading, assuming the specified encoding for file names.
      ZipFile​(java.nio.file.Path path)
      Opens the given path for reading, assuming "UTF8" for file names.
      ZipFile​(java.nio.file.Path path, java.lang.String encoding)
      Opens the given path for reading, assuming the specified encoding for file names and scanning for Unicode extra fields.
      ZipFile​(java.nio.file.Path path, java.lang.String encoding, boolean useUnicodeExtraFields)
      Opens the given path for reading, assuming the specified encoding for file names.
      ZipFile​(java.nio.file.Path path, java.lang.String encoding, boolean useUnicodeExtraFields, boolean ignoreLocalFileHeader)
      Opens the given path for reading, assuming the specified encoding for file names.

    • Constructor Detail

      • ZipFile

        public ZipFile​(java.io.File f)
        throws java.io.IOException
        Opens the given file for reading, assuming "UTF8" for file names.
        Parameters:
        f - the archive.
        Throws:
        java.io.IOException - if an error occurs while reading the file.

      • ZipFile

        public ZipFile​(java.io.File f,
               java.lang.String encoding)
        throws java.io.IOException
        Opens the given file for reading, assuming the specified encoding for file names and scanning for Unicode extra fields.
        Parameters:
        f - the archive.
        encoding - the encoding to use for file names, use null for the platform's default encoding
        Throws:
        java.io.IOException - if an error occurs while reading the file.

      • ZipFile

        public ZipFile​(java.io.File f,
               java.lang.String encoding,
               boolean useUnicodeExtraFields)
        throws java.io.IOException
        Opens the given file for reading, assuming the specified encoding for file names.
        Parameters:
        f - the archive.
        encoding - the encoding to use for file names, use null for the platform's default encoding
        useUnicodeExtraFields - whether to use InfoZIP Unicode Extra Fields (if present) to set the file names.
        Throws:
        java.io.IOException - if an error occurs while reading the file.

      • ZipFile

        public ZipFile​(java.io.File f,
               java.lang.String encoding,
               boolean useUnicodeExtraFields,
               boolean ignoreLocalFileHeader)
        throws java.io.IOException
        Opens the given file for reading, assuming the specified encoding for file names.

        By default the central directory record and all local file headers of the archive will be read immediately which may take a considerable amount of time when the archive is big. The ignoreLocalFileHeader parameter can be set to true which restricts parsing to the central directory. Unfortunately the local file header may contain information not present inside of the central directory which will not be available when the argument is set to true. This includes the content of the Unicode extra field, so setting ignoreLocalFileHeader to true means useUnicodeExtraFields will be ignored effectively.

        Parameters:
        f - the archive.
        encoding - the encoding to use for file names, use null for the platform's default encoding
        useUnicodeExtraFields - whether to use InfoZIP Unicode Extra Fields (if present) to set the file names.
        ignoreLocalFileHeader - whether to ignore information stored inside the local file header (see the notes in this method's javadoc)
        Throws:
        java.io.IOException - if an error occurs while reading the file.
        Since:
        1.19

      • ZipFile

        public ZipFile​(java.nio.file.Path path)
        throws java.io.IOException
        Opens the given path for reading, assuming "UTF8" for file names.
        Parameters:
        path - path to the archive.
        Throws:
        java.io.IOException - if an error occurs while reading the file.
        Since:
        1.22

      • ZipFile

        public ZipFile​(java.nio.file.Path path,
               java.lang.String encoding)
        throws java.io.IOException
        Opens the given path for reading, assuming the specified encoding for file names and scanning for Unicode extra fields.
        Parameters:
        path - path to the archive.
        encoding - the encoding to use for file names, use null for the platform's default encoding
        Throws:
        java.io.IOException - if an error occurs while reading the file.
        Since:
        1.22

      • ZipFile

        public ZipFile​(java.nio.file.Path path,
               java.lang.String encoding,
               boolean useUnicodeExtraFields)
        throws java.io.IOException
        Opens the given path for reading, assuming the specified encoding for file names.
        Parameters:
        path - path to the archive.
        encoding - the encoding to use for file names, use null for the platform's default encoding
        useUnicodeExtraFields - whether to use InfoZIP Unicode Extra Fields (if present) to set the file names.
        Throws:
        java.io.IOException - if an error occurs while reading the file.
        Since:
        1.22

      • ZipFile

        public ZipFile​(java.nio.file.Path path,
               java.lang.String encoding,
               boolean useUnicodeExtraFields,
               boolean ignoreLocalFileHeader)
        throws java.io.IOException
        Opens the given path for reading, assuming the specified encoding for file names.

        By default the central directory record and all local file headers of the archive will be read immediately which may take a considerable amount of time when the archive is big. The ignoreLocalFileHeader parameter can be set to true which restricts parsing to the central directory. Unfortunately the local file header may contain information not present inside of the central directory which will not be available when the argument is set to true. This includes the content of the Unicode extra field, so setting ignoreLocalFileHeader to true means useUnicodeExtraFields will be ignored effectively.

        Parameters:
        path - path to the archive.
        encoding - the encoding to use for file names, use null for the platform's default encoding
        useUnicodeExtraFields - whether to use InfoZIP Unicode Extra Fields (if present) to set the file names.
        ignoreLocalFileHeader - whether to ignore information stored inside the local file header (see the notes in this method's javadoc)
        Throws:
        java.io.IOException - if an error occurs while reading the file.
        Since:
        1.22

      • ZipFile

        public ZipFile​(java.nio.channels.SeekableByteChannel channel)
        throws java.io.IOException
        Opens the given channel for reading, assuming "UTF8" for file names.

        SeekableInMemoryByteChannel allows you to read from an in-memory archive.

        Parameters:
        channel - the archive.
        Throws:
        java.io.IOException - if an error occurs while reading the file.
        Since:
        1.13

      • ZipFile

        public ZipFile​(java.nio.channels.SeekableByteChannel channel,
               java.lang.String encoding)
        throws java.io.IOException
        Opens the given channel for reading, assuming the specified encoding for file names.

        SeekableInMemoryByteChannel allows you to read from an in-memory archive.

        Parameters:
        channel - the archive.
        encoding - the encoding to use for file names, use null for the platform's default encoding
        Throws:
        java.io.IOException - if an error occurs while reading the file.
        Since:
        1.13

      • ZipFile

        public ZipFile​(java.nio.channels.SeekableByteChannel channel,
               java.lang.String archiveName,
               java.lang.String encoding,
               boolean useUnicodeExtraFields)
        throws java.io.IOException
        Opens the given channel for reading, assuming the specified encoding for file names.

        SeekableInMemoryByteChannel allows you to read from an in-memory archive.

        Parameters:
        channel - the archive.
        archiveName - name of the archive, used for error messages only.
        encoding - the encoding to use for file names, use null for the platform's default encoding
        useUnicodeExtraFields - whether to use InfoZIP Unicode Extra Fields (if present) to set the file names.
        Throws:
        java.io.IOException - if an error occurs while reading the file.
        Since:
        1.13

      • ZipFile

        public ZipFile​(java.nio.channels.SeekableByteChannel channel,
               java.lang.String archiveName,
               java.lang.String encoding,
               boolean useUnicodeExtraFields,
               boolean ignoreLocalFileHeader)
        throws java.io.IOException
        Opens the given channel for reading, assuming the specified encoding for file names.

        SeekableInMemoryByteChannel allows you to read from an in-memory archive.

        By default the central directory record and all local file headers of the archive will be read immediately which may take a considerable amount of time when the archive is big. The ignoreLocalFileHeader parameter can be set to true which restricts parsing to the central directory. Unfortunately the local file header may contain information not present inside of the central directory which will not be available when the argument is set to true. This includes the content of the Unicode extra field, so setting ignoreLocalFileHeader to true means useUnicodeExtraFields will be ignored effectively.

        Parameters:
        channel - the archive.
        archiveName - name of the archive, used for error messages only.
        encoding - the encoding to use for file names, use null for the platform's default encoding
        useUnicodeExtraFields - whether to use InfoZIP Unicode Extra Fields (if present) to set the file names.
        ignoreLocalFileHeader - whether to ignore information stored inside the local file header (see the notes in this method's javadoc)
        Throws:
        java.io.IOException - if an error occurs while reading the file.
        Since:
        1.19

      • ZipFile

        public ZipFile​(java.lang.String name)
        throws java.io.IOException
        Opens the given file for reading, assuming "UTF8".
        Parameters:
        name - name of the archive.
        Throws:
        java.io.IOException - if an error occurs while reading the file.

      • ZipFile

        public ZipFile​(java.lang.String name,
               java.lang.String encoding)
        throws java.io.IOException
        Opens the given file for reading, assuming the specified encoding for file names, scanning unicode extra fields.
        Parameters:
        name - name of the archive.
        encoding - the encoding to use for file names, use null for the platform's default encoding
        Throws:
        java.io.IOException - if an error occurs while reading the file.

    • Method Detail

      • closeQuietly

        public static void closeQuietly​(ZipFile zipFile)
        Closes a ZIP file quietly; throwing no IOException, does nothing on null input.
        Parameters:
        zipFile - file to close, can be null

      • canReadEntryData

        public boolean canReadEntryData​(ZipArchiveEntry ze)
        Whether this class is able to read the given entry.

        May return false if it is set up to use encryption or a compression method that hasn't been implemented yet.

        Parameters:
        ze - the entry
        Returns:
        whether this class is able to read the given entry.
        Since:
        1.1

      • close

        public void close()
           throws java.io.IOException
        Closes the archive.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        java.io.IOException - if an error occurs closing the archive.

      • copyRawEntries

        public void copyRawEntries​(ZipArchiveOutputStream target,
                           ZipArchiveEntryPredicate predicate)
                    throws java.io.IOException
        Transfer selected entries from this ZIP file to a given #ZipArchiveOutputStream. Compression and all other attributes will be as in this file.

        This method transfers entries based on the central directory of the ZIP file.

        Parameters:
        target - The zipArchiveOutputStream to write the entries to
        predicate - A predicate that selects which entries to write
        Throws:
        java.io.IOException - on error

      • getContentBeforeFirstLocalFileHeader

        public java.io.InputStream getContentBeforeFirstLocalFileHeader()
        Gets an InputStream for reading the content before the first local file header.
        Returns:
        null if there is no content before the first local file header. Otherwise, returns a stream to read the content before the first local file header.
        Since:
        1.23

      • getEncoding

        public java.lang.String getEncoding()
        Gets the encoding to use for file names and the file comment.
        Returns:
        null if using the platform's default character encoding.

      • getEntries

        public java.util.Enumeration<ZipArchiveEntry> getEntries()
        Gets all entries.

        Entries will be returned in the same order they appear within the archive's central directory.

        Returns:
        all entries as ZipArchiveEntry instances

      • getEntries

        public java.lang.Iterable<ZipArchiveEntry> getEntries​(java.lang.String name)
        Gets all named entries in the same order they appear within the archive's central directory.
        Parameters:
        name - name of the entry.
        Returns:
        the Iterable<ZipArchiveEntry> corresponding to the given name
        Since:
        1.6

      • getEntriesInPhysicalOrder

        public java.util.Enumeration<ZipArchiveEntry> getEntriesInPhysicalOrder()
        Gets all entries in physical order.

        Entries will be returned in the same order their contents appear within the archive.

        Returns:
        all entries as ZipArchiveEntry instances
        Since:
        1.1

      • getEntriesInPhysicalOrder

        public java.lang.Iterable<ZipArchiveEntry> getEntriesInPhysicalOrder​(java.lang.String name)
        Gets all named entries in the same order their contents appear within the archive.
        Parameters:
        name - name of the entry.
        Returns:
        the Iterable<ZipArchiveEntry> corresponding to the given name
        Since:
        1.6

      • getEntry

        public ZipArchiveEntry getEntry​(java.lang.String name)
        Gets a named entry or null if no entry by that name exists.

        If multiple entries with the same name exist the first entry in the archive's central directory by that name is returned.

        Parameters:
        name - name of the entry.
        Returns:
        the ZipArchiveEntry corresponding to the given name - or null if not present.

      • getFirstLocalFileHeaderOffset

        public long getFirstLocalFileHeaderOffset()
        Gets the offset of the first local file header in the file.
        Returns:
        the length of the content before the first local file header
        Since:
        1.23

      • getInputStream

        public java.io.InputStream getInputStream​(ZipArchiveEntry zipEntry)
                                   throws java.io.IOException
        Gets an InputStream for reading the contents of the given entry.
        Parameters:
        zipEntry - the entry to get the stream for.
        Returns:
        a stream to read the entry from. The returned stream implements InputStreamStatistics.
        Throws:
        java.io.IOException - if unable to create an input stream from the zipEntry.

      • getRawInputStream

        public java.io.InputStream getRawInputStream​(ZipArchiveEntry ze)
                                      throws java.io.IOException
        Gets the raw stream of the archive entry (compressed form).

        This method does not relate to how/if we understand the payload in the stream, since we really only intend to move it on to somewhere else.

        Since version 1.22, this method will make an attempt to read the entry's data stream offset, even if the ignoreLocalFileHeader parameter was true in the constructor. An IOException can also be thrown from the body of the method if this lookup fails for some reason.

        Parameters:
        ze - The entry to get the stream for
        Returns:
        The raw input stream containing (possibly) compressed data.
        Throws:
        java.io.IOException - if there is a problem reading data offset (added in version 1.22).
        Since:
        1.11

      • getUnixSymlink

        public java.lang.String getUnixSymlink​(ZipArchiveEntry entry)
                                throws java.io.IOException
        Gets the entry's content as a String if isUnixSymlink() returns true for it, otherwise returns null.

        This method assumes the symbolic link's file name uses the same encoding that as been specified for this ZipFile.

        Parameters:
        entry - ZipArchiveEntry object that represents the symbolic link
        Returns:
        entry's content as a String
        Throws:
        java.io.IOException - problem with content's input stream
        Since:
        1.5