Package net.adoptopenjdk.icedteaweb.io

Class FileUtils

java.lang.Object

net.adoptopenjdk.icedteaweb.io.FileUtils

public final class FileUtils
extends java.lang.Object

This class contains a few file-related utility functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileUtils.OpenFileResult	Indicates whether a file was successfully opened.

Field Summary

Fields

Modifier and Type	Field	Description
private static java.util.List<java.lang.Character>	INVALID_NAME
(package private) static java.util.List<java.lang.Character>	INVALID_PATH	list of characters not allowed in filenames
private static Logger	LOG
private static java.lang.String	MD5
private static char	SANITIZED_CHAR
private static java.lang.String	WIN_DRIVE_LETTER_COLON_WILDCHAR

Constructor Summary

Constructors

Constructor	Description
FileUtils()

Method Summary

Modifier and Type	Method	Description
static void	createParentDir(java.io.File f)	Tries to create the ancestor directories of file f.
static void	createParentDir(java.io.File f, java.lang.String eMsg)	Tries to create the ancestor directories of file f.
static void	deleteWithErrMesg(java.io.File f, java.lang.String eMsg)	Tries to delete file f.
static java.lang.String	displayablePath(java.lang.String path)	Returns a String that is suitable for using in GUI elements for displaying (long) paths to users.
static java.lang.String	displayablePath(java.lang.String path, int visibleChars)	Return a String that is suitable for using in GUI elements for displaying paths to users.
static java.nio.channels.FileLock	getFileLock(java.lang.String path, boolean shared, boolean allowBlock)	This will return a lock to the file specified.
static byte[]	getFileMD5Sum(java.io.File file)
static java.lang.String	loadFileAsString(java.io.File f, java.nio.charset.Charset encoding)
static java.lang.String	loadFileAsUtf8String(java.io.File f)
static void	recursiveDelete(java.io.File file, java.io.File base)	Recursively delete everything under a directory.
static java.lang.String	sanitizeFileName(java.lang.String filename)	Given an input, return a sanitized form of the input suitable for use as a file/directory name
static java.lang.String	sanitizeFileName(java.lang.String filename, char substitute)
static java.lang.String	sanitizePath(java.lang.String path)	Clean up a string by removing characters that can't appear in a local file name.
static java.lang.String	sanitizePath(java.lang.String path, char substitute)
static void	saveFileUtf8(java.lang.String content, java.io.File f)	Save String into a file in UTF-8 encoding.
private static DirectoryCheckResults	testDirectoryPermissions(java.io.File file, boolean isDebug)	Ensure that the parent directory of the file exists and that we are able to create and access files within this directory
static FileUtils.OpenFileResult	testFilePermissions(java.io.File file, boolean isDebug)	Verify that a given file object points to a real, accessible plain file.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final Logger LOG

MD5

private static final java.lang.String MD5

See Also:

Constant Field Values

WIN_DRIVE_LETTER_COLON_WILDCHAR

private static final java.lang.String WIN_DRIVE_LETTER_COLON_WILDCHAR

See Also:

Constant Field Values

INVALID_PATH

static final java.util.List<java.lang.Character> INVALID_PATH

list of characters not allowed in filenames

INVALID_NAME

private static final java.util.List<java.lang.Character> INVALID_NAME

SANITIZED_CHAR

private static final char SANITIZED_CHAR

See Also:

Constant Field Values

Constructor Detail

FileUtils

public FileUtils()

Method Detail

sanitizePath

public static java.lang.String sanitizePath(java.lang.String path)

Clean up a string by removing characters that can't appear in a local file name.

Parameters:

path - the path to sanitize

Returns:

a sanitized version of the input which is suitable for using as a file path

sanitizePath

public static java.lang.String sanitizePath(java.lang.String path,
                                            char substitute)

sanitizeFileName

public static java.lang.String sanitizeFileName(java.lang.String filename)

Given an input, return a sanitized form of the input suitable for use as a file/directory name

Parameters:

filename - the filename to sanitize.

Returns:

a sanitized version of the input

sanitizeFileName

public static java.lang.String sanitizeFileName(java.lang.String filename,
                                                char substitute)

createParentDir

