Package org.apache.tika.pipes.reporter.fs

Class FileSystemStatusReporter

java.lang.Object

org.apache.tika.plugins.AbstractTikaExtension

org.apache.tika.pipes.reporter.fs.FileSystemStatusReporter

All Implemented Interfaces:

Closeable, AutoCloseable, PipesReporter, TikaExtension

public class FileSystemStatusReporter
extends AbstractTikaExtension
implements PipesReporter

This is intended to write summary statistics to disk periodically. As of the 2.5.0 release, this is ALPHA version. There may be breaking changes in the future. Because uses {@link java.time.Instant}, if you are deserializing with jackson-databind, you'll need to add jackson-datatype-jsr310. See the unit tests for how to deserialize AsyncStatus.

Field Summary

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

pluginConfig

Method Summary

Modifier and Type	Method	Description
static FileSystemStatusReporter	build(ExtensionConfig pluginConfig)
void	close()
void	error(String msg)	This is called if the process has crashed.
void	error(Throwable t)	This is called if the process has crashed.
ExtensionConfig	getExtensionConfig()
void	report(FetchEmitTuple t, PipesResult result, long elapsed)
void	report(TotalCountResult totalCountResult)	Make sure to override PipesReporter.supportsTotalCount() to return true
boolean	supportsTotalCount()	Override this if your reporter supports total count.

Methods inherited from class java.lang.Object

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

Method Details

build

public static FileSystemStatusReporter build(ExtensionConfig pluginConfig)
                                      throws TikaConfigException,
IOException

Throws:

TikaConfigException

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

error

public void error(Throwable t)

Description copied from interface: PipesReporter

This is called if the process has crashed. Implementers should not rely on close() to be called after this.

Specified by:

error in interface PipesReporter

error

public void error(String msg)

Description copied from interface: PipesReporter

This is called if the process has crashed. Implementers should not rely on close() to be called after this.

Specified by:

error in interface PipesReporter

report

public void report(FetchEmitTuple t,
 PipesResult result,
 long elapsed)

Specified by:

report in interface PipesReporter

report

public void report(TotalCountResult totalCountResult)

Description copied from interface: PipesReporter

Make sure to override PipesReporter.supportsTotalCount() to return true

Specified by:

report in interface PipesReporter

supportsTotalCount

public boolean supportsTotalCount()

Description copied from interface: PipesReporter

Override this if your reporter supports total count.

Specified by:

supportsTotalCount in interface PipesReporter

Returns:

false as the baseline implementation

getExtensionConfig

public ExtensionConfig getExtensionConfig()

Specified by:

getExtensionConfig in interface TikaExtension

Overrides:

getExtensionConfig in class AbstractTikaExtension