Module com.renomad.minum

Package com.renomad.minum.utils

Interface IFileUtils

All Known Implementing Classes:

FileUtils

public interface IFileUtils

This interface allows us to mock out many of the I/O methods of the framework for easier testing of IOExceptions.

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.
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 dbDirectory)	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...)

Method Details

writeString

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

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

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

Throws:

UtilsException - if an empty path is provided

IOException

write

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

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

Throws:

IOException

readString

String readString(Path path)
           throws IOException

A wrapper around Files.readString(Path)

Returns:

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

Throws:

UtilsException - if an empty path is provided

IOException

deleteDirectoryRecursivelyIfExists

void deleteDirectoryRecursivelyIfExists(Path myPath)
                                 throws IOException

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 safeResolve(String, String) first against the path to ensure it uses valid characters and prevent it escaping the expected directory.

Throws:

IOException

makeDirectory

void makeDirectory(Path directory)
            throws IOException

Creates a directory if it doesn't already exist.

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

Throws:

IOException

readBinaryFile

byte[] readBinaryFile(String path)
               throws IOException

Read a binary file, return as a byte array

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

Throws:

IOException

readAllLines

List<String> readAllLines(Path path)
                   throws IOException

A wrapper around Files.readAllLines(Path)

Throws:

IOException

readTextFile

String readTextFile(String path)
             throws IOException

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

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

Throws:

IOException

checkFileIsWithinDirectory

void checkFileIsWithinDirectory(String path,
 String directoryPath)
                         throws IOException

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.

Throws:

ForbiddenUseException - if the file is not within the directory

IOException

safeResolve

Path safeResolve(String parentDirectory,
 String path)
          throws IOException

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

Throws:

IOException

delete

void delete(Path path)
     throws IOException

A wrapper around Files.delete(Path)

Throws:

IOException

move

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

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

Throws:

IOException

exists

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

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

newBufferedWriter

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

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

Throws:

IOException

newBufferedReader

BufferedReader newBufferedReader(Path path,
 Charset cs)
                          throws IOException

A wrapper around Files.newBufferedReader(Path, Charset)

Throws:

IOException

walk

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

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

Throws:

IOException

isRegularFile

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

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

lines

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

A wrapper around Files.lines(Path, Charset)

Throws:

IOException

deleteIfExists

boolean deleteIfExists(Path path)
                throws IOException

A wrapper around Files.deleteIfExists(Path)

Throws:

IOException

size

long size(Path path)
   throws IOException

A wrapper around Files.size(Path)

Throws:

IOException

list

Stream<Path> list(Path dbDirectory)
           throws IOException

A wrapper around Files.list(Path)

Throws:

IOException