org.deventropy.shared.utils

Class DirectoryArchiverUtil

java.lang.Object

org.deventropy.shared.utils.DirectoryArchiverUtil

public final class DirectoryArchiverUtil
extends Object

Utility class providing convenience methods to create Zip/Jar archives for entire directories.

The functionality implemented in this class is rudimentary at this time, and does not support:

• Compression Level
• Compression Method
• Advanced manifest manipulation (Jar files)
• Jar signing
• Filtering files out

Creating a Zip Archive

To create a zip archive from a directory /project/data/source into a file /project/data/source.zip, use the createZipArchiveOfDirectory(String, File, String) as:

 DirectoryArchiverUtil.createJarArchiveOfDirectory("/project/data/source", "/project/data/source.zip", null);
 

This will archive all the contents of the source folder recursively in the zip file created. Immediate children of the source folder will be at the root of the zip file. The current implementation does not traverse down symbolic links, and they will be excluded.

Nesting contents in the archive

The implementation supports nesting contents from the source one or more directories down in the archive file created. Working on the example above, if the code were invoked as:

 DirectoryArchiverUtil.createJarArchiveOfDirectory("/project/data/source", "/project/data/source.zip", "test/one");
 

This will cause any files or directories which were immediate children of the source folder to appear nested under directories test/one in the archive (or when the archive is inflated). So /project/data/source/file.txt will appear at test/one/file.txt in the archive.

Creating a Jar Archive

Jar files are created almost identical to the Zip files above, with the additional functionality of a very rudimentary Manifest (META-INF/MANIFEST.MF) file is added to the archive with just the Manifest Version property set.

To create Jar files, use the createJarArchiveOfDirectory(String, File, String) method instead.

This class uses ideas expressed by user Gili on a StackOverflow question: How to use JarOutputStream to create a JAR file?

Author:

Bindul Bhowmik

Method Summary

Modifier and Type	Method and Description
static void	createGZippedTarArchiveOfDirectory(String archiveFile, File srcDirectory, String rootPathPrefix) Create a GZipped tar archive with all the contents of the directory.
static void	createJarArchiveOfDirectory(String archiveFile, File srcDirectory, String rootPathPrefix) Create a Jar archive with all the contents of the directory.
static void	createTarArchiveOfDirectory(String archiveFile, File srcDirectory, String rootPathPrefix) Create a tar archive with all the contents of the directory.
static void	createZipArchiveOfDirectory(String archiveFile, File srcDirectory, String rootPathPrefix) Create a zip archive with all the contents of the directory.

Methods inherited from class java.lang.Object

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

Method Detail

createZipArchiveOfDirectory

public static void createZipArchiveOfDirectory(String archiveFile,
                                               File srcDirectory,
                                               String rootPathPrefix)
                                        throws IOException

Create a zip archive with all the contents of the directory. Optionally push the contents down a directory level or two.

Parameters:

archiveFile - The final archive file location. The file location must be writable.

srcDirectory - The source directory.

rootPathPrefix - The root prefix. Multiple directory parts should be separated by /.

Throws:

IOException - Exception reading the source directory or writing to the destination file.

createJarArchiveOfDirectory

public static void createJarArchiveOfDirectory(String archiveFile,
                                               File srcDirectory,
                                               String rootPathPrefix)
                                        throws IOException

Create a Jar archive with all the contents of the directory. Optionally push the contents down a directory level or two. A Manifest file is automatically added.

Parameters:

archiveFile - The final archive file location. The file location must be writable.

srcDirectory - The source directory.

rootPathPrefix - The root prefix. Multiple directory parts should be separated by /.

Throws:

IOException - Exception reading the source directory or writing to the destination file.

createTarArchiveOfDirectory

public static void createTarArchiveOfDirectory(String archiveFile,
                                               File srcDirectory,
                                               String rootPathPrefix)
                                        throws IOException

Create a tar archive with all the contents of the directory. Optionally push the contents down a directory level or two.

Parameters:

archiveFile - The final archive file location. The file location must be writable.

srcDirectory - The source directory.

rootPathPrefix - The root prefix. Multiple directory parts should be separated by /.

Throws:

IOException - Exception reading the source directory or writing to the destination file.

createGZippedTarArchiveOfDirectory

public static void createGZippedTarArchiveOfDirectory(String archiveFile,
                                                      File srcDirectory,
                                                      String rootPathPrefix)
                                               throws IOException

Create a GZipped tar archive with all the contents of the directory. Optionally push the contents down a directory level or two.

Parameters:

archiveFile - The final archive file location. The file location must be writable.

srcDirectory - The source directory.

rootPathPrefix - The root prefix. Multiple directory parts should be separated by /.

Throws:

IOException - Exception reading the source directory or writing to the destination file.