org.jahia.utils.zip

Class JahiaArchiveFileHandler

java.lang.Object

org.jahia.utils.zip.JahiaArchiveFileHandler

public class JahiaArchiveFileHandler
extends Object

A Wrapper to handle some manipulations on .jar, .war and .ear files

Author:

Khue ng

Constructor Summary

Constructors

Constructor and Description
JahiaArchiveFileHandler(String path) Constructor
JahiaArchiveFileHandler(String path, String basePath)

Method Summary

Modifier and Type	Method and Description
void	closeArchiveFile() Close the Zip file.
protected void	copyStream(InputStream ins, OutputStream outs) Copy an InputStream to an OutPutStream
boolean	entryExists(String entryName) Check if an entry exist or not
String	extractContent(String entryName) Extracts the content of the specifdied archive entry as a text.
void	extractEntry(String entryName, String destPath) Extract an entry in a gived folder.
File	extractFile(String entryName) Extract an entry of file type in the jar file Return a File Object reference to the uncompressed file
protected String	genPathFile(String entryName) Generates a file path for a given entry name Parses "/" char and replaces them with File.separator char
ZipEntry	getEntry(String entryName) Return an entry in the jar file of the gived name or null if not found
String	getPath()
boolean	isDirectory(String entryName) Check if an entry is a directory or not
void	unzip() Decompresses the file in it's current location
Map<String,String>	unzip(String path) Decompress the file in a given folder
Map<String,String>	unzip(String path, boolean overwrite)
Map<String,String>	unzip(String path, boolean overwrite, PathFilter pathFilter, String pathPrefix)
Map<String,String>	unzip(String path, PathFilter pathFilter)

Methods inherited from class java.lang.Object

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

Constructor Detail

JahiaArchiveFileHandler

public JahiaArchiveFileHandler(String path)
                        throws IOException

Constructor

Parameters:

path, - the full path to the file

Throws:

IOException

JahiaArchiveFileHandler

public JahiaArchiveFileHandler(String path,
                               String basePath)
                        throws IOException

Throws:

IOException

Method Detail

unzip

public void unzip()
           throws JahiaException

Decompresses the file in it's current location

Throws:

JahiaException

unzip

public Map<String,String> unzip(String path)
                         throws JahiaException

Decompress the file in a given folder

Parameters:

path -

Throws:

JahiaException

unzip

public Map<String,String> unzip(String path,
                                PathFilter pathFilter)
                         throws JahiaException

Throws:

JahiaException

unzip

public Map<String,String> unzip(String path,
                                boolean overwrite)
                         throws JahiaException

Throws:

JahiaException

unzip

public Map<String,String> unzip(String path,
                                boolean overwrite,
                                PathFilter pathFilter,
                                String pathPrefix)
                         throws JahiaException

Throws:

JahiaException

extractFile

public File extractFile(String entryName)
                 throws IOException,
                        JahiaArchiveFileException

Extract an entry of file type in the jar file Return a File Object reference to the uncompressed file

Parameters:

entryName, - the entry name

Returns:

(File) fo, a File Handler to the file ( It's a temporary file )

Throws:

IOException

JahiaArchiveFileException

extractContent

public String extractContent(String entryName)
                      throws IOException,
                             JahiaArchiveFileException

Extracts the content of the specifdied archive entry as a text.

Parameters:

entryName - the archive entry name

Returns:

the content of the specifdied archive entry as a text

Throws:

IOException

JahiaArchiveFileException

extractEntry

public void extractEntry(String entryName,
                         String destPath)
                  throws JahiaException

Extract an entry in a gived folder. If this entry is a directory, all its contents are extracted too.

Parameters:

entryName, - the name of an entry in the jar

destPath, - the path to the destination folder

Throws:

JahiaException

getEntry

public ZipEntry getEntry(String entryName)

Return an entry in the jar file of the gived name or null if not found

Parameters:

entryName - the entry name

Returns:

(ZipEntry) the entry

isDirectory

public boolean isDirectory(String entryName)

Check if an entry is a directory or not

Parameters:

(String) - entryName the entry name

Returns:

(boolean) true if the entry exists and is a a directory

entryExists

public boolean entryExists(String entryName)

Check if an entry exist or not

Parameters:

(String) - entryName the entry name

Returns:

(boolean) true if exist

closeArchiveFile

public void closeArchiveFile()

Close the Zip file. Important to close the JarFile object to be able to delete it from disk.

genPathFile

protected String genPathFile(String entryName)

Generates a file path for a given entry name Parses "/" char and replaces them with File.separator char

copyStream

protected void copyStream(InputStream ins,
                          OutputStream outs)
                   throws IOException

Copy an InputStream to an OutPutStream

Parameters:

ins - An InputStream.

outs - An OutputStream.

Throws:

IOException.

IOException

getPath

public String getPath()