Module com.renomad.minum

Package com.renomad.minum.utils

Class FileUtils

java.lang.Object

com.renomad.minum.utils.FileUtils

All Implemented Interfaces:

IFileUtils

public final class FileUtils
extends Object
implements IFileUtils

Helper functions for working with files.

Constructor Summary

Constructors

Constructor	Description
FileUtils(ILogger logger, Constants constants)

Method Summary

Modifier and Type	Method	Description
void	checkFileIsWithinDirectory(String path, String directoryPath)	This method is to provide assurance that the file specified by the path parameter is within the directory specified by directoryPath.
static void	checkForBadFilePatterns(String path)	Checks that the path string avoids bad patterns and meets our whitelist for acceptable characters.
void	delete(Path path)	A wrapper around Files.delete(Path)
void	deleteDirectoryRecursivelyIfExists(Path myPath)	Deletes a directory, deleting everything inside it recursively afterwards.
boolean	deleteIfExists(Path path)	A wrapper around Files.deleteIfExists(Path)
boolean	exists(Path path, LinkOption... options)	A wrapper around Files.exists(Path, LinkOption...)
boolean	isRegularFile(Path path, LinkOption... options)	A wrapper around Files.isRegularFile(Path, LinkOption...)
Stream<String>	lines(Path path, Charset cs)	A wrapper around Files.lines(Path, Charset)
Stream<Path>	list(Path dir)	A wrapper around Files.list(Path)
void	makeDirectory(Path directory)	Creates a directory if it doesn't already exist.
void	move(Path source, Path target, CopyOption... options)	A wrapper around Files.move(Path, Path, CopyOption...)
BufferedReader	newBufferedReader(Path path, Charset cs)	A wrapper around Files.newBufferedReader(Path, Charset)
BufferedWriter	newBufferedWriter(Path path, Charset cs, OpenOption... options)	A wrapper around Files.newBufferedWriter(Path, Charset, OpenOption...)
List<String>	readAllLines(Path path)	A wrapper around Files.readAllLines(Path)
byte[]	readBinaryFile(String path)	Read a binary file, return as a byte array
String	readString(Path path)	A wrapper around Files.readString(Path)
String	readTextFile(String path)	Read a text file from the given path, return as a string.
Path	safeResolve(String parentDirectory, String path)	This helper method will ensure that the requested path is within the parent directory and using safe characters
long	size(Path path)	A wrapper around Files.size(Path)
Stream<Path>	walk(Path start, FileVisitOption... options)	A wrapper around Files.walk(Path, FileVisitOption...)
Path	write(Path path, Iterable<? extends CharSequence> lines, Charset cs, OpenOption... options)	A wrapper around Files.write(Path, Iterable, Charset, OpenOption...)
void	writeString(Path path, String content, OpenOption... options)	A wrapper around Files.writeString(Path, CharSequence, OpenOption...)

Methods inherited from class java.lang.Object

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

Constructor Details

FileUtils

public FileUtils(ILogger logger,
 Constants constants)

Method Details

writeString

public void writeString(Path path,
 String content,
 OpenOption... options)
                 throws IOException

Description copied from interface: IFileUtils

A wrapper around Files.writeString(Path, CharSequence, OpenOption...)

Note: This does *not* protect against untrusted data on its own. Call IFileUtils.safeResolve(String, String) first against the path to ensure it uses valid characters and prevent it escaping the expected directory.

Specified by:

writeString in interface IFileUtils

Throws:

IOException

write

public Path write(Path path,
 Iterable<? extends CharSequence> lines,
 Charset cs,
 OpenOption... options)
           throws IOException

Description copied from interface: IFileUtils

A wrapper around Files.write(Path, Iterable, Charset, OpenOption...)

Specified by:

write in interface IFileUtils

Throws:

IOException

readString

public String readString(Path path)
                  throws IOException

Description copied from interface: IFileUtils

A wrapper around Files.readString(Path)

Specified by:

readString in interface IFileUtils

Returns:

the value of the file at the path parameter, as a string, presuming UTF-8 encoding

Throws:

IOException

deleteDirectoryRecursivelyIfExists

public void deleteDirectoryRecursivelyIfExists(Path myPath)
                                        throws IOException

Description copied from interface: IFileUtils

Deletes a directory, deleting everything inside it recursively afterwards. A more dangerous method than many others, take care.

Note: This does *not* protect against untrusted data on its own. Call IFileUtils.safeResolve(String, String) first against the path to ensure it uses valid characters and prevent it escaping the expected directory.

Specified by:

deleteDirectoryRecursivelyIfExists in interface IFileUtils

Throws:

IOException

makeDirectory

public void makeDirectory(Path directory)
                   throws IOException

Description copied from interface: IFileUtils

Creates a directory if it doesn't already exist.

Note: This does *not* protect against untrusted data on its own. Call IFileUtils.safeResolve(String, String) first against the path to ensure it uses valid characters and prevent it escaping the expected directory.

