com.exalead.mercury.mami.convert.v10

Class ConvertInternalSettings

java.lang.Object

com.exalead.mercury.mami.convert.v10.ConvertInternalSettings

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class ConvertInternalSettings
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Configuration of convert system settings.
The StringValue list can be used to add new supported options, in raw format (i.e., the leading -- must be present).
The legacy KeyValue list can be used to add new supported options, using short format for the key (without the leading -- ; such as "enable-foo").
The value should be set to "true" if no value is to be set on the commandline side.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
ConvertInternalCacheSettings	convertInternalCacheSettings
ConvertInternalChildrenSettings	convertInternalChildrenSettings
ConvertInternalPOSIXSettings	convertInternalPOSIXSettings
static boolean	DEFAULT_DISABLE_SHARED_MEMORY
static boolean	DEFAULT_RESTRICT_USER_ID
static boolean	DEFAULT_RETRY_ON_M_M_A_P_FAILED
static boolean	DEFAULT_SELFTEST_ON_STARTUP
boolean	disableSharedMemory
java.util.List<KeyValue>	keyValue
java.lang.String	loggingLevel
boolean	restrictUserId
boolean	retryOnMMAPFailed
boolean	selftestOnStartup
java.util.List<StringValue>	stringValue
java.lang.String	tmpDir

Constructor Summary

Constructors

