com.exalead.papi.framework.connectors

Class GenericContainerMultiThreadedConnectorConfig

java.lang.Object

com.exalead.config.bean.BeanConfig

com.exalead.config.bean.DynamicBeanConfig

com.exalead.papi.framework.connectors.v10.ConnectorConfig

com.exalead.papi.framework.connectors.ConnectorConfig

com.exalead.papi.framework.connectors.GenericMultiThreadedConnectorConfig

com.exalead.papi.framework.connectors.GenericContainerMultiThreadedConnectorConfig

All Implemented Interfaces:

com.exalead.config.bean.BeanSample, com.exalead.config.bean.CallAfterFill, com.exalead.mercury.component.config.CVComponentConfig, com.exalead.mercury.component.config.CVComponentConfigSamplify, ConnectorConfigCheckInterface

Direct Known Subclasses:

ContainerMultiThreadedConnectorConfig

public class GenericContainerMultiThreadedConnectorConfig
extends GenericMultiThreadedConnectorConfig
implements com.exalead.mercury.component.config.CVComponentConfigSamplify

Configuration of GenericContainerMultiThreadedConnector<>.

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.papi.framework.connectors.GenericMultiThreadedConnectorConfig

GenericMultiThreadedConnectorConfig.DocumentErrorBehavior

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	containerMimeFilter
protected com.exalead.config.bean.MillisecondsValue	containerTimeoutFetchMs
protected com.exalead.config.bean.MillisecondsValue	containerTimeoutMs
protected java.lang.String	convertAddress
protected java.lang.String	cPathStopFilter
java.lang.String	DEFAULT_CONTAINER_ITEM_MIME_FILTER
java.lang.String	DEFAULT_CONTAINER_MIME_FILTER
static com.exalead.config.bean.MillisecondsValue	DEFAULT_CONTAINER_TIMEOUT_FETCH_MS
static com.exalead.config.bean.MillisecondsValue	DEFAULT_CONTAINER_TIMEOUT_MS
java.lang.String	DEFAULT_CPATH_STOP_MIME_FILTER
boolean	DEFAULT_HANDLE_CONTAINERS
boolean	DEFAULT_INDEX_NAMES
java.lang.String	DEFAULT_ITEM_EXTENSIONS
boolean	DEFAULT_MAIN_PART_ADD_LINKS
java.lang.String	DEFAULT_MAIN_PART_ITEM_IDENTIFIER_FILTER
java.lang.String	DEFAULT_MAIN_PART_MIME_DEDUP_FILTER
int	DEFAULT_MAIN_PART_MIME_DEDUP_MAX
java.lang.String	DEFAULT_MAIN_PART_MIME_FILTER
java.lang.String	DEFAULT_MAIN_PART_PARENT_MIME_FILTER
int	DEFAULT_MAX_CONTAINER_DEPTH
int	DEFAULT_MAX_CONTAINER_DOCUMENTS_PER_LEVEL
int	DEFAULT_MAX_CONTAINER_DOCUMENTS_TOTAL
com.exalead.config.bean.BytesValue	DEFAULT_MAX_CONTAINER_FETCH_SIZE
com.exalead.config.bean.BytesValue	DEFAULT_MAX_INPUT_SIZE
protected boolean	enableContainers
protected boolean	indexNames
protected java.lang.String	itemExtensions
protected java.lang.String	itemMimeFilter
protected ContainerMainPartConfig[]	mainPart
protected int	maxContainerDepth
protected int	maxContainerDocumentsPerLevel
protected int	maxContainerDocumentsTotal
protected com.exalead.config.bean.BytesValue	maxContainerFetchSize
protected com.exalead.config.bean.BytesValue	maxInputSize

Fields inherited from class com.exalead.papi.framework.connectors.GenericMultiThreadedConnectorConfig

DEFAULT_MAX_DOC_QUEUED, DEFAULT_MAX_FOLDER_QUEUED, DEFAULT_MAX_PIPELINE_DOCUMENT_THREAD, DEFAULT_MAX_PIPELINE_FOLDER_THREAD, deleteDocumentOnError, maxDocQueued, maxFolderQueued, maxProcessingSize, nbPipelineDocumentThread, nbPipelineFolderThread, neverSendDelete, pushFolder, rootPaths

Fields inherited from class com.exalead.papi.framework.connectors.ConnectorConfig

customPushAPIFilters, thresholds

Constructor Summary

Constructors

