com.lazerycode.selenium.extract

Class FileExtractor

java.lang.Object

com.lazerycode.selenium.extract.FileExtractor

public class FileExtractor
extends Object

Constructor Summary

Constructors

Constructor and Description
FileExtractor(boolean overwriteFilesThatExist)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	copyFileToDisk(InputStream inputStream, String pathToExtractTo, String filename) Copy a file from an inputsteam to disk
String	extractFileFromArchive(File downloadedCompressedFile, String extractedToFilePath, BinaryType possibleFilenames) Extract binary from a downloaded archive file
protected String	untarFile(InputStream compressedFileInputStream, String extractedToFilePath, BinaryType possibleFilenames) Untar a decompressed tar file (this will implicitly overwrite any existing files)
protected String	unzipFile(File downloadedCompressedFile, String extractedToFilePath, BinaryType possibleFilenames) Unzip a downloaded zip file (this will implicitly overwrite any existing files)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileExtractor

public FileExtractor(boolean overwriteFilesThatExist)

Parameters:

overwriteFilesThatExist - Overwrite any existing files

Method Detail

extractFileFromArchive

public String extractFileFromArchive(File downloadedCompressedFile,
                            String extractedToFilePath,
                            BinaryType possibleFilenames)
                              throws IOException,
                                     IllegalArgumentException,
                                     org.apache.maven.plugin.MojoFailureException

Extract binary from a downloaded archive file

Parameters:

downloadedCompressedFile - The downloaded compressed file

extractedToFilePath - Path to extracted file

possibleFilenames - Names of the files we want to extract

Returns:

boolean

Throws:

IOException - Unable to write to filesystem

IllegalArgumentException - Unsupported archive

org.apache.maven.plugin.MojoFailureException - Error running plugin

unzipFile

protected String unzipFile(File downloadedCompressedFile,
               String extractedToFilePath,
               BinaryType possibleFilenames)
                    throws IOException,
                           ExpectedFileNotFoundException

Unzip a downloaded zip file (this will implicitly overwrite any existing files)

Parameters:

downloadedCompressedFile - The downloaded zip file

extractedToFilePath - Path to extracted file

possibleFilenames - Names of the files we want to extract

Returns:

boolean

Throws:

IOException

ExpectedFileNotFoundException

untarFile

protected String untarFile(InputStream compressedFileInputStream,
               String extractedToFilePath,
               BinaryType possibleFilenames)
                    throws IOException,
                           ExpectedFileNotFoundException

Untar a decompressed tar file (this will implicitly overwrite any existing files)

Parameters:

compressedFileInputStream - The expanded tar file

extractedToFilePath - Path to extracted file

possibleFilenames - Names of the files we want to extract

Returns:

boolean

Throws:

IOException - MojoFailureException

ExpectedFileNotFoundException

copyFileToDisk

protected String copyFileToDisk(InputStream inputStream,
                    String pathToExtractTo,
                    String filename)
                         throws IOException

Copy a file from an inputsteam to disk

Parameters:

inputStream - A valid iput stream to read

pathToExtractTo - Path of the file we want to create

filename - Filename of the file we want to create

Returns:

Absolute path of the newly created file (Or existing file if overwriteFilesThatExist is set to false)

Throws:

IOException