com.netphantom.common

Class NpJarFile

java.lang.Object

java.util.zip.ZipFile

java.util.jar.JarFile

com.netphantom.common.NpJarFile

All Implemented Interfaces:

IJarFile, Closeable, AutoCloseable

public class NpJarFile
extends JarFile
implements IJarFile

Extends the normal JAR file for processing files with various character case, and mixture of forward and backslashes. It also supports loading the entire file into memory and then unlocking the file in the file system. A check if the file has changed is also supported, in order to create manual or automatic file reload (i.e. application re-deploy).

Please note that this class currently only supports file items smaller than 2 GB, i.e. a 31 bit long positive integer value.

Author:

Christopher Mindus

Field Summary

Fields

Modifier and Type	Field and Description
static int	CENATT
static int	CENATX
static int	CENCOM
static int	CENCRC
static int	CENDSK
static int	CENEXT
static int	CENFLG
static int	CENHDR
static int	CENHOW
static int	CENLEN
static int	CENNAM
static int	CENOFF
static long	CENSIG
static int	CENSIZ
static int	CENTIM
static int	CENVEM
static int	CENVER
static int	ENDCOM
static int	ENDHDR
static int	ENDOFF
static long	ENDSIG
static int	ENDSIZ
static int	ENDSUB
static int	ENDTOT
static int	EXTCRC
static int	EXTHDR
static int	EXTLEN
static long	EXTSIG
static int	EXTSIZ
static int	LOCCRC
static int	LOCEXT
static int	LOCFLG
static int	LOCHDR
static int	LOCHOW
static int	LOCLEN
static int	LOCNAM
static long	LOCSIG
static int	LOCSIZ
static int	LOCTIM
static int	LOCVER

Fields inherited from class java.util.jar.JarFile

MANIFEST_NAME

Fields inherited from class java.util.zip.ZipFile

OPEN_DELETE, OPEN_READ

Fields inherited from interface com.netphantom.common.IJarFile

MANIFEST_ENTRY

Constructor Summary

Constructors

Constructor and Description
NpJarFile(File file) Loads or opens the JAR file "inMemory", without "winStyle", but with "verify".
NpJarFile(File file, boolean inMemory, boolean winStyle, boolean verify) Loads or opens the JAR file.
NpJarFile(String name) Loads or opens the JAR file "inMemory", without "winStyle", but with "verify".
NpJarFile(String name, boolean inMemory, boolean winStyle, boolean verify) Loads or opens the JAR file.

Method Summary

Modifier and Type	Method and Description
static void	clearLoadedFilesList() Clears the loaded files list.
void	close() Closes the Jar file.
Enumeration<JarEntry>	entries() Returns an enumeration of the Jar file entries.
ZipEntry	getEntry(String name) Gets the ZIP entry with the specified name.
byte[]	getEntryData(String name) Gets the byte [] data for an entry if present.
byte[]	getEntryData(ZipEntry ze) Gets the byte [] data for an entry if present.
Handler	getHandler() Gets the URL stream handler for the MemoryJarFile.
InputStream	getInputStream(ZipEntry ze) Returns an input stream for reading the contents of the specified zip file entry.
JarEntry[]	getJarEntries() Gets all Jar entries if the Jar file is loaded into memory.
JarEntry	getJarEntry(String name) Gets the JAR entry with the specified name.
File	getJarFile() Gets the file of the Jar file.
static NpJarFile	getJarFile(File file) Loads the requested NpJarFile or grabs one from the table of loaded files and reloads it as required.
static NpJarFile	getJarFile(String fileName) Loads the requested NpJarFile or grabs one from the table of loaded files and reloads it as required.
Manifest	getManifest() Returns the jar file manifest, or null if none.
URL	getURL() Gets the NpJar URL to be used with e.g.
URL	getURL(String path) Gets the NpJar URL to be used with e.g.
URL	getURL(ZipEntry entry) Gets the NpJar URL to be used with e.g.
boolean	hasChanged() Checks if the Jar file has changed since last call to this method, i.e.
long	lastModified() Returns the time that the file denoted by this abstract pathname was last modified.
int	size() Returns the number of entries in the Jar file.
Stream<JarEntry>	stream() Returns a stream of Jar entries.

Methods inherited from class java.util.zip.ZipFile

finalize, getComment, getName

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.netphantom.common.IJarFile

getJarManifestEntry, getName

Field Detail

LOCSIG

public static final long LOCSIG

See Also:

Constant Field Values

EXTSIG

public static final long EXTSIG

See Also:

Constant Field Values

CENSIG

public static final long CENSIG

See Also:

Constant Field Values

ENDSIG

public static final long ENDSIG

See Also:

Constant Field Values

LOCHDR

public static final int LOCHDR