Constructor and Description
GenericContainerMultiThreadedConnectorConfig()

Method Summary

Modifier and Type	Method and Description
void	checkConfig(boolean useNow) Check the current configuration.
java.lang.String	getContainerConvertAddress()
java.lang.String	getContainerMimeFilter()
com.exalead.config.bean.MillisecondsValue	getContainerTimeoutFetchMs()
long	getContainerTimeoutFetchMsLong()
com.exalead.config.bean.MillisecondsValue	getContainerTimeoutMs()
long	getContainerTimeoutMsLong()
java.lang.String	getCPathStopFilter()
boolean	getEnableContainers()
boolean	getIndexNames()
java.lang.String	getItemExtensions()
java.lang.String	getItemMimeFilter()
ContainerMainPartConfig[]	getMainPartParentMimeFilter()
int	getMaxContainerDepth()
int	getMaxContainerDocumentsPerLevel()
int	getMaxContainerDocumentsTotal()
com.exalead.config.bean.BytesValue	getMaxContainerFetchSize()
long	getMaxContainerFetchSizeLong()
com.exalead.config.bean.BytesValue	getMaxInputSize()
long	getMaxInputSizeLong()
static java.lang.String[]	getMethods() Optional method listing all methods, ordered (GUI)
void	samplify()
void	setContainerConvertAddress(java.lang.String convertAddress)
void	setContainerMimeFilter(java.lang.String containerMimeFilter)
void	setContainerTimeoutFetchMs(com.exalead.config.bean.MillisecondsValue containerTimeoutFetchMs)
void	setContainerTimeoutMs(com.exalead.config.bean.MillisecondsValue containerTimeoutMs)
void	setCPathStopFilter(java.lang.String cPathStopFilter)
void	setEnableContainers(com.exalead.config.bean.BooleanChecked enableContainers) If containers support is enabled with the following feature, files recognized as containers and allowed (see other filtering options) will have their content indexed as separate files.
void	setIndexNames(com.exalead.config.bean.BooleanChecked indexNames)
void	setIndexNames(java.lang.String indexNames)
void	setItemExtensions(java.lang.String itemExtensions)
void	setItemMimeFilter(java.lang.String itemMimeFilter)
void	setMainPartParentMimeFilter(ContainerMainPartConfig[] mainPart)
void	setMaxContainerDepth(int maxContainerDepth)
void	setMaxContainerDocumentsPerLevel(int maxContainerDocumentsPerLevel)
void	setMaxContainerDocumentsTotal(int maxContainerDocumentsTotal)
void	setMaxContainerFetchSize(com.exalead.config.bean.BytesValue maxContainerFetchSize)
void	setMaxInputSize(com.exalead.config.bean.BytesValue maxInputSize)
void	setMaxInputSize(java.lang.String maxInputSize)

Methods inherited from class com.exalead.papi.framework.connectors.GenericMultiThreadedConnectorConfig

getDeleteDocumentOnError, getMaxDocQueued, getMaxFolderQueued, getMaxProcessingSize, getNbPipelineDocumentThread, getNbPipelineFolderThread, getNeverSendDelete, getPushFolder, getRootPaths, setDeleteDocumentOnError, setMaxDocQueued, setMaxDocQueued, setMaxFolderQueued, setMaxFolderQueued, setMaxProcessingSize, setMaxProcessingSize, setNbPipelineDocumentThread, setNbPipelineDocumentThread, setNbPipelineFolderThread, setNbPipelineFolderThread, setNeverSendDelete, setPushFolder, setPushFolder, setRootPaths

Methods inherited from class com.exalead.papi.framework.connectors.ConnectorConfig

getPushAPIFilters, setPushAPIFilters

Methods inherited from class com.exalead.papi.framework.connectors.v10.ConnectorConfig

getPropertiesDefinition, setProperty

Methods inherited from class com.exalead.config.bean.BeanConfig

callAfterFill

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_CONTAINER_DEPTH

public final int DEFAULT_MAX_CONTAINER_DEPTH

See Also:

Constant Field Values

DEFAULT_MAX_CONTAINER_DOCUMENTS_PER_LEVEL

public final int DEFAULT_MAX_CONTAINER_DOCUMENTS_PER_LEVEL

See Also:

Constant Field Values

DEFAULT_MAX_CONTAINER_DOCUMENTS_TOTAL

public final int DEFAULT_MAX_CONTAINER_DOCUMENTS_TOTAL

