org.apache.tika.batch.fs

Class FSUtil

java.lang.Object

org.apache.tika.batch.fs.FSUtil

public class FSUtil
extends java.lang.Object

Utility class to handle some common issues when reading from and writing to a file system (FS).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FSUtil.HANDLE_EXISTING

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.regex.Pattern	FILE_NAME_PATTERN

Constructor Summary

Constructors

Constructor and Description
FSUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	checkThisIsAncestorOfOrSameAsThat(java.io.File ancestor, java.io.File child) Deprecated.
static boolean	checkThisIsAncestorOfThat(java.io.File ancestor, java.io.File child) Deprecated.
static java.io.File	getOutputFile(java.io.File outputRoot, java.lang.String initialRelativePath, FSUtil.HANDLE_EXISTING handleExisting, java.lang.String suffix) Deprecated.
static java.nio.file.Path	getOutputPath(java.nio.file.Path outputRoot, java.lang.String initialRelativePath, FSUtil.HANDLE_EXISTING handleExisting, java.lang.String suffix) Given an output root and an initial relative path, return the output file according to the HANDLE_EXISTING strategy In the most basic use case, given a root directory "input", a file's relative path "dir1/dir2/fileA.docx", and an output directory "output", the output file would be "output/dir1/dir2/fileA.docx." If HANDLE_EXISTING is set to OVERWRITE, this will not check to see if the output already exists, and the returned file could overwrite an existing file!!! If HANDLE_EXISTING is set to RENAME, this will try to increment a counter at the end of the file name (fileA(2).docx) until there is a file name that doesn't exist.
static java.nio.file.Path	resolveRelative(java.nio.file.Path p, java.lang.String other) Convenience method to ensure that "other" is not an absolute path.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_NAME_PATTERN

private static final java.util.regex.Pattern FILE_NAME_PATTERN

Constructor Detail

FSUtil

public FSUtil()

Method Detail

checkThisIsAncestorOfThat

@Deprecated
public static boolean checkThisIsAncestorOfThat(java.io.File ancestor,
                                                            java.io.File child)

Deprecated.

checkThisIsAncestorOfOrSameAsThat

@Deprecated
public static boolean checkThisIsAncestorOfOrSameAsThat(java.io.File ancestor,
                                                                    java.io.File child)

Deprecated.

getOutputFile

@Deprecated
public static java.io.File getOutputFile(java.io.File outputRoot,
                                                     java.lang.String initialRelativePath,
                                                     FSUtil.HANDLE_EXISTING handleExisting,
                                                     java.lang.String suffix)
                                              throws java.io.IOException

Deprecated.

Given an output root and an initial relative path, return the output file according to the HANDLE_EXISTING strategy

In the most basic use case, given a root directory "input", a file's relative path "dir1/dir2/fileA.docx", and an output directory "output", the output file would be "output/dir1/dir2/fileA.docx."

If HANDLE_EXISTING is set to OVERWRITE, this will not check to see if the output already exists, and the returned file could overwrite an existing file!!!

If HANDLE_EXISTING is set to RENAME, this will try to increment a counter at the end of the file name (fileA(2).docx) until there is a file name that doesn't exist.

This will return null if handleExisting == HANDLE_EXISTING.SKIP and the candidate file already exists.

This will throw an IOException if HANDLE_EXISTING is set to RENAME, and a candidate cannot output file cannot be found after trying to increment the file count (e.g. fileA(2).docx) 10000 times and then after trying 20,000 UUIDs.

Parameters:

outputRoot - directory root for output

initialRelativePath - initial relative path (including file name, which may be renamed)

handleExisting - what to do if the output file exists

suffix - suffix to add to files, can be null

Returns:

output file or null if no output file should be created

Throws:

java.io.IOException

See Also:

getOutputPath(Path, String, HANDLE_EXISTING, String)

getOutputPath

public static java.nio.file.Path getOutputPath(java.nio.file.Path outputRoot,
                                               java.lang.String initialRelativePath,
                                               FSUtil.HANDLE_EXISTING handleExisting,
                                               java.lang.String suffix)
                                        throws java.io.IOException

Given an output root and an initial relative path, return the output file according to the HANDLE_EXISTING strategy

In the most basic use case, given a root directory "input", a file's relative path "dir1/dir2/fileA.docx", and an output directory "output", the output file would be "output/dir1/dir2/fileA.docx."

If HANDLE_EXISTING is set to OVERWRITE, this will not check to see if the output already exists, and the returned file could overwrite an existing file!!!

If HANDLE_EXISTING is set to RENAME, this will try to increment a counter at the end of the file name (fileA(2).docx) until there is a file name that doesn't exist.

This will return null if handleExisting == HANDLE_EXISTING.SKIP and the candidate file already exists.

This will throw an IOException if HANDLE_EXISTING is set to RENAME, and a candidate cannot output file cannot be found after trying to increment the file count (e.g. fileA(2).docx) 10000 times and then after trying 20,000 UUIDs.

Parameters:

outputRoot - root directory into which to put the path

initialRelativePath - relative path including file ("somedir/subdir1/file.doc")

handleExisting - policy for what to do if the output path already exists

suffix - suffix to add to the output path

Returns:

can return null

Throws:

java.io.IOException

resolveRelative

public static java.nio.file.Path resolveRelative(java.nio.file.Path p,
                                                 java.lang.String other)

Convenience method to ensure that "other" is not an absolute path. One could imagine malicious use of this.

Parameters:

p -

other -

Returns:

resolved path

Throws:

java.lang.IllegalArgumentException - if "other" is an absolute path