See Also:

Constant Field Values

EXTHDR

public static final int EXTHDR

See Also:

Constant Field Values

CENHDR

public static final int CENHDR

See Also:

Constant Field Values

ENDHDR

public static final int ENDHDR

See Also:

Constant Field Values

LOCVER

public static final int LOCVER

See Also:

Constant Field Values

LOCFLG

public static final int LOCFLG

See Also:

Constant Field Values

LOCHOW

public static final int LOCHOW

See Also:

Constant Field Values

LOCTIM

public static final int LOCTIM

See Also:

Constant Field Values

LOCCRC

public static final int LOCCRC

See Also:

Constant Field Values

LOCSIZ

public static final int LOCSIZ

See Also:

Constant Field Values

LOCLEN

public static final int LOCLEN

See Also:

Constant Field Values

LOCNAM

public static final int LOCNAM

See Also:

Constant Field Values

LOCEXT

public static final int LOCEXT

See Also:

Constant Field Values

EXTCRC

public static final int EXTCRC

See Also:

Constant Field Values

EXTSIZ

public static final int EXTSIZ

See Also:

Constant Field Values

EXTLEN

public static final int EXTLEN

See Also:

Constant Field Values

CENVEM

public static final int CENVEM

See Also:

Constant Field Values

CENVER

public static final int CENVER

See Also:

Constant Field Values

CENFLG

public static final int CENFLG

See Also:

Constant Field Values

CENHOW

public static final int CENHOW

See Also:

Constant Field Values

CENTIM

public static final int CENTIM

See Also:

Constant Field Values

CENCRC

public static final int CENCRC

See Also:

Constant Field Values

CENSIZ

public static final int CENSIZ

See Also:

Constant Field Values

CENLEN

public static final int CENLEN

See Also:

Constant Field Values

CENNAM

public static final int CENNAM

See Also:

Constant Field Values

CENEXT

public static final int CENEXT

See Also:

Constant Field Values

CENCOM

public static final int CENCOM

See Also:

Constant Field Values

CENDSK

public static final int CENDSK

See Also:

Constant Field Values

CENATT

public static final int CENATT

See Also:

Constant Field Values

CENATX

public static final int CENATX

See Also:

Constant Field Values

CENOFF

public static final int CENOFF

See Also:

Constant Field Values

ENDSUB

public static final int ENDSUB

See Also:

Constant Field Values

ENDTOT

public static final int ENDTOT

See Also:

Constant Field Values

ENDSIZ

public static final int ENDSIZ

See Also:

Constant Field Values

ENDOFF

public static final int ENDOFF

See Also:

Constant Field Values

ENDCOM

public static final int ENDCOM

See Also:

Constant Field Values

Constructor Detail

NpJarFile

public NpJarFile(String name)
          throws IOException

Loads or opens the JAR file "inMemory", without "winStyle", but with "verify".

Parameters:

name - the file name.

Throws:

IOException - for file failures.

NpJarFile

public NpJarFile(File file)
          throws IOException

Loads or opens the JAR file "inMemory", without "winStyle", but with "verify".

Parameters:

file - the file.

Throws:

IOException - for file failures.

NpJarFile

public NpJarFile(String name,
                 boolean inMemory,
                 boolean winStyle,
                 boolean verify)
          throws IOException

Loads or opens the JAR file.

Parameters:

name - the file name.

inMemory - if true, the entire Jar file is loaded into memory and then closed. Subsequent operations can be performed as normal.

winStyle - if true, the entries are case insensitive and backslash can be used with forward slash as well.

verify - if the Jar file should be verified.

Throws:

IOException - for file failures.

NpJarFile

public NpJarFile(File file,
                 boolean inMemory,
                 boolean winStyle,
                 boolean verify)
          throws IOException

Loads or opens the JAR file.

Parameters:

file - the file.

inMemory - if true, the entire Jar file is loaded into memory and then closed. Subsequent operations can be performed as normal.

winStyle - if true, the entries are case insensitive and backslash can be used with forward slash as well.

verify - if the Jar file should be verified.

Throws:

IOException - for file failures.

Method Detail

clearLoadedFilesList

public static void clearLoadedFilesList()

Clears the loaded files list.

getJarFile

public static NpJarFile getJarFile(String fileName)
                            throws IOException

Loads the requested NpJarFile or grabs one from the table of loaded files and reloads it as required.

Throws:

IOException - for file failures.

getJarFile

public static NpJarFile getJarFile(File file)
                            throws IOException

Loads the requested NpJarFile or grabs one from the table of loaded files and reloads it as required. If the loading of this Jar file is done in another thread, this thread will first complete it's loading.

Throws:

IOException - for file failures.

lastModified

public long lastModified()

