com.github.sbridges.ephemeralfs

Class EphemeralFsFileSystemChecker

java.lang.Object

com.github.sbridges.ephemeralfs.EphemeralFsFileSystemChecker

public final class EphemeralFsFileSystemChecker
extends Object

Utility methods for verifying the state of a file system.

Constructor Summary

Constructors

Constructor and Description
EphemeralFsFileSystemChecker()

Method Summary

Methods

Modifier and Type	Method and Description
static void	assertAllDirectoriesFsynced(Path dir, boolean recursive) Scans directories to make sure the directories have been fsycned.
static void	assertAllFilesFsynced(Path path) If path is a file, asserts that all changes to the file have been fsynced, if path is a directory, recursively scans the directory and asserts that all changes to files found have been fsynced.
static void	assertNoOpenResources(FileSystem fs) Throw if there are any open resources for this file system.

Methods inherited from class java.lang.Object

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

Constructor Detail

EphemeralFsFileSystemChecker

public EphemeralFsFileSystemChecker()

Method Detail

assertNoOpenResources

public static void assertNoOpenResources(FileSystem fs)
                                  throws AssertionError,
                                         ClassCastException

Throw if there are any open resources for this file system.

Parameters:

fs - A FileSystem created with EphemeralFsFileSystemBuilder.build()

Throws:

AssertionError - if a resource is open

ClassCastException - if fs is of the wrong type

See Also:

EphemeralFsFileSystemBuilder.setRecordStackTracesOnOpen(boolean)

assertAllFilesFsynced

public static void assertAllFilesFsynced(Path path)
                                  throws AssertionError,
                                         ClassCastException,
                                         IllegalArgumentException

If path is a file, asserts that all changes to the file have been fsynced, if path is a directory, recursively scans the directory and asserts that all changes to files found have been fsynced.

Parameters:

path - A Path whose FileSystemProvider is EphemeralFsFileSystemProvider

Throws:

AssertionError - if a file has not been fsynced

IllegalArgumentException - if path does not exist

ClassCastException - if path is of the wrong type

assertAllDirectoriesFsynced

public static void assertAllDirectoriesFsynced(Path dir,
                               boolean recursive)
                                        throws AssertionError,
                                               ClassCastException,
                                               IllegalArgumentException

Scans directories to make sure the directories have been fsycned.

This does not make sure that files have been fsynced, just the directories. In unix when adding/removing a file from a directory, the directory must be fsynced. Java inadvertently provides a way to do this on unix file systems by opening a FileChannel on a directory for reading and fsyncing that directory.

Fsyncing directories may not be supported in java 9, see LUCENE-6169

Parameters:

dir - A directory Path whose FileSystemProvider is EphemeralFsFileSystemProvider

recursive - if true recursively scans sub directories to find non fsycned directories

Throws:

AssertionError - if a directory has not been closed

IllegalArgumentException - if path does not exist, or is not a directory

ClassCastException - if path is of the wrong type