com.exalead.papi.framework.connectors

Class GenericMultiThreadedConnectorConfig

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

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:

GenericContainerMultiThreadedConnectorConfig, MultiThreadedConnectorConfig

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

Configuration of MultiThreadedConnector You have to create setters to manage connector configuration as described in ConnectorConfig.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenericMultiThreadedConnectorConfig.DocumentErrorBehavior

Field Summary

Fields

Modifier and Type	Field and Description
int	DEFAULT_MAX_DOC_QUEUED
int	DEFAULT_MAX_FOLDER_QUEUED
int	DEFAULT_MAX_PIPELINE_DOCUMENT_THREAD
int	DEFAULT_MAX_PIPELINE_FOLDER_THREAD
protected GenericMultiThreadedConnectorConfig.DocumentErrorBehavior.State	deleteDocumentOnError
protected int	maxDocQueued
protected int	maxFolderQueued
protected long	maxProcessingSize
protected int	nbPipelineDocumentThread
protected int	nbPipelineFolderThread
protected boolean	neverSendDelete
protected boolean	pushFolder
protected RootPathConfig[]	rootPaths

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

customPushAPIFilters, thresholds

Constructor Summary

Constructors

Constructor and Description
GenericMultiThreadedConnectorConfig() Constructor

Method Summary

Modifier and Type	Method and Description
GenericMultiThreadedConnectorConfig.DocumentErrorBehavior.State	getDeleteDocumentOnError() get documents must be deleted from the index when updating in case of error
int	getMaxDocQueued()
int	getMaxFolderQueued()
long	getMaxProcessingSize()
int	getNbPipelineDocumentThread()
int	getNbPipelineFolderThread()
boolean	getNeverSendDelete() never send any delete during an update (value : "true" or "false")
boolean	getPushFolder() get if folders must be indexed (value : "true" or "false")
RootPathConfig[]	getRootPaths() get the starting folders of indexation process
void	samplify()
void	setDeleteDocumentOnError(GenericMultiThreadedConnectorConfig.DocumentErrorBehavior value) set if documents must be deleted from the index when updating, in case of error (value : @see DocumentErrorBehavior)
void	setMaxDocQueued(int maxDocQueued)
void	setMaxDocQueued(java.lang.String value) Compatibility function.
void	setMaxFolderQueued(int maxFolderQueued)
void	setMaxFolderQueued(java.lang.String value) Compatibility function.
void	setMaxProcessingSize(long maxProcessingSize)
void	setMaxProcessingSize(java.lang.String value) Compatibility function.
void	setNbPipelineDocumentThread(int nbPipelineDocumentThread)
void	setNbPipelineDocumentThread(java.lang.String value) Compatibility function.
void	setNbPipelineFolderThread(int nbPipelineFolderThread)
void	setNbPipelineFolderThread(java.lang.String value) Compatibility function.
void	setNeverSendDelete(com.exalead.config.bean.BooleanChecked value) never send any delete during an update (value : "true" or "false")
void	setPushFolder(com.exalead.config.bean.BooleanChecked value) set if folders must be indexed (value : "true" or "false")
void	setPushFolder(java.lang.String value) Compatibility function.
void	setRootPaths(RootPathConfig[] rootPaths) set the starting folders of indexation process

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

getMethods, getPushAPIFilters, setPushAPIFilters

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

checkConfig, 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

Methods inherited from interface com.exalead.papi.framework.connectors.v10.ConnectorConfigCheckInterface

checkConfig

Field Detail

DEFAULT_MAX_DOC_QUEUED

public final int DEFAULT_MAX_DOC_QUEUED

See Also:

Constant Field Values

DEFAULT_MAX_FOLDER_QUEUED

public final int DEFAULT_MAX_FOLDER_QUEUED

See Also:

Constant Field Values

DEFAULT_MAX_PIPELINE_DOCUMENT_THREAD

public final int DEFAULT_MAX_PIPELINE_DOCUMENT_THREAD

See Also:

Constant Field Values

DEFAULT_MAX_PIPELINE_FOLDER_THREAD

public final int DEFAULT_MAX_PIPELINE_FOLDER_THREAD

See Also:

Constant Field Values

maxDocQueued