public static void createParentDir(java.io.File f,
                                   java.lang.String eMsg)
                            throws java.io.IOException

Tries to create the ancestor directories of file f. Throws an IOException if it can't be created (but not if it was already there).

Parameters:

f - file to provide parent directory

eMsg - - the message to use for the exception. null if the file name is to be used.

Throws:

java.io.IOException - if the directory can't be created and doesn't exist.

createParentDir

public static void createParentDir(java.io.File f)
                            throws java.io.IOException

Tries to create the ancestor directories of file f. Throws an IOException if it can't be created (but not if it was already there).

Parameters:

f - file which parent will be created

Throws:

java.io.IOException - if the directory can't be created and doesn't exist.

deleteWithErrMesg

public static void deleteWithErrMesg(java.io.File f,
                                     java.lang.String eMsg)

Tries to delete file f. If the file exists but couldn't be deleted, print an error message to stderr with the file name, or eMsg if eMsg is not null.

Parameters:

f - the file to be deleted

eMsg - the message to print on failure (or null to print the the file name).

testDirectoryPermissions

private static DirectoryCheckResults testDirectoryPermissions(java.io.File file,
                                                              boolean isDebug)

Ensure that the parent directory of the file exists and that we are able to create and access files within this directory

Parameters:

file - the File representing a Java Policy file to test

isDebug - output debug information

Returns:

a DirectoryCheckResults object representing the results of the test

testFilePermissions

public static FileUtils.OpenFileResult testFilePermissions(java.io.File file,
                                                           boolean isDebug)

Verify that a given file object points to a real, accessible plain file.

Parameters:

file - the File to verify

isDebug - output debug information

Returns:

an FileUtils.OpenFileResult representing the accessibility level of the file

displayablePath

public static java.lang.String displayablePath(java.lang.String path)

Returns a String that is suitable for using in GUI elements for displaying (long) paths to users.

Parameters:

path - a path that should be shortened

Returns:

a shortened path suitable for displaying to the user

displayablePath

public static java.lang.String displayablePath(java.lang.String path,
                                               int visibleChars)

Return a String that is suitable for using in GUI elements for displaying paths to users. If the path is longer than visibleChars, it is truncated in a display-friendly way

Parameters:

path - a path that should be shorted

visibleChars - the maximum number of characters that path should fit into. Also the length of the returned string

Returns:

a shortened path that contains limited number of chars

recursiveDelete

public static void recursiveDelete(java.io.File file,
                                   java.io.File base)
                            throws java.io.IOException

Recursively delete everything under a directory. Works on either files or directories

Parameters:

file - the file object representing what to delete. Can be either a file or a directory.

base - the directory under which the file and its subdirectories must be located

Throws:

java.io.IOException - on an io exception or if trying to delete something outside the base

getFileLock

public static java.nio.channels.FileLock getFileLock(java.lang.String path,
                                                     boolean shared,
                                                     boolean allowBlock)
                                              throws java.io.FileNotFoundException

This will return a lock to the file specified.

Parameters:

path - File path to file we want to lock.

shared - Specify if the lock will be a shared lock.

allowBlock - Specify if we should block when we can not get the lock. Getting a shared lock will always block.

Returns:

FileLock if we were successful in getting a lock, otherwise null.

Throws:

java.io.FileNotFoundException - If the file does not exist.

loadFileAsUtf8String

public static java.lang.String loadFileAsUtf8String(java.io.File f)
                                             throws java.io.IOException

Throws:

java.io.IOException

loadFileAsString

public static java.lang.String loadFileAsString(java.io.File f,
                                                java.nio.charset.Charset encoding)
                                         throws java.io.IOException

Throws:

java.io.IOException

saveFileUtf8

public static void saveFileUtf8(java.lang.String content,
                                java.io.File f)
                         throws java.io.IOException

Save String into a file in UTF-8 encoding.

Parameters:

content - which will be saved to the file

f - file to be saved. No warnings provided

Throws:

java.io.IOException - if save fails

getFileMD5Sum

public static byte[] getFileMD5Sum(java.io.File file)
                            throws java.security.NoSuchAlgorithmException,
                                   java.io.IOException

Throws:

java.security.NoSuchAlgorithmException

java.io.IOException