Package org.apache.tomcat
Interface Jar
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
AbstractInputStreamJar,JarFileUrlJar,JarFileUrlNestedJar,ReferenceCountedJar,UrlJar
Provides an abstraction for use by the various classes that need to scan
JARs. The classes provided by the JRE for accessing JARs
(
JarFile and JarInputStream) have
significantly different performance characteristics depending on the form of
the URL used to access the JAR. For file based JAR URLs,
JarFile is faster but for non-file based
URLs, JarFile creates a copy of the
JAR in the temporary directory so JarInputStream is
faster.-
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Close any resources associated with this JAR.booleanDetermine if the given resource in present in the JAR.Obtains the input stream for the current entry.Obtains the name of the current entry.getInputStream(String name) Obtain anInputStreamfor a given entry in a JAR.longgetLastModified(String name) Obtain the last modified time for the given resource in the JAR.Obtain the manifest for the JAR file.Obtain, in String form, the URL for an entry in this JAR.voidMoves the internal pointer to the next entry in the JAR.voidreset()Resets the internal pointer used to track JAR entries to the beginning of the JAR.
-
Method Details
-
getJarFileURL
URL getJarFileURL()- Returns:
- The URL for accessing the JAR file.
-
getInputStream
Obtain anInputStreamfor a given entry in a JAR. The caller is responsible for closing the stream.- Parameters:
name- Entry to obtain anInputStreamfor- Returns:
- An
InputStreamfor the specified entry or null if the entry does not exist - Throws:
IOException- if an I/O error occurs while processing the JAR file
-
getLastModified
Obtain the last modified time for the given resource in the JAR.- Parameters:
name- Entry to obtain the modification time for- Returns:
- The time (in the same format as
System.currentTimeMillis()that the resource was last modified. Returns -1 if the entry does not exist - Throws:
IOException- if an I/O error occurs while processing the JAR file
-
exists
Determine if the given resource in present in the JAR.- Parameters:
name- Entry to look for- Returns:
trueif the entry is present in the JAR, otherwisefalse- Throws:
IOException- if an I/O error occurs while processing the JAR file
-
close
void close()Close any resources associated with this JAR.- Specified by:
closein interfaceAutoCloseable
-
nextEntry
void nextEntry()Moves the internal pointer to the next entry in the JAR. -
getEntryName
-
getEntryInputStream
Obtains the input stream for the current entry.- Returns:
- The input stream
- Throws:
IOException- If the stream cannot be obtained
-
getURL
Obtain, in String form, the URL for an entry in this JAR. Note that for JARs nested in WAR files, the Tomcat specific war:file:... form will not be used, rather the jar:jar:file:... form (that the JRE does not understand will be used). Note that this means that any code using these URLs will need to understand the jar:jar:file:... form and use theJarFactoryto ensure resources are accessed correctly.- Parameters:
entry- The entry to generate the URL for- Returns:
- a URL for the specified entry in the JAR
-
getManifest
Obtain the manifest for the JAR file.- Returns:
- The manifest for this JAR file.
- Throws:
IOException- If an I/O error occurs trying to obtain the manifest
-
reset
Resets the internal pointer used to track JAR entries to the beginning of the JAR.- Throws:
IOException- If the pointer cannot be reset
-