com.exalead.papi.framework.connectors

Class ContainerMultiThreadedConnector

java.lang.Object

com.exalead.papi.framework.connectors.Connector

com.exalead.papi.framework.connectors.GenericMultiThreadedConnector<SKey>

com.exalead.papi.framework.connectors.GenericContainerMultiThreadedConnector<com.exalead.papi.framework.source.adapter.Key>

com.exalead.papi.framework.connectors.ContainerMultiThreadedConnector

All Implemented Interfaces:

com.exalead.mercury.component.CVComponent, ConnectorStatusExceptionInterface, ConnectorInterface

public abstract class ContainerMultiThreadedConnector
extends GenericContainerMultiThreadedConnector<com.exalead.papi.framework.source.adapter.Key>

MultiThreadedConnector is an implementation of connector This class provides the following features : - Enumeration of Documents is multithreaded (the number of thread can be easily adjusted) - Pushing documents is multithreaded (the number of thread can be easily adjusted) - All the required methods of Connector class have been implemented. You don't need to manipulate the PushAPI (It is a full abstraction of the PushAPI). The constructor of your class must have 2 parameters, the first one must be of type PushAPI, the second is your implementation of MultiThreadedConnectorConfig Normally your inherited class should just define a new constructor (you needn't override methods).

Nested Class Summary

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

GenericMultiThreadedConnector.EnumeratesFolderDeletionHelperClient

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

Connector.ConnectorNameThreadFactory

Field Summary

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

m_HandleContainer

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

addDocumentOperationBuilderForFirstAdd, addDocumentOperationBuilderForNotModified, addDocumentOperationBuilderForUpdate, DEFAULT_LAST_UPDATE_CHECKPOINT_BEGIN, DEFAULT_LAST_UPDATE_CHECKPOINT_END, deletedDocumentOperationBuilder, doDelete, enumeratedPipelinesManager, isUpdate, last_update_checkpoint_begin, last_update_checkpoint_end, neverSendDeletes, processingQuota, pushFolder, sourceAdapterManager, sourceEnumerator, startKeys, syncEnumeratedError, synchronizerCallbackContainer, threadFactory

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

config, DEFAULT_SCAN_MODE, papi

Constructor Summary

Constructors

Constructor and Description
ContainerMultiThreadedConnector(ContainerMultiThreadedConnectorConfig config)

Method Summary

Modifier and Type	Method and Description
protected com.exalead.papi.framework.source.adapter.Key	buildStartKeyFromConf(java.lang.String configKey, boolean isFolder) Call to transform Folder Name (from RootFolders) to FolderKey Warning : can be called with null parameter when the RootFolders is empty (to manage default root path)
static java.util.Map<java.lang.String,java.lang.String>	getConnectorMetas(ConnectorInfoRequest infoRequest) Get connector-specific metadata
com.exalead.papi.framework.source.adapter.Key	getKeyFromUri(java.lang.String uri) Get AddDocumentOperationBuilder

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

addRootKeyInPipelineManager, buildAddDocumentOperationBuilderForFirstSync, buildAddDocumentOperationBuilderForUpdate, buildContainerRecursiveProcessor, fetch

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

addDocumentOperationToEnumeratedOperationPipeline, addFolderOperationToEnumeratedOperationPipeline, addSynchronizerCallback, buildDeletedDocumentOperationBuilder, buildDeletionHelper, buildSourceAdapter, buildSourceEnumerator, buildSpecializedSourceAdapters, callBeforeDestruction, fetch, getActionToUpdate, getConnectorConfig, getCurrentPAPI, getDefaultThreadFactory, getDocumentSecurityTokens, getNbThreadsPerEnumeratedDocumentOperationPipeline, getNbThreadsPerEnumeratedFolderOperationPipeline, handleRootDeletes, init, initializePipelinesManager, isdoDelete, isPushFolder, isSynchronizeSourceEnumeratorsError, isUpdate, processActionToUpdate, registerDocInProgress, registerWorkInProgress, removeSynchronizerCallback, scan, setCurrentPAPI, setNbThreadsPerEnumeratedDocumentOperationPipeline, setNbThreadsPerEnumeratedFolderOperationPipeline, setNbThreadsPerEnumeratedOperationPipeline, setSynchronizeSourceEnumeratorsError, terminateThreads

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

checkAbortingOperation, checkAbortingOperation, checkDataSourceAvailability, checkSecurityTokens, getConnectorName, getEndpointBuilder, getLogger, getLogger, getScanModes, getState, getState, getStatus, getStatus, getStatusException, init, onScanAborted, onScanAborted, onScanResumed, onScanResumed, onScanSuspended, onScanSuspended, scratch, selfAbortScan, selfAbortScan, synchronizeDocuments

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerMultiThreadedConnector

public ContainerMultiThreadedConnector(ContainerMultiThreadedConnectorConfig config)
                                throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

buildStartKeyFromConf

protected com.exalead.papi.framework.source.adapter.Key buildStartKeyFromConf(java.lang.String configKey,
                                                                              boolean isFolder)
                                                                       throws java.lang.Exception

Call to transform Folder Name (from RootFolders) to FolderKey Warning : can be called with null parameter when the RootFolders is empty (to manage default root path)

Overrides:

buildStartKeyFromConf in class GenericMultiThreadedConnector<com.exalead.papi.framework.source.adapter.Key>

Parameters:

configKey - String to transform

isFolder - true if the key is a folder

Returns:

root folder keys

Throws:

java.lang.Exception

getKeyFromUri

public com.exalead.papi.framework.source.adapter.Key getKeyFromUri(java.lang.String uri)

Get AddDocumentOperationBuilder

Specified by:

getKeyFromUri in class GenericContainerMultiThreadedConnector<com.exalead.papi.framework.source.adapter.Key>

Parameters:

uri - the uri

Returns:

the key

getConnectorMetas

public static java.util.Map<java.lang.String,java.lang.String> getConnectorMetas(ConnectorInfoRequest infoRequest)
                                                                          throws java.lang.Exception

Get connector-specific metadata

Throws:

java.lang.Exception