com.inductiveautomation.ignition.gateway.bootstrap

Class BootstrapFileUtils

java.lang.Object

com.inductiveautomation.ignition.gateway.bootstrap.BootstrapFileUtils

public class BootstrapFileUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
BootstrapFileUtils()

Method Summary

Modifier and Type	Method and Description
static void	cleanDirectory(java.io.File directory) Cleans a directory without deleting it.
static void	copyAll(java.io.File sourceFolder, java.io.File destFolder) Copies all of the files (shallow) in the source folder into the destination folder
static void	copyFile(java.io.File source, java.io.File dest) Copies the source file to the destination file, creating the destination if necessary.
static void	copyFile(java.io.InputStream fin, java.io.File dest) Copies all remaining bytes in the input stream to the output file, creating the destination file if necessary.
static void	deleteDirectory(java.io.File directory) Deletes a directory recursively.
static void	forceDelete(java.io.File file) Deletes a file.
static java.io.File	getSubDir(java.io.File base, java.lang.String... subDirs) Returns a File representing a subdirectory, by following the paths from the base folder.

Methods inherited from class java.lang.Object

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

Constructor Detail

BootstrapFileUtils

public BootstrapFileUtils()

Method Detail

copyAll

public static void copyAll(java.io.File sourceFolder,
                           java.io.File destFolder)
                    throws java.io.IOException

Copies all of the files (shallow) in the source folder into the destination folder

Throws:

java.io.IOException

copyFile

public static void copyFile(java.io.File source,
                            java.io.File dest)
                     throws java.io.IOException

Copies the source file to the destination file, creating the destination if necessary.

Throws:

java.io.IOException

copyFile

public static void copyFile(java.io.InputStream fin,
                            java.io.File dest)
                     throws java.io.IOException

Copies all remaining bytes in the input stream to the output file, creating the destination file if necessary. Input steam is not closed.

Parameters:

fin - input stream to copy

dest - where to create/overwrite the copy, creating file.

Throws:

java.io.IOException - when i/o error occurs

getSubDir

public static java.io.File getSubDir(java.io.File base,
                                     java.lang.String... subDirs)

Returns a File representing a subdirectory, by following the paths from the base folder. For example, if base is "C:\Program Files\Inductive Automation\SCADARail\"and you send "abc", "xyz" as subDirs, you'll get the following File back: "C:\Program Files\Inductive Automation\SCADARail\abc\xyz\"

Parameters:

base - A File that represents the starting folders.

subDirs - Names of folders to follow from the base.

Returns:

the File for the subdirectory, relative to the base file.

cleanDirectory

public static void cleanDirectory(java.io.File directory)
                           throws java.io.IOException

Cleans a directory without deleting it.

Parameters:

directory - directory to clean

Throws:

java.io.IOException - in case cleaning is unsuccessful

forceDelete

public static void forceDelete(java.io.File file)
                        throws java.io.IOException

Deletes a file. If file is a directory, delete it and all sub-directories.

The difference between File.delete() and this method are:

• A directory to be deleted does not have to be empty.
• You get exceptions when a file or directory cannot be deleted. (java.io.File methods returns a boolean)

Parameters:

file - file or directory to delete, must not be null

Throws:

java.lang.NullPointerException - if the directory is null

java.io.FileNotFoundException - if the file was not found

java.io.IOException - in case deletion is unsuccessful

deleteDirectory

public static void deleteDirectory(java.io.File directory)
                            throws java.io.IOException

Deletes a directory recursively.

Parameters:

directory - directory to delete

Throws:

java.io.IOException - in case deletion is unsuccessful