protected int maxDocQueued

maxFolderQueued

protected int maxFolderQueued

maxProcessingSize

protected long maxProcessingSize

nbPipelineDocumentThread

protected int nbPipelineDocumentThread

nbPipelineFolderThread

protected int nbPipelineFolderThread

rootPaths

protected RootPathConfig[] rootPaths

pushFolder

protected boolean pushFolder

neverSendDelete

protected boolean neverSendDelete

deleteDocumentOnError

protected GenericMultiThreadedConnectorConfig.DocumentErrorBehavior.State deleteDocumentOnError

Constructor Detail

GenericMultiThreadedConnectorConfig

public GenericMultiThreadedConnectorConfig()

Constructor

Method Detail

samplify

public void samplify()

Specified by:

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

Overrides:

samplify in class ConnectorConfig

getMaxDocQueued

public int getMaxDocQueued()

getRootPaths

public RootPathConfig[] getRootPaths()

get the starting folders of indexation process

Returns:

the starting folders

setRootPaths

public void setRootPaths(RootPathConfig[] rootPaths)

set the starting folders of indexation process

Parameters:

rootPaths - starting folders

setPushFolder

public void setPushFolder(com.exalead.config.bean.BooleanChecked value)

set if folders must be indexed (value : "true" or "false")

Parameters:

value -

setPushFolder

public void setPushFolder(java.lang.String value)
                   throws java.lang.IllegalArgumentException

Compatibility function.

Throws:

java.lang.IllegalArgumentException

getPushFolder

public boolean getPushFolder()

get if folders must be indexed (value : "true" or "false")

Returns:

setNeverSendDelete

public void setNeverSendDelete(com.exalead.config.bean.BooleanChecked value)

never send any delete during an update (value : "true" or "false")

Parameters:

value - the value

getNeverSendDelete

public boolean getNeverSendDelete()

never send any delete during an update (value : "true" or "false")

Returns:

the value

setDeleteDocumentOnError

public void setDeleteDocumentOnError(GenericMultiThreadedConnectorConfig.DocumentErrorBehavior value)

set if documents must be deleted from the index when updating, in case of error (value : @see DocumentErrorBehavior)

Parameters:

value - the value

getDeleteDocumentOnError

public GenericMultiThreadedConnectorConfig.DocumentErrorBehavior.State getDeleteDocumentOnError()

get documents must be deleted from the index when updating in case of error

Returns:

the value as a DocumentErrorBehavior.State

setMaxDocQueued

public void setMaxDocQueued(int maxDocQueued)

setMaxDocQueued

public void setMaxDocQueued(java.lang.String value)
                     throws java.lang.NumberFormatException

Compatibility function.

Throws:

java.lang.NumberFormatException

getMaxFolderQueued

public int getMaxFolderQueued()

setMaxFolderQueued

public void setMaxFolderQueued(int maxFolderQueued)

setMaxFolderQueued

public void setMaxFolderQueued(java.lang.String value)
                        throws java.lang.NumberFormatException

Compatibility function.

Throws:

java.lang.NumberFormatException

getNbPipelineDocumentThread

public int getNbPipelineDocumentThread()

setNbPipelineDocumentThread

public void setNbPipelineDocumentThread(int nbPipelineDocumentThread)

setNbPipelineDocumentThread

public void setNbPipelineDocumentThread(java.lang.String value)
                                 throws java.lang.NumberFormatException

Compatibility function.

Throws:

java.lang.NumberFormatException

getNbPipelineFolderThread

public int getNbPipelineFolderThread()

setNbPipelineFolderThread

public void setNbPipelineFolderThread(int nbPipelineFolderThread)

setNbPipelineFolderThread

public void setNbPipelineFolderThread(java.lang.String value)
                               throws java.lang.NumberFormatException

Compatibility function.

Throws:

java.lang.NumberFormatException

getMaxProcessingSize

public long getMaxProcessingSize()

setMaxProcessingSize

public void setMaxProcessingSize(long maxProcessingSize)

setMaxProcessingSize

public void setMaxProcessingSize(java.lang.String value)
                          throws java.lang.NumberFormatException

Compatibility function.

Throws:

java.lang.NumberFormatException