See Also:

Constant Field Values

DEFAULT_CONTAINER_MIME_FILTER

public final java.lang.String DEFAULT_CONTAINER_MIME_FILTER

See Also:

Constant Field Values

DEFAULT_CONTAINER_ITEM_MIME_FILTER

public final java.lang.String DEFAULT_CONTAINER_ITEM_MIME_FILTER

See Also:

Constant Field Values

DEFAULT_ITEM_EXTENSIONS

public final java.lang.String DEFAULT_ITEM_EXTENSIONS

See Also:

Constant Field Values

DEFAULT_HANDLE_CONTAINERS

public final boolean DEFAULT_HANDLE_CONTAINERS

DEFAULT_INDEX_NAMES

public final boolean DEFAULT_INDEX_NAMES

See Also:

Constant Field Values

DEFAULT_MAX_INPUT_SIZE

public final com.exalead.config.bean.BytesValue DEFAULT_MAX_INPUT_SIZE

DEFAULT_MAX_CONTAINER_FETCH_SIZE

public final com.exalead.config.bean.BytesValue DEFAULT_MAX_CONTAINER_FETCH_SIZE

DEFAULT_CPATH_STOP_MIME_FILTER

public final java.lang.String DEFAULT_CPATH_STOP_MIME_FILTER

See Also:

Constant Field Values

DEFAULT_MAIN_PART_PARENT_MIME_FILTER

public final java.lang.String DEFAULT_MAIN_PART_PARENT_MIME_FILTER

See Also:

Constant Field Values

DEFAULT_MAIN_PART_MIME_FILTER

public final java.lang.String DEFAULT_MAIN_PART_MIME_FILTER

See Also:

Constant Field Values

DEFAULT_MAIN_PART_MIME_DEDUP_FILTER

public final java.lang.String DEFAULT_MAIN_PART_MIME_DEDUP_FILTER

See Also:

Constant Field Values

DEFAULT_MAIN_PART_ITEM_IDENTIFIER_FILTER

public final java.lang.String DEFAULT_MAIN_PART_ITEM_IDENTIFIER_FILTER

See Also:

Constant Field Values

DEFAULT_MAIN_PART_MIME_DEDUP_MAX

public final int DEFAULT_MAIN_PART_MIME_DEDUP_MAX

See Also:

Constant Field Values

DEFAULT_MAIN_PART_ADD_LINKS

public final boolean DEFAULT_MAIN_PART_ADD_LINKS

See Also:

Constant Field Values

DEFAULT_CONTAINER_TIMEOUT_MS

public static final com.exalead.config.bean.MillisecondsValue DEFAULT_CONTAINER_TIMEOUT_MS

DEFAULT_CONTAINER_TIMEOUT_FETCH_MS

public static final com.exalead.config.bean.MillisecondsValue DEFAULT_CONTAINER_TIMEOUT_FETCH_MS

enableContainers

protected boolean enableContainers

maxContainerDepth

protected int maxContainerDepth

maxContainerDocumentsPerLevel

protected int maxContainerDocumentsPerLevel

maxContainerDocumentsTotal

protected int maxContainerDocumentsTotal

containerMimeFilter

protected java.lang.String containerMimeFilter

itemMimeFilter

protected java.lang.String itemMimeFilter

itemExtensions

protected java.lang.String itemExtensions

indexNames

protected boolean indexNames

maxInputSize

protected com.exalead.config.bean.BytesValue maxInputSize

maxContainerFetchSize

protected com.exalead.config.bean.BytesValue maxContainerFetchSize

cPathStopFilter

protected java.lang.String cPathStopFilter

convertAddress

protected java.lang.String convertAddress

containerTimeoutMs

protected com.exalead.config.bean.MillisecondsValue containerTimeoutMs

containerTimeoutFetchMs

protected com.exalead.config.bean.MillisecondsValue containerTimeoutFetchMs

mainPart

protected ContainerMainPartConfig[] mainPart

Constructor Detail

GenericContainerMultiThreadedConnectorConfig

public GenericContainerMultiThreadedConnectorConfig()

Method Detail

samplify

public void samplify()

Specified by:

samplify in interface com.exalead.config.bean.BeanSample

Overrides:

samplify in class GenericMultiThreadedConnectorConfig

getEnableContainers

public boolean getEnableContainers()

setEnableContainers

public void setEnableContainers(com.exalead.config.bean.BooleanChecked enableContainers)