Constructor and Description
ConvertInternalSettings()
ConvertInternalSettings(ConvertInternalSettings o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ConvertInternalSettings.
static ConvertInternalSettings	fromString(java.lang.String s) String representation of this ConvertInternalSettings.
ConvertInternalCacheSettings	getConvertInternalCacheSettings()
ConvertInternalChildrenSettings	getConvertInternalChildrenSettings()
ConvertInternalPOSIXSettings	getConvertInternalPOSIXSettings()
java.util.List<KeyValue>	getKeyValue()
java.lang.String	getLoggingLevel() Sets logging verbosity of the convert. verbose: Logs converted urls quiet: Logs errors only. enum ("verbose", "quiet")
java.util.List<StringValue>	getStringValue()
java.lang.String	getTmpDir() The temporary path to override the system temporary path.
boolean	isDisableSharedMemory() Disables shared memory support.
boolean	isRestrictUserId() Restricts connections to the user running the server. Supported only on Windows and Linux platforms.
boolean	isRetryOnMMAPFailed() Default convert retry with regular I/O if mmap fails when the convert is responsible for fetching the bytes of a document. This is useful for FileSystem mounted in direct I/O. Note: This setting defines the process default value, which can be overridden for each conversion command.
boolean	isSelftestOnStartup() The converter tests itself on startup.
ConvertInternalSettings	makeCopy() Creates and returns a deep copy of this ConvertInternalSettings.
static ConvertInternalSettings	readFrom(java.io.InputStream is) Read this ConvertInternalSettings from an XML fragment.
void	setConvertInternalCacheSettings(ConvertInternalCacheSettings convertInternalCacheSettings)
void	setConvertInternalChildrenSettings(ConvertInternalChildrenSettings convertInternalChildrenSettings)
void	setConvertInternalPOSIXSettings(ConvertInternalPOSIXSettings convertInternalPOSIXSettings)
void	setDisableSharedMemory(boolean disableSharedMemory) Disables shared memory support.
void	setLoggingLevel(java.lang.String loggingLevel) Sets logging verbosity of the convert. verbose: Logs converted urls quiet: Logs errors only. enum ("verbose", "quiet")
void	setRestrictUserId(boolean restrictUserId) Restricts connections to the user running the server. Supported only on Windows and Linux platforms.
void	setRetryOnMMAPFailed(boolean retryOnMMAPFailed) Default convert retry with regular I/O if mmap fails when the convert is responsible for fetching the bytes of a document. This is useful for FileSystem mounted in direct I/O. Note: This setting defines the process default value, which can be overridden for each conversion command.
void	setSelftestOnStartup(boolean selftestOnStartup) The converter tests itself on startup.
void	setTmpDir(java.lang.String tmpDir) The temporary path to override the system temporary path.
java.lang.String	toString() String representation of this ConvertInternalSettings.
ConvertInternalSettings	withConvertInternalCacheSettings(ConvertInternalCacheSettings convertInternalCacheSettings)
ConvertInternalSettings	withConvertInternalChildrenSettings(ConvertInternalChildrenSettings convertInternalChildrenSettings)
ConvertInternalSettings	withConvertInternalPOSIXSettings(ConvertInternalPOSIXSettings convertInternalPOSIXSettings)
ConvertInternalSettings	withDisableSharedMemory(boolean disableSharedMemory)
ConvertInternalSettings	withDisableSharedMemory(java.lang.Boolean disableSharedMemory)
ConvertInternalSettings	withKeyValue(java.util.Collection<KeyValue> __values)
ConvertInternalSettings	withKeyValue(KeyValue... __values)
ConvertInternalSettings	withLoggingLevel(java.lang.String loggingLevel)
ConvertInternalSettings	withRestrictUserId(boolean restrictUserId)
ConvertInternalSettings	withRestrictUserId(java.lang.Boolean restrictUserId)
ConvertInternalSettings	withRetryOnMMAPFailed(boolean retryOnMMAPFailed)
ConvertInternalSettings	withRetryOnMMAPFailed(java.lang.Boolean retryOnMMAPFailed)
ConvertInternalSettings	withSelftestOnStartup(boolean selftestOnStartup)
ConvertInternalSettings	withSelftestOnStartup(java.lang.Boolean selftestOnStartup)
ConvertInternalSettings	withStringValue(java.util.Collection<StringValue> __values)
ConvertInternalSettings	withStringValue(StringValue... __values)
ConvertInternalSettings	withTmpDir(java.lang.String tmpDir)
void	writeTo(java.io.OutputStream os) Write this ConvertInternalSettings as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

convertInternalCacheSettings

public ConvertInternalCacheSettings convertInternalCacheSettings

convertInternalChildrenSettings

public ConvertInternalChildrenSettings convertInternalChildrenSettings

convertInternalPOSIXSettings

public ConvertInternalPOSIXSettings convertInternalPOSIXSettings

keyValue

public java.util.List<KeyValue> keyValue

stringValue

public java.util.List<StringValue> stringValue

retryOnMMAPFailed

public boolean retryOnMMAPFailed

DEFAULT_RETRY_ON_M_M_A_P_FAILED

public static final boolean DEFAULT_RETRY_ON_M_M_A_P_FAILED

See Also:

Constant Field Values

disableSharedMemory

public boolean disableSharedMemory

DEFAULT_DISABLE_SHARED_MEMORY

public static final boolean DEFAULT_DISABLE_SHARED_MEMORY

See Also:

Constant Field Values

loggingLevel

public java.lang.String loggingLevel

tmpDir

public java.lang.String tmpDir

selftestOnStartup

public boolean selftestOnStartup

DEFAULT_SELFTEST_ON_STARTUP

public static final boolean DEFAULT_SELFTEST_ON_STARTUP

See Also:

Constant Field Values

restrictUserId

public boolean restrictUserId

DEFAULT_RESTRICT_USER_ID

public static final boolean DEFAULT_RESTRICT_USER_ID

See Also:

Constant Field Values

Constructor Detail

ConvertInternalSettings

public ConvertInternalSettings()

ConvertInternalSettings

public ConvertInternalSettings(ConvertInternalSettings o)

Copy constructor

Method Detail

setConvertInternalCacheSettings

public void setConvertInternalCacheSettings(ConvertInternalCacheSettings convertInternalCacheSettings)

getConvertInternalCacheSettings

public ConvertInternalCacheSettings getConvertInternalCacheSettings()

withConvertInternalCacheSettings

public ConvertInternalSettings withConvertInternalCacheSettings(ConvertInternalCacheSettings convertInternalCacheSettings)

setConvertInternalChildrenSettings

public void setConvertInternalChildrenSettings(ConvertInternalChildrenSettings convertInternalChildrenSettings)

getConvertInternalChildrenSettings

public ConvertInternalChildrenSettings getConvertInternalChildrenSettings()

withConvertInternalChildrenSettings

public ConvertInternalSettings withConvertInternalChildrenSettings(ConvertInternalChildrenSettings convertInternalChildrenSettings)

setConvertInternalPOSIXSettings

public void setConvertInternalPOSIXSettings(ConvertInternalPOSIXSettings convertInternalPOSIXSettings)

getConvertInternalPOSIXSettings

public ConvertInternalPOSIXSettings getConvertInternalPOSIXSettings()

withConvertInternalPOSIXSettings

public ConvertInternalSettings withConvertInternalPOSIXSettings(ConvertInternalPOSIXSettings convertInternalPOSIXSettings)

getKeyValue

public java.util.List<KeyValue> getKeyValue()

withKeyValue

public ConvertInternalSettings withKeyValue(KeyValue... __values)

withKeyValue

public ConvertInternalSettings withKeyValue(java.util.Collection<KeyValue> __values)

getStringValue

public java.util.List<StringValue> getStringValue()

withStringValue

public ConvertInternalSettings withStringValue(StringValue... __values)

withStringValue

public ConvertInternalSettings withStringValue(java.util.Collection<StringValue> __values)

setRetryOnMMAPFailed

public void setRetryOnMMAPFailed(boolean retryOnMMAPFailed)

Default convert retry with regular I/O if mmap fails when the convert is responsible for fetching the bytes of a document.
This is useful for FileSystem mounted in direct I/O.
Note: This setting defines the process default value, which can be overridden for each conversion command.

isRetryOnMMAPFailed

public boolean isRetryOnMMAPFailed()

Default convert retry with regular I/O if mmap fails when the convert is responsible for fetching the bytes of a document.
This is useful for FileSystem mounted in direct I/O.
Note: This setting defines the process default value, which can be overridden for each conversion command.

withRetryOnMMAPFailed

public ConvertInternalSettings withRetryOnMMAPFailed(boolean retryOnMMAPFailed)

withRetryOnMMAPFailed

public ConvertInternalSettings withRetryOnMMAPFailed(java.lang.Boolean retryOnMMAPFailed)

setDisableSharedMemory

public void setDisableSharedMemory(boolean disableSharedMemory)

Disables shared memory support.

isDisableSharedMemory

public boolean isDisableSharedMemory()

Disables shared memory support.

withDisableSharedMemory

public ConvertInternalSettings withDisableSharedMemory(boolean disableSharedMemory)

withDisableSharedMemory

public ConvertInternalSettings withDisableSharedMemory(java.lang.Boolean disableSharedMemory)

setLoggingLevel

public void setLoggingLevel(java.lang.String loggingLevel)

Sets logging verbosity of the convert.
verbose: Logs converted urls
quiet: Logs errors only.
enum ("verbose", "quiet")

getLoggingLevel

public java.lang.String getLoggingLevel()

Sets logging verbosity of the convert.
verbose: Logs converted urls
quiet: Logs errors only.
enum ("verbose", "quiet")

withLoggingLevel

public ConvertInternalSettings withLoggingLevel(java.lang.String loggingLevel)

setTmpDir

public void setTmpDir(java.lang.String tmpDir)

The temporary path to override the system temporary path.

getTmpDir

public java.lang.String getTmpDir()

The temporary path to override the system temporary path.

withTmpDir

public ConvertInternalSettings withTmpDir(java.lang.String tmpDir)

setSelftestOnStartup

public void setSelftestOnStartup(boolean selftestOnStartup)

The converter tests itself on startup.

isSelftestOnStartup

public boolean isSelftestOnStartup()

The converter tests itself on startup.

withSelftestOnStartup

public ConvertInternalSettings withSelftestOnStartup(boolean selftestOnStartup)

withSelftestOnStartup

public ConvertInternalSettings withSelftestOnStartup(java.lang.Boolean selftestOnStartup)

setRestrictUserId

public void setRestrictUserId(boolean restrictUserId)

Restricts connections to the user running the server.
Supported only on Windows and Linux platforms.

isRestrictUserId

public boolean isRestrictUserId()

Restricts connections to the user running the server.
Supported only on Windows and Linux platforms.

withRestrictUserId

public ConvertInternalSettings withRestrictUserId(boolean restrictUserId)

withRestrictUserId

public ConvertInternalSettings withRestrictUserId(java.lang.Boolean restrictUserId)

makeCopy

public ConvertInternalSettings makeCopy()

Creates and returns a deep copy of this ConvertInternalSettings.

readFrom

public static ConvertInternalSettings readFrom(java.io.InputStream is)
                                        throws javax.xml.bind.JAXBException

Read this ConvertInternalSettings from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this ConvertInternalSettings as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static ConvertInternalSettings fromString(java.lang.String s)
                                          throws javax.xml.bind.JAXBException,
                                                 java.io.UnsupportedEncodingException

String representation of this ConvertInternalSettings.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ConvertInternalSettings.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this ConvertInternalSettings.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException