PipesConfigBase (Apache Tika 2.2.0 API)

java.lang.Object
- org.apache.tika.config.ConfigBase
- - org.apache.tika.pipes.PipesConfigBase

Direct Known Subclasses:: AsyncConfig, PipesConfig

public class PipesConfigBase
extends ConfigBase

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_FILES_PROCESSED_PER_PROCESS`
`static long`	`DEFAULT_MAX_FOR_EMIT_BATCH` default size to send back to the PipesClient for batch emitting.
`static int`	`DEFAULT_NUM_CLIENTS`
`static long`	`DEFAULT_SHUTDOWN_CLIENT_AFTER_MILLS`
`static long`	`DEFAULT_STARTUP_TIMEOUT_MILLIS`
`static long`	`DEFAULT_TIMEOUT_MILLIS`

Constructor Summary

Constructors
Constructor and Description

PipesConfigBase()

Constructors
Constructor and Description
`PipesConfigBase()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`getForkedJvmArgs()`
`String`	`getJavaPath()`
`int`	`getMaxFilesProcessedPerProcess()` Restart the forked PipesServer after it has processed this many files to avoid slow-building memory leaks.
`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.
`int`	`getNumClients()`
`long`	`getShutdownClientAfterMillis()`
`long`	`getSleepOnStartupTimeoutMillis()`
`long`	`getStartupTimeoutMillis()`
`Path`	`getTikaConfig()`
`long`	`getTimeoutMillis()`
`void`	`setForkedJvmArgs(List<String> jvmArgs)`
`void`	`setJavaPath(String javaPath)`
`void`	`setMaxFilesProcessedPerProcess(int maxFilesProcessedPerProcess)`
`void`	`setMaxForEmitBatchBytes(long maxForEmitBatchBytes)`
`void`	`setNumClients(int numClients)`
`void`	`setShutdownClientAfterMillis(long shutdownClientAfterMillis)` If the client has been inactive after this many milliseconds, shut it down.
`void`	`setSleepOnStartupTimeoutMillis(long sleepOnStartupTimeoutMillis)`
`void`	`setStartupTimeoutMillis(long startupTimeoutMillis)`
`void`	`setTikaConfig(Path tikaConfig)`
`void`	`setTikaConfig(String tikaConfig)`
`void`	`setTimeoutMillis(long timeoutMillis)` How long to wait in milliseconds before timing out the forked process.

Methods inherited from class org.apache.tika.config.ConfigBase
buildComposite, buildComposite, buildSingle, buildSingle, configure, handleSettings

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_MAX_FOR_EMIT_BATCH
```
public 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_MILLIS
```
public static final long DEFAULT_TIMEOUT_MILLIS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STARTUP_TIMEOUT_MILLIS
```
public static final long DEFAULT_STARTUP_TIMEOUT_MILLIS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SHUTDOWN_CLIENT_AFTER_MILLS
```
public static final long DEFAULT_SHUTDOWN_CLIENT_AFTER_MILLS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_NUM_CLIENTS
```
public static final int DEFAULT_NUM_CLIENTS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_FILES_PROCESSED_PER_PROCESS
```
public static final int DEFAULT_MAX_FILES_PROCESSED_PER_PROCESS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PipesConfigBase
```
public PipesConfigBase()
```
- Method Detail
  - getTimeoutMillis
```
public long getTimeoutMillis()
```
  - setTimeoutMillis
```
public void setTimeoutMillis(long timeoutMillis)
```
    How long to wait in milliseconds before timing out the forked process.
    
    Parameters:
    
    timeoutMillis -
  - getShutdownClientAfterMillis
```
public long getShutdownClientAfterMillis()
```
  - setShutdownClientAfterMillis
```
public void setShutdownClientAfterMillis(long shutdownClientAfterMillis)
```
    If the client has been inactive after this many milliseconds, shut it down.
    
    Parameters:
    
    shutdownClientAfterMillis -
  - getNumClients
```
public int getNumClients()
```
  - setNumClients
```
public void setNumClients(int numClients)
```
  - getForkedJvmArgs
```
public List<String> getForkedJvmArgs()
```
  - setStartupTimeoutMillis
```
public void setStartupTimeoutMillis(long startupTimeoutMillis)
```
  - setForkedJvmArgs
```
public void setForkedJvmArgs(List<String> jvmArgs)
```
  - getMaxFilesProcessedPerProcess
```
public int getMaxFilesProcessedPerProcess()
```
    Restart the forked PipesServer after it has processed this many files to avoid slow-building memory leaks.
    
    Returns:
  - setMaxFilesProcessedPerProcess
```
public void setMaxFilesProcessedPerProcess(int maxFilesProcessedPerProcess)
```
  - getTikaConfig
```
public Path getTikaConfig()
```
  - setTikaConfig
```
public void setTikaConfig(Path tikaConfig)
```
  - setTikaConfig
```
public void setTikaConfig(String tikaConfig)
```
  - getJavaPath
```
public String getJavaPath()
```
  - setJavaPath
```
public void setJavaPath(String javaPath)
```
  - getStartupTimeoutMillis
```
public long getStartupTimeoutMillis()
```
  - getMaxForEmitBatchBytes
```
public 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 to 0, 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
  - setMaxForEmitBatchBytes
```
public void setMaxForEmitBatchBytes(long maxForEmitBatchBytes)
```
  - getSleepOnStartupTimeoutMillis
```
public long getSleepOnStartupTimeoutMillis()
```
  - setSleepOnStartupTimeoutMillis
```
public void setSleepOnStartupTimeoutMillis(long sleepOnStartupTimeoutMillis)
```

Class PipesConfigBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.tika.config.ConfigBase

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_FOR_EMIT_BATCH

DEFAULT_TIMEOUT_MILLIS

DEFAULT_STARTUP_TIMEOUT_MILLIS

DEFAULT_SHUTDOWN_CLIENT_AFTER_MILLS

DEFAULT_NUM_CLIENTS

DEFAULT_MAX_FILES_PROCESSED_PER_PROCESS

Constructor Detail

PipesConfigBase

Method Detail

getTimeoutMillis

setTimeoutMillis

getShutdownClientAfterMillis

setShutdownClientAfterMillis

getNumClients

setNumClients

getForkedJvmArgs

setStartupTimeoutMillis

setForkedJvmArgs

getMaxFilesProcessedPerProcess

setMaxFilesProcessedPerProcess

getTikaConfig

setTikaConfig

setTikaConfig

getJavaPath

setJavaPath

getStartupTimeoutMillis

getMaxForEmitBatchBytes

setMaxForEmitBatchBytes

getSleepOnStartupTimeoutMillis

setSleepOnStartupTimeoutMillis