Package org.apache.tika.parser.strings

Class StringsConfig

java.lang.Object

org.apache.tika.parser.strings.StringsConfig

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

StringsConfig.RuntimeConfig

public class StringsConfig
extends Object
implements Serializable

Configuration for the "strings" (or strings-alternative) command.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringsConfig.RuntimeConfig	RuntimeConfig blocks modification of security-sensitive path fields at runtime.

Constructor Summary

Constructors

Constructor	Description
StringsConfig()

Method Summary

Modifier and Type	Method	Description
StringsEncoding	getEncoding()	Returns the character encoding of the strings that are to be found.
String	getFilePath()	Returns the path to the "file" command.
int	getMinLength()	Returns the minimum sequence length (characters) to print.
String	getStringsPath()	Returns the "strings" installation folder.
int	getTimeoutSeconds()	Returns the maximum time (in seconds) to wait for the "strings" command to terminate.
void	setEncoding(StringsEncoding encoding)	Sets the character encoding of the strings that are to be found.
void	setFilePath(String filePath)	Sets the path to the "file" command.
void	setMinLength(int minLength)	Sets the minimum sequence length (characters) to print.
void	setStringsPath(String stringsPath)	Sets the "strings" installation folder.
void	setTimeoutSeconds(int timeoutSeconds)	Sets the maximum time (in seconds) to wait for the "strings" command to terminate.

Methods inherited from class java.lang.Object

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

Constructor Details

StringsConfig

public StringsConfig()

Method Details

getStringsPath

public String getStringsPath()

Returns the "strings" installation folder.

Returns:

the "strings" installation folder.

setStringsPath

public void setStringsPath(String stringsPath)
                    throws TikaConfigException

Sets the "strings" installation folder.

Parameters:

stringsPath - the "strings" installation folder.

Throws:

TikaConfigException

getFilePath

public String getFilePath()

Returns the path to the "file" command.

Returns:

the path to the "file" command.

setFilePath

public void setFilePath(String filePath)
                 throws TikaConfigException

Sets the path to the "file" command.

Parameters:

filePath - the path to the "file" command.

Throws:

TikaConfigException

getMinLength

public int getMinLength()

Returns the minimum sequence length (characters) to print.

Returns:

the minimum sequence length (characters) to print.

setMinLength

public void setMinLength(int minLength)

Sets the minimum sequence length (characters) to print.

Parameters:

minLength - the minimum sequence length (characters) to print.

getEncoding

public StringsEncoding getEncoding()

Returns the character encoding of the strings that are to be found.

Returns:

StringsEncoding enum that represents the character encoding of the strings that are to be found.

setEncoding

public void setEncoding(StringsEncoding encoding)

Sets the character encoding of the strings that are to be found.

Parameters:

encoding - StringsEncoding enum that represents the character encoding of the strings that are to be found.

getTimeoutSeconds

public int getTimeoutSeconds()

Returns the maximum time (in seconds) to wait for the "strings" command to terminate.

Returns:

the maximum time (in seconds) to wait for the "strings" command to terminate.

setTimeoutSeconds

public void setTimeoutSeconds(int timeoutSeconds)

Sets the maximum time (in seconds) to wait for the "strings" command to terminate.

Parameters:

timeoutSeconds - the maximum time (in seconds) to wait for the "strings" command to terminate.