com.exalead.papi.connectors.filesystem.xml

Class XMLConnector

java.lang.Object

com.exalead.papi.framework.connectors.Connector

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

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

com.exalead.papi.connectors.filesystem.FilesystemConnector<XMLFilesystemKey>

com.exalead.papi.connectors.filesystem.xml.XMLConnector

All Implemented Interfaces:

CVComponent, UniqueIndexGenerator, ConnectorStatusExceptionInterface, ConnectorInterface

Direct Known Subclasses:

SimpleXMLConnector

public class XMLConnector
extends com.exalead.papi.connectors.filesystem.FilesystemConnector<XMLFilesystemKey>
implements UniqueIndexGenerator

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.papi.connectors.filesystem.FilesystemConnector

com.exalead.papi.connectors.filesystem.FilesystemConnector.NullFilter

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

Modifier and Type	Field and Description
protected java.util.concurrent.atomic.AtomicLong	chunkIndex
protected XMLConnectorConfig	config
protected PushAPI	papi
protected ProcessorBuilder<XMLFilesystemKey>	processorBuilder
protected boolean	shouldSplitDocuments
protected java.lang.String	uuidValue

Fields inherited from class com.exalead.papi.connectors.filesystem.FilesystemConnector

defaultEncoding, enableSecurity, filenameFilter, filesystemRootPaths, FORCE_RESCAN_CHECKPOINT_BEGIN, FORCE_RESCAN_CHECKPOINT_END, indexNames, keepLocalSecurityMetas, maxInputSize, mimeConfig, MODE_CONSUME_INTERCONNECTOR, MODE_FORCE_RESCAN, recursive, skipDirectorySymbolicLinks

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

DEFAULT_SCAN_MODE

Constructor Summary

Constructors

Constructor and Description
XMLConnector(XMLConnectorConfig config)

Method Summary

Modifier and Type	Method and Description
protected EnumerableOperationBuilder<XMLFilesystemKey>	buildAddDocumentOperationBuilderForFirstSync()
protected EnumerableOperationBuilder<XMLFilesystemKey>	buildAddDocumentOperationBuilderForUpdate() Get AddDocumentOperationBuilder
XMLContainerRecursiveProcessor	buildContainerRecursiveProcessor() Build the ContainerRecursiveProcessor responsible for handling containers.
FolderDeletionHelper	buildDeletionHelper(FolderDeletionHelper.FolderDeletionHelperClient client, java.lang.String rootPathUri) Returns this connector's deletion helper implementation provided this connector is in update mode
XMLFilesystemSourceAdapter	buildSourceAdapter() This method return a SourceAdapter implementation
XMLFilesystemSourceEnumerator	buildSourceEnumerator() This method return a SourceEnumerator implementation
protected XMLFilesystemKey	buildStartKeyFromConf(java.lang.String configKey, boolean isFolder) seems to work without this method but i'd prefer not mixing XMLFilesystemKeys and plain FilesystemKeys
Document	fetch(java.lang.String uri) This method is used to retrieve document from the source when CloudView product needs it.
Document	fetch(java.lang.String dirtyUri, java.lang.String[] securityTokens, boolean checkSecurityTokens) Fetch function.
XMLFilesystemKey	getKeyFromUri(java.lang.String uri)
java.lang.String	getNextChunkIndex()
ProcessorBuilder<XMLFilesystemKey>	getProcessorBuilder()
java.lang.String	getUuid()
void	init() Initialization method called by connector framework after construction

Methods inherited from class com.exalead.papi.connectors.filesystem.FilesystemConnector

callBeforeDestruction, checkConfig, checkDataSourceAvailability, compileFileExtensionsPattern, consumeInterConnectorEvents, createFileFromRootPath, getConfFromKey, getConnectorConfig, getConnectorMetas, getInterconnectorService, isFSSecurityAvailable, scan, scratch

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

addRootKeyInPipelineManager

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

addDocumentOperationToEnumeratedOperationPipeline, addFolderOperationToEnumeratedOperationPipeline, addSynchronizerCallback, buildDeletedDocumentOperationBuilder, buildSpecializedSourceAdapters, getActionToUpdate, getCurrentPAPI, getDefaultThreadFactory, getDocumentSecurityTokens, getNbThreadsPerEnumeratedDocumentOperationPipeline, getNbThreadsPerEnumeratedFolderOperationPipeline, handleRootDeletes, initializePipelinesManager, isdoDelete, isPushFolder, isSynchronizeSourceEnumeratorsError, isUpdate, processActionToUpdate, registerDocInProgress, registerWorkInProgress, removeSynchronizerCallback, setCurrentPAPI, setNbThreadsPerEnumeratedDocumentOperationPipeline, setNbThreadsPerEnumeratedFolderOperationPipeline, setNbThreadsPerEnumeratedOperationPipeline, setSynchronizeSourceEnumeratorsError, terminateThreads

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

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

Methods inherited from class java.lang.Object

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

Field Detail

chunkIndex

protected final java.util.concurrent.atomic.AtomicLong chunkIndex

uuidValue

protected final java.lang.String uuidValue

config

protected XMLConnectorConfig config

shouldSplitDocuments

protected boolean shouldSplitDocuments

processorBuilder

protected ProcessorBuilder<XMLFilesystemKey> processorBuilder

papi

protected PushAPI papi

Constructor Detail

XMLConnector

public XMLConnector(XMLConnectorConfig config)
             throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