Returns the time that the file denoted by this abstract pathname was last modified.

Where it is required to distinguish an I/O exception from the case where 0L is returned, or where several attributes of the same file are required at the same time, or where the time of last access or the creation time are required, then the Files.readAttributes method may be used.

Specified by:

lastModified in interface IJarFile

Returns:

A long value representing the time the file was last modified, measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970), or 0L if the file does not exist or if an I/O error occurs

Throws:

SecurityException - If a security manager exists and its SecurityManager.checkRead(java.lang.String) method denies read access to the file

getJarFile

public File getJarFile()

Gets the file of the Jar file.

Specified by:

getJarFile in interface IJarFile

Returns:

The file.

getHandler

public Handler getHandler()

Gets the URL stream handler for the MemoryJarFile.

Specified by:

getHandler in interface IJarFile

Returns:

The stream handler.

getURL

public URL getURL()

Gets the NpJar URL to be used with e.g. a class loader.

Specified by:

getURL in interface IJarFile

Returns:

An URL with the stream handler initialized to this Jar file.

getURL

public URL getURL(ZipEntry entry)

Gets the NpJar URL to be used with e.g. a class loader.

Specified by:

getURL in interface IJarFile

Parameters:

entry - The Jar entry.

Returns:

An URL with the stream handler initialized to this Jar file.

getURL

public URL getURL(String path)

Gets the NpJar URL to be used with e.g. a class loader.

Specified by:

getURL in interface IJarFile

Parameters:

path - A path specification.

Returns:

An URL with the stream handler initialized to this Jar file.

hasChanged

public boolean hasChanged()

Checks if the Jar file has changed since last call to this method, i.e. this means that the new last modified time and file size is saved.

Specified by:

hasChanged in interface IJarFile

Returns:

true if the file has changed in size or last modified time, false otherwise.

entries

public Enumeration<JarEntry> entries()

Returns an enumeration of the Jar file entries.

Specified by:

entries in interface IJarFile

Overrides:

entries in class JarFile

Returns:

an enumeration of the Jar file entries.

stream

public Stream<JarEntry> stream()

Returns a stream of Jar entries.

Specified by:

stream in interface IJarFile

Overrides:

stream in class JarFile

Returns:

an ordered, distinct, immutable and non-null stream of the Jar file entries.

getJarEntries

public JarEntry[] getJarEntries()

Gets all Jar entries if the Jar file is loaded into memory.

Specified by:

getJarEntries in interface IJarFile

Returns:

All the entries as a new array.

getInputStream

public InputStream getInputStream(ZipEntry ze)
                           throws IOException

Returns an input stream for reading the contents of the specified zip file entry.

Specified by:

getInputStream in interface IJarFile

Overrides:

getInputStream in class JarFile

Parameters:

ze - The Zip or Jar 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.

getJarEntry

public JarEntry getJarEntry(String name)

Gets the JAR entry with the specified name.

Specified by:

getJarEntry in interface IJarFile

Overrides:

getJarEntry in class JarFile

Parameters:

name - The Jar file entry name.

Returns:

The JarEntry for the given entry name or null if not found.

See Also:

JarEntry

getEntry

public ZipEntry getEntry(String name)

Gets the ZIP entry with the specified name.

Specified by:

getEntry in interface IJarFile

Overrides:

getEntry in class JarFile

Parameters:

name - The name of the entry.

Returns:

The Zip file entry, or null if not found.

size

public int size()

Returns the number of entries in the Jar file.

Overrides:

size in class ZipFile

Returns:

the number of entries in the Jar file.

Throws:

IllegalStateException - if the Jar file has been closed.

getManifest

public Manifest getManifest()
                     throws IOException

Returns the jar file manifest, or null if none.

Specified by:

getManifest in interface IJarFile

Overrides:

getManifest in class JarFile

Returns:

the jar file manifest, or null if none.

Throws:

IllegalStateException - may be thrown if the jar file has been closed

IOException - If an I/O error has occurred.

getEntryData

public byte[] getEntryData(String name)

Gets the byte [] data for an entry if present. This method only works when the file has been read into memory.

Specified by:

getEntryData in interface IJarFile

Parameters:

name - the name of the entry.

Returns:

the byte array or null if not found.

getEntryData

public byte[] getEntryData(ZipEntry ze)

Gets the byte [] data for an entry if present. This method only works when the file has been read into memory.

Specified by:

getEntryData in interface IJarFile

Parameters:

ze - the name of the entry.

Returns:

the byte array or null if not found.

close

public void close()
           throws IOException

Closes the Jar file.

Closing this Jar file will close all of the input streams previously returned by invocations of the getInputStream method.

Specified by:

close in interface IJarFile

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class ZipFile

Throws:

IOException - if an I/O error has occurred.