- java.lang.Object
- 
- java.util.zip.ZipFile
- 
- java.util.jar.JarFile
 
 
- 
- All Implemented Interfaces:
- Closeable,- AutoCloseable
 
 public class JarFile extends ZipFile TheJarFileclass is used to read the contents of a jar file from any file that can be opened withjava.io.RandomAccessFile. It extends the classjava.util.zip.ZipFilewith support for reading an optionalManifestentry, and support for processing multi-release jar files. TheManifestcan be used to specify meta-information about the jar file and its entries.A multi-release jar file is a jar file that contains a manifest with a main attribute named "Multi-Release", a set of "base" entries, some of which are public classes with public or protected methods that comprise the public interface of the jar file, and a set of "versioned" entries contained in subdirectories of the "META-INF/versions" directory. The versioned entries are partitioned by the major version of the Java platform. A versioned entry, with a version n,8 < n, in the "META-INF/versions/{n}" directory overrides the base entry as well as any entry with a version numberiwhere8 < i < n.By default, a JarFilefor a multi-release jar file is configured to process the multi-release jar file as if it were a plain (unversioned) jar file, and as such an entry name is associated with at most one base entry. TheJarFilemay be configured to process a multi-release jar file by creating theJarFilewith theJarFile(File, boolean, int, Runtime.Version)constructor. TheRuntime.Versionobject sets a maximum version used when searching for versioned entries. When so configured, an entry name can correspond with at most one base entry and zero or more versioned entries. A search is required to associate the entry name with the latest versioned entry whose version is less than or equal to the maximum version (seegetEntry(String)).Class loaders that utilize JarFileto load classes from the contents ofJarFileentries should construct theJarFileby invoking theJarFile(File, boolean, int, Runtime.Version)constructor with the valueRuntime.version()assigned to the last argument. This assures that classes compatible with the major version of the running JVM are loaded from multi-release jar files.If the verifyflag is on when opening a signed jar file, the content of the jar entry is verified against the signature embedded inside the manifest that is associated with itspath name. For a multi-release jar file, the content of a versioned entry is verfieid against its own signature andJarEntry.getCodeSigners()returns its own signers. Please note that the verification process does not include validating the signer's certificate. A caller should inspect the return value ofJarEntry.getCodeSigners()to further determine if the signature can be trusted.Unless otherwise noted, passing a nullargument to a constructor or method in this class will cause aNullPointerExceptionto be thrown.- Implementation Note:
- If the API can not be used to configure aJarFile(e.g. to override the configuration of a compiled application or library), twoSystemproperties are available.- 
 jdk.util.jar.versioncan be assigned a value that is theStringrepresentation of a non-negative integer<= Runtime.version().feature(). The value is used to set the effective runtime version to something other than the default value obtained by evaluatingRuntime.version().feature(). The effective runtime version is the version that theJarFile(File, boolean, int, Runtime.Version)constructor uses when the value of the last argument isJarFile.runtimeVersion().