Specified by:

makeDirectory in interface IFileUtils

Throws:

IOException

readBinaryFile

public byte[] readBinaryFile(String path)
                      throws IOException

Description copied from interface: IFileUtils

Read a binary file, return as a byte array

Note: This does *not* protect against untrusted data on its own. Call IFileUtils.safeResolve(String, String) first against the path to ensure it uses valid characters and prevent it escaping the expected directory.

Specified by:

readBinaryFile in interface IFileUtils

Throws:

IOException

readAllLines

public List<String> readAllLines(Path path)
                          throws IOException

Description copied from interface: IFileUtils

A wrapper around Files.readAllLines(Path)

Specified by:

readAllLines in interface IFileUtils

Throws:

IOException

readTextFile

public String readTextFile(String path)
                    throws IOException

Description copied from interface: IFileUtils

Read a text file from the given path, return as a string.

Note: This does *not* protect against untrusted data on its own. Call IFileUtils.safeResolve(String, String) first against the path to ensure it uses valid characters and prevent it escaping the expected directory.

Specified by:

readTextFile in interface IFileUtils

Throws:

IOException

checkFileIsWithinDirectory

public void checkFileIsWithinDirectory(String path,
 String directoryPath)
                                throws IOException

Description copied from interface: IFileUtils

This method is to provide assurance that the file specified by the path parameter is within the directory specified by directoryPath. Use this for any code that reads from files where the user provides untrusted input.

Specified by:

checkFileIsWithinDirectory in interface IFileUtils

Throws:

IOException

checkForBadFilePatterns

public static void checkForBadFilePatterns(String path)

Checks that the path string avoids bad patterns and meets our whitelist for acceptable characters.

Throws:

IllegalArgumentException - if the input is blank

ForbiddenUseException - if the path parameter contains known bad patterns or includes characters other than the set of characters we will allow for filenames. It is a small set of ascii characters - alphanumerics, underscore, dash, period, forward and backward slash.

safeResolve

public Path safeResolve(String parentDirectory,
 String path)
                 throws IOException

Description copied from interface: IFileUtils

This helper method will ensure that the requested path is within the parent directory and using safe characters

Specified by:

safeResolve in interface IFileUtils

Throws:

IOException

delete

public void delete(Path path)
            throws IOException

Description copied from interface: IFileUtils

A wrapper around Files.delete(Path)

Specified by:

delete in interface IFileUtils

Throws:

IOException

move

public void move(Path source,
 Path target,
 CopyOption... options)
          throws IOException

Description copied from interface: IFileUtils

A wrapper around Files.move(Path, Path, CopyOption...)

Specified by:

move in interface IFileUtils

Throws:

IOException

exists

public boolean exists(Path path,
 LinkOption... options)

Description copied from interface: IFileUtils

A wrapper around Files.exists(Path, LinkOption...)

Specified by:

exists in interface IFileUtils

newBufferedWriter

public BufferedWriter newBufferedWriter(Path path,
 Charset cs,
 OpenOption... options)
                                 throws IOException

Description copied from interface: IFileUtils

A wrapper around Files.newBufferedWriter(Path, Charset, OpenOption...)

Specified by:

newBufferedWriter in interface IFileUtils

Throws:

IOException

newBufferedReader

public BufferedReader newBufferedReader(Path path,
 Charset cs)
                                 throws IOException

Description copied from interface: IFileUtils

A wrapper around Files.newBufferedReader(Path, Charset)

Specified by:

newBufferedReader in interface IFileUtils

Throws:

IOException

walk

public Stream<Path> walk(Path start,
 FileVisitOption... options)
                  throws IOException

Description copied from interface: IFileUtils

A wrapper around Files.walk(Path, FileVisitOption...)

Specified by:

walk in interface IFileUtils

Throws:

IOException

isRegularFile

public boolean isRegularFile(Path path,
 LinkOption... options)

Description copied from interface: IFileUtils

A wrapper around Files.isRegularFile(Path, LinkOption...)

Specified by:

isRegularFile in interface IFileUtils

lines

public Stream<String> lines(Path path,
 Charset cs)
                     throws IOException

Description copied from interface: IFileUtils

A wrapper around Files.lines(Path, Charset)

Specified by:

lines in interface IFileUtils

Throws:

IOException

deleteIfExists

public boolean deleteIfExists(Path path)
                       throws IOException

Description copied from interface: IFileUtils

A wrapper around Files.deleteIfExists(Path)

Specified by:

deleteIfExists in interface IFileUtils

Throws:

IOException

size

public long size(Path path)
          throws IOException

Description copied from interface: IFileUtils

A wrapper around Files.size(Path)

Specified by:

size in interface IFileUtils

Throws:

IOException

list

public Stream<Path> list(Path dir)
                  throws IOException

Description copied from interface: IFileUtils

A wrapper around Files.list(Path)

Specified by:

list in interface IFileUtils

Throws:

IOException