Package org.apache.tika.pipes.reporters.opensearch

Class OpenSearchPipesReporter

java.lang.Object

org.apache.tika.pipes.PipesReporter

org.apache.tika.pipes.reporters.opensearch.OpenSearchPipesReporter

All Implemented Interfaces:

Closeable, AutoCloseable, Initializable

public class OpenSearchPipesReporter
extends PipesReporter
implements Initializable

As of the 2.5.0 release, this is ALPHA version. There may be breaking changes in the future.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_EXIT_VALUE_KEY
static String	DEFAULT_PARSE_STATUS_KEY
static String	DEFAULT_PARSE_TIME_KEY

Fields inherited from class org.apache.tika.pipes.PipesReporter

NO_OP_REPORTER

Constructor Summary

Constructors

Constructor	Description
OpenSearchPipesReporter()

Method Summary

Modifier and Type	Method	Description
void	checkInitialization(InitializableProblemHandler problemHandler)
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	setAuthScheme(String authScheme)
void	setConnectionTimeout(int connectionTimeout)
void	setExcludeStatuses(List<String> statusList)
void	setIncludeRouting(boolean includeRouting)
void	setIncludeStatuses(List<String> statusList)
void	setKeyPrefix(String keyPrefix)	This prefixes the keys before sending them to OpenSearch.
void	setOpenSearchUrl(String openSearchUrl)
void	setPassword(String password)
void	setProxyHost(String proxyHost)
void	setProxyPort(int proxyPort)
void	setSocketTimeout(int socketTimeout)
void	setUserName(String userName)

Methods inherited from class org.apache.tika.pipes.PipesReporter

close, report, supportsTotalCount

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PARSE_TIME_KEY

public static String DEFAULT_PARSE_TIME_KEY

DEFAULT_PARSE_STATUS_KEY

public static String DEFAULT_PARSE_STATUS_KEY

DEFAULT_EXIT_VALUE_KEY

public static String DEFAULT_EXIT_VALUE_KEY

Constructor Detail

OpenSearchPipesReporter

public OpenSearchPipesReporter()

Method Detail

report

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

Specified by:

report in class PipesReporter

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

setConnectionTimeout

@Field
public void setConnectionTimeout(int connectionTimeout)

setSocketTimeout

@Field
public void setSocketTimeout(int socketTimeout)

setOpenSearchUrl

@Field
public void setOpenSearchUrl(String openSearchUrl)

setUserName

@Field
public void setUserName(String userName)

setPassword

@Field
public void setPassword(String password)

setAuthScheme

@Field
public void setAuthScheme(String authScheme)

setProxyHost

@Field
public void setProxyHost(String proxyHost)

setProxyPort

@Field
public void setProxyPort(int proxyPort)

setIncludeStatuses

@Field
public void setIncludeStatuses(List<String> statusList)

setExcludeStatuses

@Field
public void setExcludeStatuses(List<String> statusList)

setIncludeRouting

@Field
public void setIncludeRouting(boolean includeRouting)

setKeyPrefix

@Field
public void setKeyPrefix(String keyPrefix)

This prefixes the keys before sending them to OpenSearch. For example, "pdfinfo_", would have this reporter sending "pdfinfo_status" and "pdfinfo_parse_time" to OpenSearch.

Parameters:

keyPrefix -

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