- 
 jdk.util.jar.enableMultiReleasecan be assigned one of the threeStringvalues true, false, or force. The value true, the default value, enables multi-release jar file processing. The value false disables multi-release jar processing, ignoring the "Multi-Release" manifest attribute, and the versioned directories in a multi-release jar file if they exist. Furthermore, the methodisMultiRelease()returns false. The value force causes theJarFileto be initialized to runtime versioning after construction. It effectively does the same as this code:(new JarFile(File, boolean, int, JarFile.runtimeVersion()).
 
- 
 
- Since:
- 1.2
- See Also:
- Manifest,- ZipFile,- JarEntry
 
- 
- 
Field SummaryFields Modifier and Type Field Description static intCENATTstatic intCENATXstatic intCENCOMstatic intCENCRCstatic intCENDSKstatic intCENEXTstatic intCENFLGstatic intCENHDRstatic intCENHOWstatic intCENLENstatic intCENNAMstatic intCENOFFstatic longCENSIGstatic intCENSIZstatic intCENTIMstatic intCENVEMstatic intCENVERstatic intENDCOMstatic intENDHDRstatic intENDOFFstatic longENDSIGstatic intENDSIZstatic intENDSUBstatic intENDTOTstatic intEXTCRCstatic intEXTHDRstatic intEXTLENstatic longEXTSIGstatic intEXTSIZstatic intLOCCRCstatic intLOCEXTstatic intLOCFLGstatic intLOCHDRstatic intLOCHOWstatic intLOCLENstatic intLOCNAMstatic longLOCSIGstatic intLOCSIZstatic intLOCTIMstatic intLOCVERstatic StringMANIFEST_NAMEThe JAR manifest file name.- 
Fields declared in class java.util.zip.ZipFileOPEN_DELETE, OPEN_READ
 
- 
 - 
Constructor SummaryConstructors Constructor Description JarFile(File file)Creates a newJarFileto read from the specifiedFileobject.JarFile(File file, boolean verify)Creates a newJarFileto read from the specifiedFileobject.JarFile(File file, boolean verify, int mode)Creates a newJarFileto read from the specifiedFileobject in the specified mode.JarFile(File file, boolean verify, int mode, Runtime.Version version)Creates a newJarFileto read from the specifiedFileobject in the specified mode.JarFile(String name)Creates a newJarFileto read from the specified filename.JarFile(String name, boolean verify)Creates a newJarFileto read from the specified filename.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Runtime.VersionbaseVersion()Returns the version that represents the unversioned configuration of a multi-release jar file.Enumeration<JarEntry>entries()Returns an enumeration of the jar file entries.ZipEntrygetEntry(String name)Returns theZipEntryfor the given base entry name ornullif not found.InputStreamgetInputStream(ZipEntry ze)Returns an input stream for reading the contents of the specified zip file entry.JarEntrygetJarEntry(String name)Returns theJarEntryfor the given base entry name ornullif not found.ManifestgetManifest()Returns the jar file manifest, ornullif none.Runtime.VersiongetVersion()Returns the maximum version used when searching for versioned entries.booleanisMultiRelease()Indicates whether or not this jar file is a multi-release jar file.static Runtime.VersionruntimeVersion()Returns the version that represents the effective runtime versioned configuration of a multi-release jar file.Stream<JarEntry>stream()Returns an orderedStreamover the jar file entries.Stream<JarEntry>versionedStream()Returns aStreamof the versioned jar file entries.
 
- 
- 
- 
Field Detail- 
MANIFEST_NAMEpublic static final String MANIFEST_NAME The JAR manifest file name.- See Also:
- Constant Field Values
 
 - 
LOCSIGpublic static final long LOCSIG - See Also:
- Constant Field Values
 
 - 
EXTSIGpublic static final long EXTSIG - See Also:
- Constant Field Values
 
 - 
CENSIGpublic static final long CENSIG - See Also:
- Constant Field Values
 
 - 
ENDSIGpublic static final long ENDSIG - See Also:
- Constant Field Values
 
 - 
LOCHDRpublic static final int LOCHDR - See Also:
- Constant Field Values
 
 - 
EXTHDRpublic static final int EXTHDR - See Also:
- Constant Field Values
 
 - 
CENHDRpublic static final int CENHDR - See Also:
- Constant Field Values
 
 - 
ENDHDRpublic static final int ENDHDR - See Also:
- Constant Field Values
 
 - 
LOCVERpublic static final int LOCVER - See Also:
- Constant Field Values
 
 - 
LOCFLGpublic static final int LOCFLG - See Also:
- Constant Field Values
 
 - 
LOCHOWpublic static final int LOCHOW - See Also:
- Constant Field Values
 
 - 
LOCTIMpublic static final int LOCTIM - See Also:
- Constant Field Values
 
 - 
LOCCRCpublic static final int LOCCRC - See Also:
- Constant Field Values
 
 - 
LOCSIZpublic static final int LOCSIZ - See Also:
- Constant Field Values
 
 - 
LOCLENpublic static final int LOCLEN - See Also:
- Constant Field Values
 
 - 
LOCNAMpublic static final int LOCNAM - See Also:
- Constant Field Values
 
 - 
LOCEXTpublic static final int LOCEXT - See Also:
- Constant Field Values
 
 - 
EXTCRCpublic static final int EXTCRC - See Also:
- Constant Field Values
 
 - 
EXTSIZpublic static final int EXTSIZ - See Also:
- Constant Field Values
 
 - 
EXTLENpublic static final int EXTLEN - See Also:
- Constant Field Values
 
 - 
CENVEMpublic static final int CENVEM - See Also:
- Constant Field Values
 
 - 
CENVERpublic static final int CENVER - See Also:
- Constant Field Values
 
 - 
CENFLGpublic static final int CENFLG - See Also:
- Constant Field Values
 
 - 
CENHOWpublic static final int CENHOW - See Also:
- Constant Field Values
 
 - 
CENTIMpublic static final int CENTIM - See Also:
- Constant Field Values
 
 - 
CENCRCpublic static final int CENCRC - See Also:
- Constant Field Values
 
 - 
CENSIZpublic static final int CENSIZ - See Also:
- Constant Field Values
 
 - 
CENLENpublic static final int CENLEN - See Also:
- Constant Field Values
 
 - 
CENNAMpublic static final int CENNAM - See Also:
- Constant Field Values
 
 - 
CENEXTpublic static final int CENEXT - See Also:
- Constant Field Values
 
 - 
CENCOMpublic static final int CENCOM - See Also:
- Constant Field Values
 
 - 
CENDSKpublic static final int CENDSK - See Also:
- Constant Field Values
 
 - 
CENATTpublic static final int CENATT - See Also:
- Constant Field Values
 
 - 
CENATXpublic static final int CENATX - See Also:
- Constant Field Values
 
 - 
CENOFFpublic static final int CENOFF - See Also:
- Constant Field Values
 
 - 
ENDSUBpublic static final int ENDSUB - See Also:
- Constant Field Values
 
 - 
ENDTOTpublic static final int ENDTOT - See Also:
- Constant Field Values
 
 - 
ENDSIZpublic static final int ENDSIZ - See Also:
- Constant Field Values
 
 - 
ENDOFFpublic static final int ENDOFF - See Also:
- Constant Field Values
 
 - 
ENDCOMpublic static final int ENDCOM - See Also:
- Constant Field Values
 
 
- 
 - 
Constructor Detail- 
JarFilepublic JarFile(String name) throws IOException Creates a newJarFileto read from the specified filename. TheJarFilewill be verified if it is signed.- Parameters:
- name- the name of the jar file to be opened for reading
- Throws:
- IOException- if an I/O error has occurred
- SecurityException- if access to the file is denied by the SecurityManager
 
 - 
JarFilepublic JarFile(String name, boolean verify) throws IOException Creates a newJarFileto read from the specified filename.- Parameters:
- name- the name of the jar file to be opened for reading
- verify- whether or not to verify the jar file if it is signed.
- Throws:
- IOException- if an I/O error has occurred
- SecurityException- if access to the file is denied by the SecurityManager
 
 - 
JarFilepublic JarFile(File file) throws IOException Creates a newJarFileto read from the specifiedFileobject. TheJarFilewill be verified if it is signed.- Parameters:
- file- the jar file to be opened for reading
- Throws:
- IOException- if an I/O error has occurred
- SecurityException- if access to the file is denied by the SecurityManager
 
 - 
JarFilepublic JarFile(File file, boolean verify) throws IOException Creates a newJarFileto read from the specifiedFileobject.- Parameters:
- file- the jar file to be opened for reading
- verify- whether or not to verify the jar file if it is signed.
- Throws:
- IOException- if an I/O error has occurred
- SecurityException- if access to the file is denied by the SecurityManager.
 
 - 
JarFilepublic JarFile(File file, boolean verify, int mode) throws IOException Creates a newJarFileto read from the specifiedFileobject in the specified mode. The mode argument must be eitherOPEN_READorOPEN_READ | OPEN_DELETE.- Parameters:
- file- the jar file to be opened for reading
- verify- whether or not to verify the jar file if it is signed.
- mode- the mode in which the file is to be opened
- Throws:
- IOException- if an I/O error has occurred
- IllegalArgumentException- if the- modeargument is invalid
- SecurityException- if access to the file is denied by the SecurityManager
- Since:
- 1.3
 
 - 
JarFilepublic JarFile(File file, boolean verify, int mode, Runtime.Version version) throws IOException Creates a newJarFileto read from the specifiedFileobject in the specified mode. The mode argument must be eitherOPEN_READorOPEN_READ | OPEN_DELETE. The version argument, after being converted to a canonical form, is used to configure theJarFilefor processing multi-release jar files.The canonical form derived from the version parameter is Runtime.Version.parse(Integer.toString(n))wherenisMath.max(version.feature(), JarFile.baseVersion().feature()).- Parameters:
- file- the jar file to be opened for reading
- verify- whether or not to verify the jar file if it is signed.
- mode- the mode in which the file is to be opened
- version- specifies the release version for a multi-release jar file
- Throws:
- IOException- if an I/O error has occurred
- IllegalArgumentException- if the- modeargument is invalid
- SecurityException- if access to the file is denied by the SecurityManager
- NullPointerException- if- versionis- null
- Since:
- 9
 
 
- 
 - 
Method Detail- 
baseVersionpublic static Runtime.Version baseVersion() Returns the version that represents the unversioned configuration of a multi-release jar file.- Returns:
- the version that represents the unversioned configuration
- Since:
- 9
 
 - 
runtimeVersionpublic static Runtime.Version runtimeVersion() Returns the version that represents the effective runtime versioned configuration of a multi-release jar file.By default the feature version number of the returned Versionwill be equal to the feature version number ofRuntime.version(). However, if thejdk.util.jar.versionproperty is set, the returnedVersionis derived from that property and feature version numbers may not be equal.- Returns:
- the version that represents the runtime versioned configuration
- Since:
- 9
 
 - 
getVersionpublic final Runtime.Version getVersion() Returns the maximum version used when searching for versioned entries.If this JarFileis not a multi-release jar file or is not configured to be processed as such, then the version returned will be the same as that returned frombaseVersion().- Returns:
- the maximum version
- Since:
- 9
 
 - 
isMultiReleasepublic final boolean isMultiRelease() Indicates whether or not this jar file is a multi-release jar file.- Returns:
- true if this JarFile is a multi-release jar file
- Since:
- 9
 
 - 
getManifestpublic Manifest getManifest() throws IOException Returns the jar file manifest, ornullif none.- Returns:
- the jar file manifest, or nullif none
- Throws:
- IllegalStateException- may be thrown if the jar file has been closed
- IOException- if an I/O error has occurred
 
 - 
getJarEntrypublic JarEntry getJarEntry(String name) Returns theJarEntryfor the given base entry name ornullif not found.If this JarFileis a multi-release jar file and is configured to be processed as such, then a search is performed to find and return aJarEntrythat is the latest versioned entry associated with the given entry name. The returnedJarEntryis the versioned entry corresponding to the given base entry name prefixed with the string"META-INF/versions/{n}/", for the largest value ofnfor which an entry exists. If such a versioned entry does not exist, then theJarEntryfor the base entry is returned, otherwisenullis returned if no entries are found. The initial value for the versionnis the maximum version as returned by the methodgetVersion().- Implementation Requirements:
- This implementation invokesgetEntry(String).
- Parameters:
- name- the jar file entry name
- Returns:
- the JarEntryfor the given entry name, or the versioned entry name, ornullif not found
- Throws:
- IllegalStateException- may be thrown if the jar file has been closed
- See Also:
- JarEntry
 
 - 
getEntrypublic ZipEntry getEntry(String name) Returns theZipEntryfor the given base entry name ornullif not found.If this JarFileis a multi-release jar file and is configured to be processed as such, then a search is performed to find and return aZipEntrythat is the latest versioned entry associated with the given entry name. The returnedZipEntryis the versioned entry corresponding to the given base entry name prefixed with the string"META-INF/versions/{n}/", for the largest value ofnfor which an entry exists. If such a versioned entry does not exist, then theZipEntryfor the base entry is returned, otherwisenullis returned if no entries are found. The initial value for the versionnis the maximum version as returned by the methodgetVersion().- Overrides:
- getEntryin class- ZipFile
- Implementation Requirements:
- This implementation may return a versioned entry for the requested name even if there is not a corresponding base entry. This can occur if there is a private or package-private versioned entry that matches. If a subclass overrides this method, assure that the override method invokessuper.getEntry(name)to obtain all versioned entries.
- Parameters:
- name- the jar file entry name
- Returns:
- the ZipEntryfor the given entry name or the versioned entry name ornullif not found
- Throws:
- IllegalStateException- may be thrown if the jar file has been closed
- See Also:
- ZipEntry
 
 - 
entriespublic Enumeration<JarEntry> entries() Returns an enumeration of the jar file entries.- Overrides:
- entriesin class- ZipFile
- Returns:
- an enumeration of the jar file entries
- Throws:
- IllegalStateException- may be thrown if the jar file has been closed
 
 - 
streampublic Stream<JarEntry> stream() Returns an orderedStreamover the jar file entries. Entries appear in theStreamin the order they appear in the central directory of the jar file.- Overrides:
- streamin class- ZipFile
- Returns:
- an ordered Streamof entries in this jar file
- Throws:
- IllegalStateException- if the jar file has been closed
- Since:
- 1.8
 
 - 
versionedStreampublic Stream<JarEntry> versionedStream() Returns aStreamof the versioned jar file entries.If this JarFileis a multi-release jar file and is configured to be processed as such, then an entry in the stream is the latest versioned entry associated with the corresponding base entry name. The maximum version of the latest versioned entry is the version returned bygetVersion(). The returned stream may include an entry that only exists as a versioned entry. If the jar file is not a multi-release jar file or theJarFileis not configured for processing a multi-release jar file, this method returns the same stream thatstream()returns.- Returns:
- stream of versioned entries
- Since:
- 10
 
 - 
getInputStreampublic InputStream getInputStream(ZipEntry ze) throws IOException Returns an input stream for reading the contents of the specified zip file entry.- Overrides:
- getInputStreamin class- ZipFile
- Parameters:
- ze- the zip file entry
- Returns:
- an input stream for reading the contents of the specified zip file entry
- Throws:
- ZipException- if a zip file format error has occurred
- IOException- if an I/O error has occurred
- SecurityException- if any of the jar file entries are incorrectly signed.
- IllegalStateException- may be thrown if the jar file has been closed
 
 
- 
 
-