com.netphantom.server.utils

Class MemoryJarFile

java.lang.Object

java.util.zip.ZipFile

java.util.jar.JarFile

com.netphantom.server.utils.MemoryJarFile

All Implemented Interfaces:

Closeable, AutoCloseable

public class MemoryJarFile
extends JarFile

Extends the normal Jar file for processing files with various character case, and mixture of forward and backslashes. It is used to load entirely into memory and supports decryption on entry basis.

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

Method Summary

Methods

Modifier and Type	Method and Description
static MemoryJarFile	createJarFile(File file, boolean verify, boolean winStyle, MemoryJarFileDecrypter streamDecrypter, MemoryJarFileDecrypter entryDecrypter) Creates a memory Jar file.
static MemoryJarFile	createJarFile(InputStream in, boolean verify, boolean winStyle, MemoryJarFileDecrypter streamDecrypter, MemoryJarFileDecrypter entryDecrypter) Creates a memory Jar file.
static MemoryJarFile	createJarFile(JarInputStream jin) Creates a memory Jar file.
static MemoryJarFile	createJarFile(JarInputStream jin, boolean winStyle) Creates a memory Jar file.
static MemoryJarFile	createJarFile(JarInputStream jin, boolean winStyle, MemoryJarFileDecrypter decrypter) Creates a memory Jar file.
static MemoryJarFile	createJarFile(String fileName, boolean verify, boolean winStyle, MemoryJarFileDecrypter streamDecrypter, MemoryJarFileDecrypter entryDecrypter) Creates a memory Jar file.
Enumeration<JarEntry>	entries() Returns an enumeration of the Jar file entries.
byte[]	getByteArray(ZipEntry ze) Returns the byte array of the contents of the specified zip file entry.
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.
InputStream	getInputStream(ZipEntry ze) Returns an input stream for reading the contents of the specified zip file entry.
JarEntry	getJarEntry(String name) Gets the Jar entry with the specified name.
Manifest	getManifest() Returns the Jar file manifest, or null if none.
String	getName() Gets the name of the Jar file.
void	setName(String name) Sets the name of the Jar file.
int	size() Returns the number of entries in the Jar file.

Methods inherited from class java.util.zip.ZipFile

close, finalize, getComment

Methods inherited from class java.lang.Object

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

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

Method Detail

createJarFile

public static MemoryJarFile createJarFile(JarInputStream jin)
                                   throws IOException

Creates a memory Jar file. The Jar input stream is closed before returning, the new Jar file will not have the 'winStyle' parameter set.

Parameters:

jin - the Jar input stream.

Throws:

IOException

createJarFile

public static MemoryJarFile createJarFile(JarInputStream jin,
                          boolean winStyle)
                                   throws IOException

Creates a memory Jar file. The Jar input stream is closed before returning.

Parameters:

jin - the Jar input stream.

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

Throws:

IOException

createJarFile

public static MemoryJarFile createJarFile(JarInputStream jin,
                          boolean winStyle,
                          MemoryJarFileDecrypter decrypter)
                                   throws IOException

Creates a memory Jar file. The Jar input stream is closed before returning.

Parameters:

jin - the Jar input stream.

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

decrypter - an instance of a class implementing the MemoryJarFileDecrypter interface to provide decryption of an entry.

Throws:

IOException

createJarFile

public static MemoryJarFile createJarFile(InputStream in,
                          boolean verify,
                          boolean winStyle,
                          MemoryJarFileDecrypter streamDecrypter,
                          MemoryJarFileDecrypter entryDecrypter)
                                   throws IOException

Creates a memory Jar file. The input stream is closed before returning.

Parameters:

in - an input stream.

verify - set to true to verify the Jar file for correctness.

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

streamDecrypter - an instance of a class implementing the MemoryJarFileDecrypter interface to provide decryption of the entire input stream data, set to null for no decryption.

entryDecrypter - an instance of a class implementing the MemoryJarFileDecrypter interface to provide decryption of an entry, set to null for no decryption.

Throws:

IOException

createJarFile

public static MemoryJarFile createJarFile(File file,
                          boolean verify,
                          boolean winStyle,
                          MemoryJarFileDecrypter streamDecrypter,
                          MemoryJarFileDecrypter entryDecrypter)
                                   throws IOException

Creates a memory Jar file. The File is closed before returning.

Parameters:

file - the Jar File instance to read.

verify - set to true to verify the Jar file for correctness.

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

streamDecrypter - an instance of a class implementing the MemoryJarFileDecrypter interface to provide decryption of the entire input stream data, set to null for no decryption.

entryDecrypter - an instance of a class implementing the MemoryJarFileDecrypter interface to provide decryption of an entry, set to null for no decryption.

Throws:

IOException

createJarFile

public static MemoryJarFile createJarFile(String fileName,
                          boolean verify,
                          boolean winStyle,
                          MemoryJarFileDecrypter streamDecrypter,
                          MemoryJarFileDecrypter entryDecrypter)
                                   throws IOException

Creates a memory Jar file. The file is closed before returning.

Parameters:

fileName - the file name of Jar file to read.

verify - set to true to verify the Jar file for correctness.

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

streamDecrypter - an instance of a class implementing the MemoryJarFileDecrypter interface to provide decryption of the entire input stream data, set to null for no decryption.

entryDecrypter - an instance of a class implementing the MemoryJarFileDecrypter interface to provide decryption of an entry, set to null for no decryption.

Throws:

IOException

entries

public Enumeration<JarEntry> entries()

Returns an enumeration of the Jar file entries.

Overrides:

entries in class JarFile

Returns:

an enumeration of the Jar file entries.

getInputStream

public InputStream getInputStream(ZipEntry ze)
                           throws FileNotFoundException

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

Overrides:

getInputStream in class JarFile

Returns:

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

Throws:

FileNotFoundException - if the entry isn't found.

getByteArray

public byte[] getByteArray(ZipEntry ze)
                    throws FileNotFoundException

Returns the byte array of the contents of the specified zip file entry.

Returns:

the byte array of the contents of the specified zip file entry

Throws:

FileNotFoundException - if the entry isn't found.

getJarEntry

public JarEntry getJarEntry(String name)

Gets the Jar entry with the specified name.

Overrides:

getJarEntry in class JarFile

Parameters:

name - name of the Jar entry, 'winStyle' parameter applies, i.e. '\' is translated to '/' and the name check is done case insensitive.

Returns:

the JarEntry found, or null for not found.

getEntry

public ZipEntry getEntry(String name)

Gets the Zip entry with the specified name.

Overrides:

getEntry in class JarFile

Parameters:

name - name of the Zip entry, 'winStyle' parameter applies, i.e. '\' is translated to '/' and the name check is done case insensitive.

Returns:

the ZipEntry found, or null for 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.

getManifest

public Manifest getManifest()

Returns the Jar file manifest, or null if none.

Overrides:

getManifest in class JarFile

Returns:

the Jar file manifest, or null if none.

getName

public String getName()

Gets the name of the Jar file. If no name has been assigned using setName, the "real" temporary Jar file name from the temporary directory is returned.

Overrides:

getName in class ZipFile

setName

public void setName(String name)

Sets the name of the Jar file. The getName method will return that name (if non-null), or the "real" temporary Jar file name from the temporary directory if the name parameter is null.

Parameters:

name - the name of the Jar file or null to reset it to the "real" temporary Jar file.

getEntryData

public byte[] getEntryData(String name)

Gets the byte [] data for an entry if present.

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.

Parameters:

name - the name of the entry.

Returns:

the byte array or null if not found.