com.aspc.remote.util.misc

Class FileUtil

java.lang.Object

com.aspc.remote.util.misc.FileUtil

public final class FileUtil
extends java.lang.Object

FileUtil
THREAD MODE: MULTI-THREADED

Since:

17 September 1998

Author:

Luke

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CACHE_DIR The cache directory.
static java.lang.String	DOC_CACHE The document cache directory.
static int	MAX_FILE_NAME_LENGTH
static java.lang.String	MIME_APPLICATION_OCTET_STREAM

Method Summary

Modifier and Type	Method and Description
static void	addFilesRecursively(java.io.File file, java.util.Collection all, java.lang.String pattern) Add all child directories and files matched one pattern Under a directory into a collection
static java.lang.String	addTmpFolder(java.lang.String srcUrl) a common function to add tmp folder to a url
static java.lang.String	adjustMimeType(java.lang.String orginalMimeType, java.io.File file, ClientBrowser browser) Adjust the mime types There seems to be some confusion with blackberry needed a different mime type for word.
static void	compressFile(java.io.File inFile, java.io.File targetFile) Compresses a file
static void	copy(java.io.File srcFile, java.io.File targetFile) Copies file from one file to another
static void	copyDirectory(java.io.File sourceLocation, java.io.File targetLocation) If targetLocation does not exist, it will be created.
static java.io.File	createNewFileToOpen(java.lang.String name) Creates a file in the user home directory with unique name.
static void	decompressFile(java.io.File inFile, java.io.File targetFile) Decompress a file using the gzip format.
static void	deleteAll(java.io.File fileOrDirectory) Delete all from a directory ( including the directory) or simple file.
static int	deleteFromDirectory(java.io.File directory, java.lang.String fileNameRegEx, boolean recursive) Delete a pattern from a directory
static boolean	doesContentMatch(java.io.File first, java.io.File second) Compare the content of two files.
static void	doZip(java.util.ArrayList<java.io.File> files, java.io.File zipfile) Create a simple zip file
static void	doZip(java.lang.String fileOrDirToAdd, java.lang.String zipFileName, java.lang.String incPattern, java.lang.String excPattern) add a file or directory to the zip file, if the zip file exists, it will be overridden if a file matches both incPattern and excPattern, it will not be added to the zip
static byte[]	generateDigest(java.io.File file, java.lang.String algorithum) Generates Digest.
static byte[]	generateMD5(java.io.File file) Generates MD5.
static byte[]	generateSHA1(java.io.File file) Generates SHA1.
static byte[]	generateSHA512(java.io.File file) Generates SHA512.
static java.lang.String	getBaseFromPath(java.lang.String path) Gets the directory portion of a file path, if there is one.
static java.lang.String	getCachePath() get the doc cache path
static java.lang.String	getDocCachePath() get the doc cache path
static java.lang.String	getName(java.lang.String path) Gets the name portion of a file path
static java.lang.String	guessMimeType(java.io.File file)
static void	iSetFileValidationHandler(FileValidationHandler handler) set the validation handler.
static boolean	isValid(java.io.File file, java.lang.String checkSum, long size) Verifies a file against a checksum.
static java.io.File	makeCacheFile(java.lang.String URLs, java.lang.String path) Make a cache file and create the sub directories.
static java.io.File	makeQuarantineDirectory() Make quarantine directory.
static void	mkdirs(java.io.File dir) create the directory if NOT present.
static void	mkdirs(java.lang.String dir) create the directory if NOT present.
static boolean	openFileInDefaultApplication(java.io.File file) Opens a file in a Linux or Windows environment.
static java.lang.String	readableFileSize(long size) Readable format in KB/MB/GB
static java.lang.String	readEntry(java.util.zip.ZipFile zipFile, java.util.zip.ZipEntry zipEntry)
static java.lang.String	readFile(java.io.File file) Read the file content as a String.
static java.lang.String	readFile(java.lang.String fileName) Read a file into a String
static byte[]	readFileAsBytes(java.io.File file) Read the file content as a String.
static byte[]	readFileAsBytes(java.lang.String fn) Read the file content as a String.
static void	replaceTargetWithTempFile(java.io.File tempFile, java.io.File targetFile) Rename the temp file to the target file, if the target exists then delete it or move it out of the way ( if it doesn't match the temp file).
static java.lang.String	requiredExtension(java.lang.String mimeType, java.lang.String defaultExtension)
static void	unZip(java.io.File zipfile) unzip a zip file
static java.lang.String	updateNumberedName(java.lang.String n) Updates a name that is numbered with the convention name[n] where n represents a number.
static void	validate(java.io.File file, java.lang.String chk, long size) Verifies a file against a checksum.
static void	writeFile(java.io.File file, java.lang.String content) write the content to the file.

Methods inherited from class java.lang.Object

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

Field Detail

MIME_APPLICATION_OCTET_STREAM

public static final java.lang.String MIME_APPLICATION_OCTET_STREAM

See Also:

Constant Field Values

DOC_CACHE

public static final java.lang.String DOC_CACHE

The document cache directory. If not set then we will use CACHE_DIR.

See Also:

Constant Field Values

MAX_FILE_NAME_LENGTH

public static final int MAX_FILE_NAME_LENGTH

See Also:

Constant Field Values

CACHE_DIR

public static final java.lang.String CACHE_DIR

The cache directory.

See Also:

Constant Field Values

Method Detail

guessMimeType

@CheckReturnValue
 @Nonnull
public static java.lang.String guessMimeType(@Nonnull
                                                                         java.io.File file)

Parameters:

file -

Returns:

the mime type

adjustMimeType

@CheckReturnValue
 @Nonnull
public static java.lang.String adjustMimeType(@Nullable
                                                                          java.lang.String orginalMimeType,
                                                                          @Nonnull
                                                                          java.io.File file,
                                                                          @Nullable
                                                                          ClientBrowser browser)

Adjust the mime types There seems to be some confusion with blackberry needed a different mime type for word. see http://filext.com/faq/office_mime_types.php

Parameters:

orginalMimeType - the original mime type

file - the file

browser - The browser

Returns:

the new mime type

requiredExtension

@CheckReturnValue
 @Nonnull
public static java.lang.String requiredExtension(@Nullable
                                                                             java.lang.String mimeType,
                                                                             @Nonnull
                                                                             java.lang.String defaultExtension)

makeQuarantineDirectory

@CheckReturnValue
 @Nonnull
public static java.io.File makeQuarantineDirectory()
                                                                        throws java.io.IOException

Make quarantine directory. The quarantine directory contains files that have not been verified yet ( virus, cryptolocker etc).

Returns:

the quarantine directory

Throws:

java.io.IOException - could not create directory.

doesContentMatch

@CheckReturnValue
public static boolean doesContentMatch(@Nullable
                                                         java.io.File first,
                                                         @Nullable
                                                         java.io.File second)
                                                  throws java.lang.IllegalArgumentException,
                                                         java.io.IOException

Compare the content of two files. Both files must be files (not directories) and exist.

Parameters:

first - - first file

second - - second file

Returns:

boolean - true if files are binary equal

Throws:

java.io.IOException - - error in function

java.lang.IllegalArgumentException

readEntry

@CheckReturnValue
 @Nonnull
public static java.lang.String readEntry(@Nonnull
                                                                     java.util.zip.ZipFile zipFile,
                                                                     @Nonnull
                                                                     java.util.zip.ZipEntry zipEntry)
                                                              throws java.lang.Exception

Throws:

java.lang.Exception

mkdirs

public static void mkdirs(@Nonnull
                          java.lang.String dir)
                   throws java.io.IOException

create the directory if NOT present.

Parameters:

dir - the directory to create

Throws:

java.io.IOException - if the directory doesn't exist and we can't create it

mkdirs

public static void mkdirs(@Nonnull
                          java.io.File dir)
                   throws java.io.IOException

create the directory if NOT present.

Parameters:

dir - the directory to create

Throws:

java.io.IOException - if the directory doesn't exist and we can't create it

deleteFromDirectory

@Nonnegative
public static int deleteFromDirectory(@Nonnull
                                                   java.io.File directory,
                                                   @Nonnull @RegEx
                                                   java.lang.String fileNameRegEx,
                                                   boolean recursive)
                                            throws java.io.IOException

Delete a pattern from a directory

Parameters:

directory - the directory to scan.

fileNameRegEx - the file name pattern

recursive - check directories recursively.

Returns:

the count of files deleted.

Throws:

java.io.IOException - could not delete.

deleteAll

public static void deleteAll(@Nullable
                             java.io.File fileOrDirectory)
                      throws java.io.IOException

Delete all from a directory ( including the directory) or simple file. This method will throw an IOException if the directory/file is not removed for some reason. This method will try to delete ( if the file/directory exists) then if that fails rename. Only if we can not remove/rename will an IOException be thrown.

Parameters:

fileOrDirectory - the file/directory to delete

Throws:

java.io.IOException - if an IO exception occurs.

openFileInDefaultApplication

@CheckReturnValue
public static boolean openFileInDefaultApplication(@Nonnull
                                                                     java.io.File file)
                                                              throws java.lang.Exception

Opens a file in a Linux or Windows environment.

Parameters:

file - the file to open

Returns:

true if Ok

Throws:

java.lang.Exception - If something went wrong

createNewFileToOpen

@CheckReturnValue
 @Nonnull
public static java.io.File createNewFileToOpen(@Nonnull
                                                                           java.lang.String name)
                                                                    throws java.lang.Exception

Creates a file in the user home directory with unique name.

Parameters:

name - The base name

Returns:

file to open

Throws:

java.lang.Exception - If something went wrong

replaceTargetWithTempFile

public static void replaceTargetWithTempFile(@Nonnull
                                             java.io.File tempFile,
                                             @Nonnull
                                             java.io.File targetFile)
                                      throws java.io.IOException

Rename the temp file to the target file, if the target exists then delete it or move it out of the way ( if it doesn't match the temp file).

Two problems were found :- 1. On the server side we can't copy/decrypt/compress/ftp/sftp to the target file as there are many race conditions when we have a number of threads/JVMs looking at the same files. 2. Checksum wasn't being performed on existing files only when they were transferred. The combination of these two problems was what we saw. Thread A came along found that a file didn't exist so it started to transfer it from UK, thread B came along a milliseconds later and found that the file did exist ( zero bytes at this stage) and transferred it to NY file store. On the server side we now have a cache of the files that have have a checksum performed. This cache is keyed on the file path and the file modification time & size is checked to make sure it's current. We've changed all the places that we were doing a copy/decrypt/compress/ftp/sftp to the target file and write to a temp file instead, we then attempt to move this temp file to the target file at the end of the process. If this move fails we check if the target file now exists if the target file exists and the checksum/size match then it was just a race condition and we don't bother with the move. If the target file is not the same as the temp file we try to delete the target file, if that fails ( someone reading the target file) then we move the target file out of the way and then rename the temp file.

Parameters:

tempFile - the temp file that was written to.

targetFile - target file is replaced by the temp file.

Throws:

java.io.IOException - we could not move the temp file to the target file.

copyDirectory

public static void copyDirectory(@Nonnull
                                 java.io.File sourceLocation,
                                 @Nonnull
                                 java.io.File targetLocation)
                          throws java.lang.Exception

If targetLocation does not exist, it will be created.

Parameters:

sourceLocation - the source directory

targetLocation - the target directory

Throws:

java.lang.Exception - a serious problem

copy

public static void copy(@Nonnull
                        java.io.File srcFile,
                        @Nonnull
                        java.io.File targetFile)
                 throws java.io.IOException

Copies file from one file to another

Parameters:

srcFile - source file

targetFile - target file

Throws:

java.io.IOException - a serious problem

writeFile

public static void writeFile(@Nonnull
                             java.io.File file,
                             @Nonnull
                             java.lang.String content)
                      throws java.io.IOException

write the content to the file. The file will be overridden if it exists

Parameters:

file - file to write

content - string content

Throws:

java.io.IOException

readFile

@CheckReturnValue
 @Nonnull
public static java.lang.String readFile(@Nonnull
                                                                    java.lang.String fileName)
                                                             throws java.lang.Exception

Read a file into a String

Parameters:

fileName - The file to read.

Returns:

The data from the file as a string.

Throws:

java.lang.Exception - a serious problem

readFile

@CheckReturnValue
 @Nonnull
public static java.lang.String readFile(@Nonnull
                                                                    java.io.File file)
                                                             throws java.io.IOException

Read the file content as a String.

Parameters:

file - the file to read.

Returns:

the value

Throws:

java.io.IOException - Exception A serious problem

readFileAsBytes

@CheckReturnValue
 @Nonnull
public static byte[] readFileAsBytes(@Nonnull
                                                                 java.lang.String fn)
                                                          throws java.io.IOException

Read the file content as a String.

Parameters:

fn - the file to read.

Returns:

the value

Throws:

java.io.IOException - Exception A serious problem

readFileAsBytes

@CheckReturnValue
 @Nonnull
public static byte[] readFileAsBytes(@Nonnull
                                                                 java.io.File file)
                                                          throws java.io.IOException

Read the file content as a String.

Parameters:

file - the file to read.

Returns:

the value

Throws:

java.io.IOException - Exception A serious problem

generateSHA512

public static byte[] generateSHA512(@Nonnull
                                    java.io.File file)
                             throws java.io.IOException

Generates SHA512.

Parameters:

file - The input file

Returns:

digest

Throws:

java.io.IOException - If something went wrong

generateMD5

@CheckReturnValue
 @Nonnull
public static byte[] generateMD5(@Nonnull
                                                             java.io.File file)
                                                      throws java.io.IOException

Generates MD5.

Parameters:

file - The input file

Returns:

digest

Throws:

java.io.IOException - If something went wrong

generateSHA1

@CheckReturnValue
 @Nonnull
public static byte[] generateSHA1(@Nonnull
                                                              java.io.File file)
                                                       throws java.io.IOException

Generates SHA1.

Parameters:

file - The input file

Returns:

digest

Throws:

java.io.IOException - If something went wrong

generateDigest

@CheckReturnValue
 @Nonnull
public static byte[] generateDigest(@Nonnull
                                                                java.io.File file,
                                                                java.lang.String algorithum)
                                                         throws java.io.IOException

Generates Digest.

Parameters:

file - The input file

algorithum - SHA1, SHA512

Returns:

checksum

Throws:

java.io.IOException - If something went wrong

doZip

public static void doZip(@Nullable
                         java.util.ArrayList<java.io.File> files,
                         @Nonnull
                         java.io.File zipfile)

Create a simple zip file

Parameters:

files - the files

zipfile - the target

doZip

public static void doZip(@Nonnull
                         java.lang.String fileOrDirToAdd,
                         @Nonnull
                         java.lang.String zipFileName,
                         @Nullable
                         java.lang.String incPattern,
                         @Nullable
                         java.lang.String excPattern)
                  throws java.io.IOException

add a file or directory to the zip file, if the zip file exists, it will be overridden if a file matches both incPattern and excPattern, it will not be added to the zip

Parameters:

fileOrDirToAdd - full name of file or dir

zipFileName - zip file name

incPattern - file path patterns that should be included, comma separated

excPattern - file path patterns that should be excluded, comma separated

Throws:

java.io.IOException - IO exception

unZip

public static void unZip(@Nonnull
                         java.io.File zipfile)

unzip a zip file

Parameters:

zipfile -

addFilesRecursively

public static void addFilesRecursively(@Nonnull
                                       java.io.File file,
                                       @Nonnull
                                       java.util.Collection all,
                                       @Nonnull
                                       java.lang.String pattern)

Add all child directories and files matched one pattern Under a directory into a collection

Parameters:

file -

all -

pattern - file pattern, not for directory

compressFile

public static void compressFile(@Nonnull
                                java.io.File inFile,
                                @Nonnull
                                java.io.File targetFile)
                         throws java.lang.Exception

Compresses a file

Parameters:

targetFile - the compressed file

inFile - the file to compress

Throws:

java.lang.Exception - failure to compress the file

decompressFile

public static void decompressFile(@Nonnull
                                  java.io.File inFile,
                                  @Nonnull
                                  java.io.File targetFile)
                           throws java.lang.Exception

Decompress a file using the gzip format.

Parameters:

targetFile - Output file

inFile - Input file

Throws:

java.lang.Exception - If something went wrong

isValid

@CheckReturnValue
public static boolean isValid(@Nonnull
                                                java.io.File file,
                                                @Nullable
                                                java.lang.String checkSum,
                                                long size)

Verifies a file against a checksum.

Parameters:

size - the file size to check

file - the file to verify

checkSum - the expected checksum for the file

Returns:

boolean true if a checksum generated on the file == expected checksum

validate

public static void validate(java.io.File file,
                            java.lang.String chk,
                            long size)
                     throws FileValidationException

Verifies a file against a checksum.

Parameters:

size - the file size to check

file - the file to verify

chk - the expected checksum for the file

Throws:

FileValidationException - validation exception

getBaseFromPath

@CheckReturnValue
 @Nonnull
public static java.lang.String getBaseFromPath(@Nonnull
                                                                           java.lang.String path)

Gets the directory portion of a file path, if there is one.

Parameters:

path - the file path

Returns:

String the directory portion

getName

@CheckReturnValue
 @Nonnull
public static java.lang.String getName(@Nonnull
                                                                   java.lang.String path)

Gets the name portion of a file path

Parameters:

path - the file path

Returns:

String the name portion

updateNumberedName

@CheckReturnValue
 @Nonnull
public static java.lang.String updateNumberedName(@Nullable
                                                                              java.lang.String n)

Updates a name that is numbered with the convention name[n] where n represents a number. examples: "name" becomes "name[1]" "name[1]" becomes "name[2]"

Parameters:

n - the name to update

Returns:

String the updated name

getCachePath

@CheckReturnValue
 @Nonnull
public static java.lang.String getCachePath()

get the doc cache path

Returns:

the path

getDocCachePath

@CheckReturnValue
 @Nonnull
public static java.lang.String getDocCachePath()

get the doc cache path

Returns:

the path

makeCacheFile

@CheckReturnValue
 @Nonnull
public static java.io.File makeCacheFile(@Nullable
                                                                     java.lang.String URLs,
                                                                     @Nonnull
                                                                     java.lang.String path)
                                                              throws java.lang.Exception

Make a cache file and create the sub directories.

Parameters:

URLs - the urls

path - The path for the file.

Returns:

The cache file

Throws:

java.lang.Exception - A serious problem

addTmpFolder

@CheckReturnValue
 @Nonnull
public static java.lang.String addTmpFolder(@Nonnull
                                                                        java.lang.String srcUrl)

a common function to add tmp folder to a url

Parameters:

srcUrl - String the src url path

Returns:

the src url path with tmp folder

iSetFileValidationHandler

public static void iSetFileValidationHandler(@Nonnull
                                             FileValidationHandler handler)

set the validation handler.

Parameters:

handler - the handler to use

readableFileSize

@CheckReturnValue
 @Nonnull
public static java.lang.String readableFileSize(long size)

Readable format in KB/MB/GB

Parameters:

size -

Returns:

the value