Package io.datarouter.filesystem.raw

Class PathService

java.lang.Object

io.datarouter.filesystem.raw.PathService

@Singleton
public class PathService
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PathService.CheckedPathService

Constructor Summary

Constructors

Constructor	Description
PathService()

Method Summary

Modifier and Type	Method	Description
void	delete(Path fullPath)
List<Path>	listChildren(Path fullPath, Set<String> excludingFilenames, int limit, boolean sorted)
static String	pathToString(Path path)
io.datarouter.scanner.Scanner<List<Path>>	scanDescendantsPaged(Path fullPath, boolean includeDirectories, boolean sorted)	Recursively scan directories, optionally sorting them in String ordering, since the filesystem may return them in any order, which is often the order that sub-directories were added to a parent.
Long	size(Path path)

Methods inherited from class java.lang.Object

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

Constructor Details

PathService

public PathService()

Method Details

pathToString

public static String pathToString(Path path)

listChildren

public List<Path> listChildren(Path fullPath,
 Set<String> excludingFilenames,
 int limit,
 boolean sorted)

scanDescendantsPaged

public io.datarouter.scanner.Scanner<List<Path>> scanDescendantsPaged(Path fullPath,
 boolean includeDirectories,
 boolean sorted)

Recursively scan directories, optionally sorting them in String ordering, since the filesystem may return them in any order, which is often the order that sub-directories were added to a parent. This allows us to mimic the "list" operation provided by S3 or GCS.

Parameters:

fullPath - Path from the root of the filesystem or relative to the execution point.

includeDirectories - False for results similar to an object store like S3 or GCS

sorted - If true, sort each sub-directory before recursing, so that full paths match String sorting.

Returns:

Lists of Paths grouped by leaf directory, with the leaf directory as the first Path in each List. In the case of a directory with mixed sub-directories and files, group consecutive files into the same List. The number of Lists tries to approximate the number of filesystem operations, but it's probably over-counting by returning each directory as a singleton list.

size

public Long size(Path path)

delete

public void delete(Path fullPath)