UrlJar (Apache Tomcat 8.0.15 API Documentation)

java.lang.Object
- org.apache.tomcat.util.scan.UrlJar

All Implemented Interfaces:

AutoCloseable, Jar
```
public class UrlJar
extends Object
implements Jar
```
Implementation of Jar that is optimised for non-file based JAR URLs (e.g. JNDI based URLs of the form jar:jndi:...).

Constructor Summary

Constructors
Constructor and Description

UrlJar(URL url)

Constructors
Constructor and Description
`UrlJar(URL url)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Close any resources associated with this JAR.
`boolean`	`entryExists(String name)` Determines if a specific entry exists within the JAR.
`InputStream`	`getEntryInputStream()` Obtains the input stream for the current entry.
`String`	`getEntryName()` Obtains the name of the current entry.
`InputStream`	`getInputStream(String name)` Obtain an `InputStream` for a given entry in a JAR.
`URL`	`getJarFileURL()` Obtain the URL for accessing the JAR file.
`long`	`getLastModified(String name)` Obtain the last modified time for the given resource in the JAR.
`String`	`getURL(String entry)` Obtain, in String form, the URL for an entry in this JAR.
`void`	`nextEntry()` Moves the internal pointer to the next entry in the JAR.
`void`	`reset()` Resets the internal pointer used to track JAR entries to the beginning of the JAR.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UrlJar
```
public UrlJar(URL url)
       throws IOException
```
    Throws:
    
    IOException
- Method Detail
  - getJarFileURL
```
public URL getJarFileURL()
```
    Description copied from interface: Jar
    
    Obtain the URL for accessing the JAR file.
    
    Specified by:
    
    getJarFileURL in interface Jar
  - entryExists
```
public boolean entryExists(String name)
                    throws IOException
```
    Description copied from interface: Jar
    
    Determines if a specific entry exists within the JAR.
    
    Specified by:
    
    entryExists in interface Jar
    
    Parameters:
    name - Entry to look for
    
    Returns:
    true if the specified entry exists else false
    
    Throws:
    
    IOException
  - getInputStream
```
public InputStream getInputStream(String name)
                           throws IOException
```
    Description copied from interface: Jar
    
    Obtain an InputStream for a given entry in a JAR. The caller is responsible for closing the stream.
    
    Specified by:
    
    getInputStream in interface Jar
    
    Parameters:
    name - Entry to obtain an InputStream for
    
    Returns:
    An InputStream for the specified entry or null if the entry does not exist
    
    Throws:
    
    IOException
  - getLastModified
```
public long getLastModified(String name)
                     throws IOException
```
    Description copied from interface: Jar
    
    Obtain the last modified time for the given resource in the JAR.
    
    Specified by:
    
    getLastModified in interface 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
  - getURL
```
public String getURL(String entry)
```
    Description copied from interface: Jar
    
    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 the JarFactory to ensure resources are accessed correctly.
    
    Specified by:
    
    getURL in interface Jar
    
    Parameters:
    entry - The entry to generate the URL for
    
    Returns:
    a URL for the specified entry in the JAR
  - close
```
public void close()
```
    Description copied from interface: Jar
    
    Close any resources associated with this JAR.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Jar
  - nextEntry
```
public void nextEntry()
```
    Description copied from interface: Jar
    
    Moves the internal pointer to the next entry in the JAR.
    
    Specified by:
    
    nextEntry in interface Jar
  - getEntryName
```
public String getEntryName()
```
    Description copied from interface: Jar
    
    Obtains the name of the current entry.
    
    Specified by:
    
    getEntryName in interface Jar
    
    Returns:
    The entry name
  - getEntryInputStream
```
public InputStream getEntryInputStream()
                                throws IOException
```
    Description copied from interface: Jar
    
    Obtains the input stream for the current entry.
    
    Specified by:
    
    getEntryInputStream in interface Jar
    
    Returns:
    The input stream
    
    Throws:
    
    IOException - If the stream cannot be obtained
  - reset
```
public void reset()
           throws IOException
```
    Description copied from interface: Jar
    
    Resets the internal pointer used to track JAR entries to the beginning of the JAR.
    
    Specified by:
    
    reset in interface Jar
    
    Throws:
    
    IOException - If the pointer cannot be reset

Class UrlJar

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UrlJar

Method Detail

getJarFileURL

entryExists

getInputStream

getLastModified

getURL

close

nextEntry

getEntryName

getEntryInputStream

reset