Package org.apache.tika.pipes.fetcher.fs

Class FileSystemFetcher

java.lang.Object

org.apache.tika.plugins.AbstractTikaExtension

org.apache.tika.pipes.fetcher.fs.FileSystemFetcher

All Implemented Interfaces:

Fetcher, TikaExtension, org.pf4j.ExtensionPoint

public class FileSystemFetcher
extends AbstractTikaExtension
implements Fetcher

Fetches files from a local/mounted file system. Config:

 "file-system-fetcher": {
 "basePath": "BASE_PATH",
 "extractFileSystemMetadata": false
 }
 
 

Field Summary

Fields inherited from class org.apache.tika.plugins.AbstractTikaExtension

pluginConfig

Constructor Summary

Constructors

Constructor	Description
FileSystemFetcher(ExtensionConfig pluginConfig)

Method Summary

Modifier and Type	Method	Description
TikaInputStream	fetch(String fetchKey, Metadata metadata, ParseContext parseContext)	Fetches a resource and returns it as a TikaInputStream.
String	toString()

Methods inherited from class org.apache.tika.plugins.AbstractTikaExtension

getExtensionConfig

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.tika.plugins.TikaExtension

getExtensionConfig

Constructor Details

FileSystemFetcher

public FileSystemFetcher(ExtensionConfig pluginConfig)
                  throws TikaConfigException

Throws:

TikaConfigException

Method Details

fetch

public TikaInputStream fetch(String fetchKey,
 Metadata metadata,
 ParseContext parseContext)
                      throws IOException,
TikaException

Description copied from interface: Fetcher

Fetches a resource and returns it as a TikaInputStream.

Specified by:

fetch in interface Fetcher

Parameters:

fetchKey - the key identifying the resource to fetch (interpretation depends on the implementation, e.g., file path, URL, S3 key)

metadata - metadata object to be updated with resource information

parseContext - the parse context

Returns:

a TikaInputStream for reading the resource content

Throws:

IOException - if an I/O error occurs during fetching

TikaException - if a Tika-specific error occurs during fetching

toString

public String toString()

Overrides:

toString in class Object