Package org.apache.tika.pipes
Class PipesConfigBase
- java.lang.Object
- 
- org.apache.tika.config.ConfigBase
- 
- org.apache.tika.pipes.PipesConfigBase
 
 
- 
- Direct Known Subclasses:
- AsyncConfig,- PipesConfig
 
 public class PipesConfigBase extends ConfigBase 
- 
- 
Field SummaryFields Modifier and Type Field Description static intDEFAULT_MAX_FILES_PROCESSED_PER_PROCESSstatic longDEFAULT_MAX_FOR_EMIT_BATCHdefault size to send back to the PipesClient for batch emitting.static intDEFAULT_NUM_CLIENTSstatic longDEFAULT_SHUTDOWN_CLIENT_AFTER_MILLSstatic intDEFAULT_STALE_FETCHER_DELAY_SECONDSstatic intDEFAULT_STALE_FETCHER_TIMEOUT_SECONDSstatic longDEFAULT_STARTUP_TIMEOUT_MILLISstatic longDEFAULT_TIMEOUT_MILLIS
 - 
Constructor SummaryConstructors Constructor Description PipesConfigBase()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>getForkedJvmArgs()StringgetJavaPath()intgetMaxFilesProcessedPerProcess()Restart the forked PipesServer after it has processed this many files to avoid slow-building memory leaks.longgetMaxForEmitBatchBytes()What is the maximum bytes size per extract that will be allowed to be shipped back to the emit queue in the forking process.intgetNumClients()longgetShutdownClientAfterMillis()longgetSleepOnStartupTimeoutMillis()intgetStaleFetcherDelaySeconds()intgetStaleFetcherTimeoutSeconds()longgetStartupTimeoutMillis()PathgetTikaConfig()longgetTimeoutMillis()voidsetForkedJvmArgs(List<String> jvmArgs)voidsetJavaPath(String javaPath)voidsetMaxFilesProcessedPerProcess(int maxFilesProcessedPerProcess)voidsetMaxForEmitBatchBytes(long maxForEmitBatchBytes)voidsetNumClients(int numClients)voidsetShutdownClientAfterMillis(long shutdownClientAfterMillis)If the client has been inactive after this many milliseconds, shut it down.voidsetSleepOnStartupTimeoutMillis(long sleepOnStartupTimeoutMillis)voidsetStaleFetcherDelaySeconds(int staleFetcherDelaySeconds)voidsetStaleFetcherTimeoutSeconds(int staleFetcherTimeoutSeconds)voidsetStartupTimeoutMillis(long startupTimeoutMillis)voidsetTikaConfig(String tikaConfig)voidsetTikaConfig(Path tikaConfig)voidsetTimeoutMillis(long timeoutMillis)How long to wait in milliseconds before timing out the forked process.- 
Methods inherited from class org.apache.tika.config.ConfigBasebuildComposite, buildComposite, buildSingle, buildSingle, configure, handleSettings
 
- 
 
- 
- 
- 
Field Detail- 
DEFAULT_MAX_FOR_EMIT_BATCHpublic static final long DEFAULT_MAX_FOR_EMIT_BATCH default size to send back to the PipesClient for batch emitting. If an extract is larger than this, it will be emitted directly from the forked PipesServer.- See Also:
- Constant Field Values
 
 - 
DEFAULT_TIMEOUT_MILLISpublic static final long DEFAULT_TIMEOUT_MILLIS - See Also:
- Constant Field Values
 
 - 
DEFAULT_STARTUP_TIMEOUT_MILLISpublic static final long DEFAULT_STARTUP_TIMEOUT_MILLIS - See Also:
- Constant Field Values
 
 - 
DEFAULT_SHUTDOWN_CLIENT_AFTER_MILLSpublic static final long DEFAULT_SHUTDOWN_CLIENT_AFTER_MILLS - See Also:
- Constant Field Values
 
 - 
DEFAULT_NUM_CLIENTSpublic static final int DEFAULT_NUM_CLIENTS - See Also:
- Constant Field Values
 
 - 
DEFAULT_MAX_FILES_PROCESSED_PER_PROCESSpublic static final int DEFAULT_MAX_FILES_PROCESSED_PER_PROCESS - See Also:
- Constant Field Values
 
 - 
DEFAULT_STALE_FETCHER_TIMEOUT_SECONDSpublic static final int DEFAULT_STALE_FETCHER_TIMEOUT_SECONDS - See Also:
- Constant Field Values
 
 - 
DEFAULT_STALE_FETCHER_DELAY_SECONDSpublic static final int DEFAULT_STALE_FETCHER_DELAY_SECONDS - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getTimeoutMillispublic long getTimeoutMillis() 
 - 
setTimeoutMillispublic void setTimeoutMillis(long timeoutMillis) How long to wait in milliseconds before timing out the forked process.- Parameters:
- timeoutMillis-
 
 - 
getShutdownClientAfterMillispublic long getShutdownClientAfterMillis() 
 - 
setShutdownClientAfterMillispublic void setShutdownClientAfterMillis(long shutdownClientAfterMillis) If the client has been inactive after this many milliseconds, shut it down.- Parameters:
- shutdownClientAfterMillis-
 
 - 
getNumClientspublic int getNumClients() 
 - 
setNumClientspublic void setNumClients(int numClients) 
 - 
setStartupTimeoutMillispublic void setStartupTimeoutMillis(long startupTimeoutMillis) 
 - 
getMaxFilesProcessedPerProcesspublic int getMaxFilesProcessedPerProcess() Restart the forked PipesServer after it has processed this many files to avoid slow-building memory leaks.- Returns:
 
 - 
setMaxFilesProcessedPerProcesspublic void setMaxFilesProcessedPerProcess(int maxFilesProcessedPerProcess) 
 - 
getTikaConfigpublic Path getTikaConfig() 
 - 
setTikaConfigpublic void setTikaConfig(Path tikaConfig) 
 - 
setTikaConfigpublic void setTikaConfig(String tikaConfig) 
 - 
getJavaPathpublic String getJavaPath() 
 - 
setJavaPathpublic void setJavaPath(String javaPath) 
 - 
getStartupTimeoutMillispublic long getStartupTimeoutMillis() 
 - 
getMaxForEmitBatchBytespublic long getMaxForEmitBatchBytes() What is the maximum bytes size per extract that will be allowed to be shipped back to the emit queue in the forking process. If an extract is too big, skip the emit queue and forward it directly from the forked PipesServer. If set to0, this will never send an extract back for batch emitting, but will always emit the extract directly from the forked PipeServer. If set to-1, this will always send the extract back for batch emitting.- Returns:
- the threshold extract size at which to emit directly from the forked PipeServer
 
 - 
setMaxForEmitBatchBytespublic void setMaxForEmitBatchBytes(long maxForEmitBatchBytes) 
 - 
getSleepOnStartupTimeoutMillispublic long getSleepOnStartupTimeoutMillis() 
 - 
setSleepOnStartupTimeoutMillispublic void setSleepOnStartupTimeoutMillis(long sleepOnStartupTimeoutMillis) 
 - 
getStaleFetcherTimeoutSecondspublic int getStaleFetcherTimeoutSeconds() 
 - 
setStaleFetcherTimeoutSecondspublic void setStaleFetcherTimeoutSeconds(int staleFetcherTimeoutSeconds) 
 - 
getStaleFetcherDelaySecondspublic int getStaleFetcherDelaySeconds() 
 - 
setStaleFetcherDelaySecondspublic void setStaleFetcherDelaySeconds(int staleFetcherDelaySeconds) 
 
- 
 
-