de.enflexit.common.transfer

Class ArchiveFileHandler

java.lang.Object

de.enflexit.common.transfer.ArchiveFileHandler

public class ArchiveFileHandler
extends java.lang.Object

Class for handling archive files. Currently able to handle zip and tar.gz files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArchiveFileHandler.ArchiveFormat The Enum ArchiveFormat.

Constructor Summary

Constructors

Constructor and Description
ArchiveFileHandler()

Method Summary

Modifier and Type	Method and Description
void	addPathReplacement(java.lang.String replace, java.lang.String replaceWith) Adds a path replacement.
boolean	appendFoldersToArchive(java.io.File archiveSourceFile, java.io.File archiveTargetFile, java.util.HashMap<java.io.File,java.lang.String> folders, ArchiveFileHandler.ArchiveFormat archiveFormat, boolean deleteAfterwards) Appends multiple folders to an existing archive
boolean	appendFoldersToArchive(java.io.File archiveSourceFile, java.io.File archiveTargetFile, java.util.HashMap<java.io.File,java.lang.String> folders, boolean deleteAfterwards) Appends multiple folders to an existing archive.
boolean	appendFolderToArchive(java.io.File folder, java.io.File archiveFile, java.io.File targetFile) Adds a folder to an archive.
boolean	appendFolderToArchive(java.io.File folder, java.io.File archiveFile, java.io.File targetFile, java.lang.String pathInsideArchive) Appends a folder to an existing archive.
boolean	appendFolderToArchive(java.io.File folder, java.io.File archiveFile, java.io.File targetFile, java.lang.String pathInsideArchive, ArchiveFileHandler.ArchiveFormat archiveFormat) Appends a folder to an existing archive.
boolean	compressFolder(java.io.File sourceFolder, java.io.File targetFile) Compresses a folder.
boolean	compressFolder(java.io.File sourceFolder, java.io.File targetFile, ArchiveFileHandler.ArchiveFormat archiveFormat) Compresses a folder.
boolean	decompressFolder(java.io.File archiveFile, java.io.File targetFolder) Decompresses an archive.
boolean	decompressFolder(java.io.File archiveFile, java.io.File targetFolder, ArchiveFileHandler.ArchiveFormat archiveFormat) Decompresses an archive file to the specified target folder.
void	deletePathReplacement(java.lang.String dontReplace) Deletes a previously defined replacement.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveFileHandler

public ArchiveFileHandler()

Method Detail

compressFolder

public boolean compressFolder(java.io.File sourceFolder,
                              java.io.File targetFile)

Compresses a folder. The archive format is determined from the target file name.

Parameters:

sourceFolder - the source folder

targetFile - the target file

Returns:

true, if successful

compressFolder

public boolean compressFolder(java.io.File sourceFolder,
                              java.io.File targetFile,
                              ArchiveFileHandler.ArchiveFormat archiveFormat)

Compresses a folder.

Parameters:

sourceFolder - the source folder

targetFile - the target file

archiveFormat - the archive format

Returns:

true, if successful

decompressFolder

public boolean decompressFolder(java.io.File archiveFile,
                                java.io.File targetFolder)

Decompresses an archive. The archive format is determined from the file name.

Parameters:

archiveFile - the archive file

targetFolder - the target folder

Returns:

true, if successful

decompressFolder

public boolean decompressFolder(java.io.File archiveFile,
                                java.io.File targetFolder,
                                ArchiveFileHandler.ArchiveFormat archiveFormat)

Decompresses an archive file to the specified target folder.

Parameters:

archiveFile - the archive file

targetFolder - the target folder

archiveFormat - the archive format

Returns:

true, if successful

appendFolderToArchive

public boolean appendFolderToArchive(java.io.File folder,
                                     java.io.File archiveFile,
                                     java.io.File targetFile)
                              throws java.io.IOException

Adds a folder to an archive. The archive format is determined from the file name.

Parameters:

folder - the folder

archiveFile - the archive file

Returns:

true, if successful

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

appendFolderToArchive

public boolean appendFolderToArchive(java.io.File folder,
                                     java.io.File archiveFile,
                                     java.io.File targetFile,
                                     java.lang.String pathInsideArchive)
                              throws java.io.IOException

Appends a folder to an existing archive. The archive format is determined from the file name.

Parameters:

folder - the folder to add

archiveFile - the archive file the original archive

targetFile - the new extended archive

pathInsideArchive - the path inside archive for the new content

Returns:

true, if successful

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

appendFolderToArchive

public boolean appendFolderToArchive(java.io.File folder,
                                     java.io.File archiveFile,
                                     java.io.File targetFile,
                                     java.lang.String pathInsideArchive,
                                     ArchiveFileHandler.ArchiveFormat archiveFormat)

Appends a folder to an existing archive.

Parameters:

folder - the folder to add

archiveFile - the archive file the original archive

targetFile - the new extended archive

pathInsideArchive - the path inside archive for the new content

archiveFormat - the archive format

Returns:

true, if successful

appendFoldersToArchive

public boolean appendFoldersToArchive(java.io.File archiveSourceFile,
                                      java.io.File archiveTargetFile,
                                      java.util.HashMap<java.io.File,java.lang.String> folders,
                                      boolean deleteAfterwards)

Appends multiple folders to an existing archive. The archive format is determines from the file extension.

Parameters:

archiveSourceFile - The original archive

archiveTargetFile - The resulting extended archive

folders - HashMap containing the folders to add as keys and their paths inside the archive as values

deleteAfterwards - if true, the folders will be deleted after integrating them into the archive

Returns:

successful?

appendFoldersToArchive

public boolean appendFoldersToArchive(java.io.File archiveSourceFile,
                                      java.io.File archiveTargetFile,
                                      java.util.HashMap<java.io.File,java.lang.String> folders,
                                      ArchiveFileHandler.ArchiveFormat archiveFormat,
                                      boolean deleteAfterwards)

Appends multiple folders to an existing archive

Parameters:

archiveSourceFile - The original archive

archiveTargetFile - The resulting extended archive

folders - HashMap containing the folders to add as keys and their paths inside the archive as values

archiveFormat - The archive format

deleteAfterwards - if true, the folders will be deleted after integrating them into the archive

Returns:

successful?

addPathReplacement

public void addPathReplacement(java.lang.String replace,
                               java.lang.String replaceWith)

Adds a path replacement. When adding a file or folder to the archive, every occurrence of replace will be replaced with replaceWith

Parameters:

replace - the string to be replaced

replaceWith - the string to replace it with

deletePathReplacement

public void deletePathReplacement(java.lang.String dontReplace)

Deletes a previously defined replacement.

Parameters:

dontReplace -