If containers support is enabled with the following feature, files recognized as containers and allowed (see other filtering options) will have their content indexed as separate files. Currently supporter container types includes ZIP files, TAR files (including gzip and bz2 compressed ones), PST and MBOX files (mail directories), MSG and EML files (mails with optional attachments)

getMaxContainerDepth

public int getMaxContainerDepth()

setMaxContainerDepth

public void setMaxContainerDepth(int maxContainerDepth)

getMaxContainerDocumentsPerLevel

public int getMaxContainerDocumentsPerLevel()

setMaxContainerDocumentsPerLevel

public void setMaxContainerDocumentsPerLevel(int maxContainerDocumentsPerLevel)

getMaxContainerDocumentsTotal

public int getMaxContainerDocumentsTotal()

setMaxContainerDocumentsTotal

public void setMaxContainerDocumentsTotal(int maxContainerDocumentsTotal)

getCPathStopFilter

public java.lang.String getCPathStopFilter()

setCPathStopFilter

public void setCPathStopFilter(java.lang.String cPathStopFilter)

getContainerMimeFilter

public java.lang.String getContainerMimeFilter()

setContainerMimeFilter

public void setContainerMimeFilter(java.lang.String containerMimeFilter)

getItemMimeFilter

public java.lang.String getItemMimeFilter()

setItemMimeFilter

public void setItemMimeFilter(java.lang.String itemMimeFilter)

getItemExtensions

public java.lang.String getItemExtensions()

setItemExtensions

public void setItemExtensions(java.lang.String itemExtensions)

getIndexNames

public boolean getIndexNames()

setIndexNames

public void setIndexNames(com.exalead.config.bean.BooleanChecked indexNames)

setIndexNames

public void setIndexNames(java.lang.String indexNames)

getMaxInputSize

public com.exalead.config.bean.BytesValue getMaxInputSize()

getMaxInputSizeLong

public long getMaxInputSizeLong()

setMaxInputSize

public void setMaxInputSize(com.exalead.config.bean.BytesValue maxInputSize)

getMaxContainerFetchSize

public com.exalead.config.bean.BytesValue getMaxContainerFetchSize()

getMaxContainerFetchSizeLong

public long getMaxContainerFetchSizeLong()

setMaxContainerFetchSize

public void setMaxContainerFetchSize(com.exalead.config.bean.BytesValue maxContainerFetchSize)

setMaxInputSize

public void setMaxInputSize(java.lang.String maxInputSize)

getContainerConvertAddress

public java.lang.String getContainerConvertAddress()

setContainerConvertAddress

public void setContainerConvertAddress(java.lang.String convertAddress)

getContainerTimeoutMs

public com.exalead.config.bean.MillisecondsValue getContainerTimeoutMs()

getContainerTimeoutMsLong

public long getContainerTimeoutMsLong()

setContainerTimeoutMs

public void setContainerTimeoutMs(com.exalead.config.bean.MillisecondsValue containerTimeoutMs)

getContainerTimeoutFetchMs

public com.exalead.config.bean.MillisecondsValue getContainerTimeoutFetchMs()

getContainerTimeoutFetchMsLong

public long getContainerTimeoutFetchMsLong()

setContainerTimeoutFetchMs

public void setContainerTimeoutFetchMs(com.exalead.config.bean.MillisecondsValue containerTimeoutFetchMs)

setMainPartParentMimeFilter

public void setMainPartParentMimeFilter(ContainerMainPartConfig[] mainPart)

getMainPartParentMimeFilter

public ContainerMainPartConfig[] getMainPartParentMimeFilter()

checkConfig

public void checkConfig(boolean useNow)
                 throws com.exalead.config.bean.ConfigurationException,
                        java.lang.Exception

Description copied from interface: ConnectorConfigCheckInterface

Check the current configuration.

Specified by:

checkConfig in interface ConnectorConfigCheckInterface

Overrides:

checkConfig in class ConnectorConfig

Parameters:

useNow - if true, the configuration check should also include checks related to the current state of the connector peers or environment ; that is, typically checking that a remote server is available, file path filled exist, etc. If useNow is false, the check should not assume that potentially configured resources are available now (remote servers(s) might be down, third-party configuration elements might be missing etc.)

Throws:

com.exalead.config.bean.ConfigurationException - (or derived exception) upon configuration error

java.lang.Exception

getMethods

public static java.lang.String[] getMethods()

Optional method listing all methods, ordered (GUI)