org.ow2.proactive.scheduler.common.util

Class ZipUtils

java.lang.Object

org.ow2.proactive.utils.FileUtils

org.ow2.proactive.scheduler.common.util.ZipUtils

Direct Known Subclasses:

JarUtils

@PublicAPI
public class ZipUtils
extends FileUtils

Utils for creating and reading zip files.

Since:

ProActive Scheduling 3.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	COMP_LEVEL Compression level of the file.

Constructor Summary

Constructors

Constructor and Description
ZipUtils()

Method Summary

Modifier and Type	Method and Description
protected static void	createFileWithPath(File f)
static void	unzip(ZipFile zipFile, File dest) Unzip a zip file into a directory.
static void	zip(String[] directoriesAndFiles, File dest, CRC32 crc) Create a zip file on the given directoriesAndFiles argument and store the create content in a file denoted by the path in the given dest argument
static void	zipDirectoriesAndFiles(ZipOutputStream zos, String[] directoriesAndFiles, CRC32 crc) Create a zip file that contains all the directory listed in directories parameter.
protected static void	zipDirectory(String directoryName, int iBaseFolderLength, ZipOutputStream zos, CRC32 crc) Add the given directory into the zipStream.
protected static void	zipFile(String filePath, int iBaseFolderLength, ZipOutputStream jos, CRC32 crc) Add a file into a zip.
protected static void	zipIt(ZipOutputStream zos, String[] directoriesAndFiles, CRC32 crc) Zip directory content in the given output stream

Methods inherited from class org.ow2.proactive.utils.FileUtils

createTempDirectory, deleteRecursively, getExtension, getFileNameWithExtension, removeDir, resolvePropertiesFile

Methods inherited from class java.lang.Object

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

Field Detail

COMP_LEVEL

protected static final int COMP_LEVEL

Compression level of the file.

See Also:

Constant Field Values

Constructor Detail

ZipUtils

public ZipUtils()

Method Detail

zip

public static void zip(String[] directoriesAndFiles,
                       File dest,
                       CRC32 crc)
                throws IOException

Create a zip file on the given directoriesAndFiles argument and store the create content in a file denoted by the path in the given dest argument

Parameters:

directoriesAndFiles - the directories and files to zip (recursively)

dest - the zip destination file that will contains the zipped version of the first argument.

crc - the CRC32 of all zipentries. Can be null if no crc is needed.

Throws:

IOException - if the zip file cannot be created.

zipDirectoriesAndFiles

public static void zipDirectoriesAndFiles(ZipOutputStream zos,
                                          String[] directoriesAndFiles,
                                          CRC32 crc)
                                   throws IOException

Create a zip file that contains all the directory listed in directories parameter.

Parameters:

zos - output stream destination

directoriesAndFiles - the list of directories and files to be zipped.

crc - the CRC32 of all zipentries. Can be null if no crc is needed.

Throws:

IOException - if an error occurs during the compression

zipIt

protected static void zipIt(ZipOutputStream zos,
                            String[] directoriesAndFiles,
                            CRC32 crc)
                     throws IOException

Zip directory content in the given output stream

Parameters:

zos - the output stream in which to store the zipped directory

directoriesAndFiles - a list of directories and files to be zipped

Throws:

IOException - if a zip entry cannot be created.

zipDirectory

protected static void zipDirectory(String directoryName,
                                   int iBaseFolderLength,
                                   ZipOutputStream zos,
                                   CRC32 crc)
                            throws IOException

Add the given directory into the zipStream.

Parameters:

directoryName - the directory to be added in the zip.

iBaseFolderLength - the index in the directoryName from which starts the actual zip entry name.

zos - the stream to write into.

crc - the CRC32 of all zipentries. Can be null if no crc is needed.

Throws:

IOException - if the zip file cannot be written.

zipFile

protected static void zipFile(String filePath,
                              int iBaseFolderLength,
                              ZipOutputStream jos,
                              CRC32 crc)
                       throws IOException

Add a file into a zip.

Parameters:

filePath - the file to be added in the zip.

iBaseFolderLength - the index in the directoryName from which starts the actual zip entry name.

jos - the stream to write into.

crc - the CRC32 of all zipentries. Can be null if no crc is needed.

Throws:

IOException - if the zip file cannot be written.

unzip

public static void unzip(ZipFile zipFile,
                         File dest)
                  throws IOException

Unzip a zip file into a directory.

Parameters:

zipFile - The zip file to be unzipped.

dest - the destination directory.

Throws:

IOException - if the destination does not exist or is not a directory, or if the zip file cannot be extracted.

createFileWithPath

protected static void createFileWithPath(File f)
                                  throws IOException

Throws:

IOException