org.apache.tika.pipes.reporters.fs

Class FileSystemStatusReporter

java.lang.Object

org.apache.tika.pipes.PipesReporter

org.apache.tika.pipes.reporters.fs.FileSystemStatusReporter

All Implemented Interfaces:

Closeable, AutoCloseable, Initializable

public class FileSystemStatusReporter
extends PipesReporter
implements Initializable

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 AsyncStatus 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.pipes.PipesReporter

NO_OP_REPORTER

Constructor Summary

Constructors

Constructor and Description
FileSystemStatusReporter()

Method Summary

Modifier and Type	Method and Description
void	checkInitialization(InitializableProblemHandler problemHandler)
void	close() No-op implementation.
void	error(String msg) This is called if the process has crashed.
void	error(Throwable t) This is called if the process has crashed.
void	initialize(Map<String,Param> params)
void	report(FetchEmitTuple t, PipesResult result, long elapsed)
void	report(TotalCountResult totalCountResult) No-op implementation.
void	setReportUpdateMillis(long millis)
void	setStatusFile(String path)
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

Constructor Detail

FileSystemStatusReporter

public FileSystemStatusReporter()

Method Detail

setStatusFile

@Field
public void setStatusFile(String path)

setReportUpdateMillis

@Field
public void setReportUpdateMillis(long millis)

initialize

public void initialize(Map<String,Param> params)
                throws TikaConfigException

Specified by:

initialize in interface Initializable

Parameters:

params - params to use for initialization

Throws:

TikaConfigException

checkInitialization

public void checkInitialization(InitializableProblemHandler problemHandler)
                         throws TikaConfigException

Specified by:

checkInitialization in interface Initializable

Parameters:

problemHandler - if there is a problem and no custom initializableProblemHandler has been configured via Initializable parameters, this is called to respond.

Throws:

TikaConfigException

close

public void close()
           throws IOException

Description copied from class: PipesReporter

No-op implementation. Override for custom behavior

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class PipesReporter

Throws:

IOException

error

public void error(Throwable t)

Description copied from class: PipesReporter

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

Specified by:

error in class PipesReporter

error

public void error(String msg)

Description copied from class: PipesReporter

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

Specified by:

error in class PipesReporter

report

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

Specified by:

report in class PipesReporter

report

public void report(TotalCountResult totalCountResult)

Description copied from class: PipesReporter

No-op implementation. Override for custom behavior and make sure to override PipesReporter.supportsTotalCount() to return true

Overrides:

report in class PipesReporter

supportsTotalCount

public boolean supportsTotalCount()

Description copied from class: PipesReporter

Override this if your reporter supports total count.

Overrides:

supportsTotalCount in class PipesReporter

Returns:

false as the baseline implementation