init

public void init()
          throws java.lang.Exception

Description copied from class: Connector

Initialization method called by connector framework after construction

Overrides:

init in class com.exalead.papi.connectors.filesystem.FilesystemConnector<XMLFilesystemKey>

Throws:

java.lang.Exception

getKeyFromUri

public XMLFilesystemKey getKeyFromUri(java.lang.String uri)
                               throws java.io.IOException

Overrides:

getKeyFromUri in class com.exalead.papi.connectors.filesystem.FilesystemConnector<XMLFilesystemKey>

Throws:

java.io.IOException

buildStartKeyFromConf

protected XMLFilesystemKey buildStartKeyFromConf(java.lang.String configKey,
                                                 boolean isFolder)
                                          throws java.lang.Exception

seems to work without this method but i'd prefer not mixing XMLFilesystemKeys and plain FilesystemKeys

Overrides:

buildStartKeyFromConf in class com.exalead.papi.connectors.filesystem.FilesystemConnector<XMLFilesystemKey>

Throws:

java.lang.Exception

fetch

public Document fetch(java.lang.String uri)
               throws java.lang.Exception

Description copied from class: Connector

This method is used to retrieve document from the source when CloudView product needs it.

Overrides:

fetch in class GenericMultiThreadedConnector<XMLFilesystemKey>

Parameters:

uri - document identifier to retrieve

Returns:

requested document

Throws:

java.lang.Exception

fetch

public Document fetch(java.lang.String dirtyUri,
                      java.lang.String[] securityTokens,
                      boolean checkSecurityTokens)
               throws java.lang.Exception

Description copied from class: GenericContainerMultiThreadedConnector

Fetch function. Handle containers transparently.

Overrides:

fetch in class GenericContainerMultiThreadedConnector<XMLFilesystemKey>

Parameters:

dirtyUri - document identifier to retrieve

securityTokens - Security tokens of the user querying the document

checkSecurityTokens - If true, then the connector must send the document according to the security tokens given in parameters. For example the connector must return null if the user does not have credentials enough to view it, or only send the partial content the user is allowed to access.

Returns:

requested document

Throws:

java.lang.Exception - upon error.

buildSourceEnumerator

public XMLFilesystemSourceEnumerator buildSourceEnumerator()
                                                    throws java.lang.Exception

Description copied from class: GenericMultiThreadedConnector

This method return a SourceEnumerator implementation

Overrides:

buildSourceEnumerator in class com.exalead.papi.connectors.filesystem.FilesystemConnector<XMLFilesystemKey>

Returns:

SourceEnumerator implementation

Throws:

java.lang.Exception

buildSourceAdapter

public XMLFilesystemSourceAdapter buildSourceAdapter()
                                              throws java.lang.Exception

Description copied from class: GenericMultiThreadedConnector

This method return a SourceAdapter implementation

Overrides:

buildSourceAdapter in class com.exalead.papi.connectors.filesystem.FilesystemConnector<XMLFilesystemKey>

Returns:

SourceAdapter implementation

Throws:

java.lang.Exception

buildDeletionHelper

public FolderDeletionHelper buildDeletionHelper(FolderDeletionHelper.FolderDeletionHelperClient client,
                                                java.lang.String rootPathUri)
                                         throws PushAPIException

Description copied from class: GenericMultiThreadedConnector

Returns this connector's deletion helper implementation provided this connector is in update mode

Overrides:

buildDeletionHelper in class com.exalead.papi.connectors.filesystem.FilesystemConnector<XMLFilesystemKey>

Parameters:

client - handles the actual deletes of the documents.

rootPathUri - the folder root key

Returns:

A valid deletion helper, or if GenericMultiThreadedConnector.isUpdate() null

Throws:

PushAPIException

buildAddDocumentOperationBuilderForUpdate

protected EnumerableOperationBuilder<XMLFilesystemKey> buildAddDocumentOperationBuilderForUpdate()

Description copied from class: GenericContainerMultiThreadedConnector

Get AddDocumentOperationBuilder

Overrides:

buildAddDocumentOperationBuilderForUpdate in class GenericContainerMultiThreadedConnector<XMLFilesystemKey>

Returns:

the operation builder

buildAddDocumentOperationBuilderForFirstSync

protected EnumerableOperationBuilder<XMLFilesystemKey> buildAddDocumentOperationBuilderForFirstSync()

Overrides:

buildAddDocumentOperationBuilderForFirstSync in class GenericContainerMultiThreadedConnector<XMLFilesystemKey>

buildContainerRecursiveProcessor

public XMLContainerRecursiveProcessor buildContainerRecursiveProcessor()

Description copied from class: GenericContainerMultiThreadedConnector

Build the ContainerRecursiveProcessor responsible for handling containers.

Overrides:

buildContainerRecursiveProcessor in class com.exalead.papi.connectors.filesystem.FilesystemConnector<XMLFilesystemKey>

Returns:

the ContainerRecursiveProcessor

getProcessorBuilder

public ProcessorBuilder<XMLFilesystemKey> getProcessorBuilder()

getUuid

public java.lang.String getUuid()

Specified by:

getUuid in interface UniqueIndexGenerator

Returns:

Unique value for this instance of the generator

getNextChunkIndex

public java.lang.String getNextChunkIndex()

Specified by:

getNextChunkIndex in interface UniqueIndexGenerator

Returns:

Unique value for each time this instance is asked for an index value