com.exalead.papi.framework.callbacks

Class DefaultSynchronizerCallback<SKey extends Key>

java.lang.Object

com.exalead.papi.framework.callbacks.SynchronizerCallback<SKey>

com.exalead.papi.framework.callbacks.DefaultSynchronizerCallback<SKey>

public class DefaultSynchronizerCallback<SKey extends Key>
extends SynchronizerCallback<SKey>

Constructor Summary

Constructors

Constructor and Description
DefaultSynchronizerCallback()

Method Summary

Modifier and Type	Method and Description
void	beginAddDocumentEventTreatment(Connector connector, SKey key)
void	beginCleanUp(Connector connector) called before the CleanUp process (DeletedDocument detection)
void	beginDocumentOperationExecution(DocumentOperation<SKey> operation, java.lang.String threadName) called when a DocumentOperation is going to be executed
void	beginEnumeratedFolderTreatment(Connector connector, SourceEnumerator<SKey> sourceEnumerator, SKey folderKey, SKey fatherFolderKey, FolderOperation<SKey> fatherOperation) called when a FolderKey treatment begins
void	beginEnumeratedKeyTreatment(Connector connector, SourceEnumerator<SKey> sourceEnumerator, SyncedEntry prevKey, FolderDeletionHelper deletionHelper, SKey key, SKey fatherFolderKey, FolderOperation<SKey> fatherOperation) called when a DocumentKey treatment begins
void	beginEnumeratedSourceEnumeration(Connector connector) called before the Folder pipeline treatment begins
void	beginEnumeratedSourceSync(Connector connector) Called when the global process of Enumerated sources synchronization begins It includes the optional DeletedDocument detection (CleanUp), and the enumerations.
void	beginFolderOperationExecution(FolderOperation<SKey> operation, java.lang.String threadName) called when a FolderOperation is going to be executed
void	beginUpdateDocumentEventTreatment(Connector connector, Key key)
void	beginUpdateMetasDocumentEventTreatment(Connector connector, Key key, java.util.ArrayList<SKey> metaNameList)
void	documentKeySkipped(EnumeratesFolderOperation<SKey> enumeratesFolderOperation, SKey key) callback on skipped document
void	endAddDocumentEventTreatment(Connector connector, SKey key)
void	endCleanUp(Connector connector) called after the CleanUp process (DeletedDocument detection)
void	endEnumeratedFolderTreatment(Connector connector, SourceEnumerator<SKey> sourceEnumerator, SKey folderKey, SKey fatherFolderKey, FolderOperation<SKey> fatherOperation) called when a FolderKey treatment ends
void	endEnumeratedKeyTreatment(Connector connector, SourceEnumerator<SKey> sourceEnumerator, SKey key, SKey fatherFolderKey, FolderOperation<SKey> fatherOperation)
void	endEnumeratedSourceEnumeration(Connector connector) called when the Folder pipeline treatment is over but it may still remains some DocumentOperations in the Document pipeline
void	endEnumeratedSourceSync(Connector connector) called when the global process of Enumerated sources synchronization ends
void	errorDocumentOperationExecution(DocumentOperation<SKey> operation, java.lang.String threadName, java.lang.Throwable e) called when a FolderOperation execution throw an Exception
void	errorFolderOperationExecution(FolderOperation<SKey> operation, java.lang.String threadName, java.lang.Throwable e) called when a FolderOperation execution throw an Exception
boolean	filterDocumentKey(EnumeratesFolderOperation<SKey> enumeratesFolderOperation, SyncedEntry previousEntry, SKey key) called to offer the possibility to skip the Document's treatment
boolean	filterFolderKey(EnumeratesFolderOperation<SKey> enumeratesFolderOperation) called to offer the possibility to skip the folder's treatment
void	folderKeySkipped(EnumeratesFolderOperation<SKey> enumeratesFolderOperation) callback on skipped folder
void	successDocumentOperationExecution(DocumentOperation<SKey> operation, java.lang.String threadName) called when a DocumentOperation execution is finish without error
void	successFolderOperationExecution(FolderOperation<SKey> operation, java.lang.String threadName) called when a FolderOperation execution is finish without error

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSynchronizerCallback

public DefaultSynchronizerCallback()

Method Detail

beginAddDocumentEventTreatment

public void beginAddDocumentEventTreatment(Connector connector,
                                           SKey key)

beginCleanUp

public void beginCleanUp(Connector connector)

Description copied from class: SynchronizerCallback

called before the CleanUp process (DeletedDocument detection)

Specified by:

beginCleanUp in class SynchronizerCallback<SKey extends Key>

beginDocumentOperationExecution

public void beginDocumentOperationExecution(DocumentOperation<SKey> operation,
                                            java.lang.String threadName)

Description copied from class: SynchronizerCallback

called when a DocumentOperation is going to be executed

Specified by:

beginDocumentOperationExecution in class SynchronizerCallback<SKey extends Key>

threadName - thread in charge of the processing

beginEnumeratedFolderTreatment

public void beginEnumeratedFolderTreatment(Connector connector,
                                           SourceEnumerator<SKey> sourceEnumerator,
                                           SKey folderKey,
                                           SKey fatherFolderKey,
                                           FolderOperation<SKey> fatherOperation)

Description copied from class: SynchronizerCallback

called when a FolderKey treatment begins

Specified by:

beginEnumeratedFolderTreatment in class SynchronizerCallback<SKey extends Key>

sourceEnumerator - The SourceEnumerator that produced the FolderKey

folderKey - The FolderKey treated

fatherFolderKey - The father's FolderKey

fatherOperation - The father FolderOperation

beginEnumeratedKeyTreatment

public void beginEnumeratedKeyTreatment(Connector connector,
                                        SourceEnumerator<SKey> sourceEnumerator,
                                        SyncedEntry prevKey,
                                        FolderDeletionHelper deletionHelper,
                                        SKey key,
                                        SKey fatherFolderKey,
                                        FolderOperation<SKey> fatherOperation)
                                 throws java.lang.Exception

Description copied from class: SynchronizerCallback

called when a DocumentKey treatment begins

Specified by:

beginEnumeratedKeyTreatment in class SynchronizerCallback<SKey extends Key>

sourceEnumerator - The SourceEnumerator that produced the FolderKey

prevKey - The previous key this key is supposed to replace, null if none

key - The DocumentKey treated

fatherFolderKey - The FolderKey of the parent Folder

fatherOperation - The father FolderOperation

Throws:

java.lang.Exception

beginEnumeratedSourceEnumeration

public void beginEnumeratedSourceEnumeration(Connector connector)

Description copied from class: SynchronizerCallback

called before the Folder pipeline treatment begins

Specified by:

beginEnumeratedSourceEnumeration in class SynchronizerCallback<SKey extends Key>

beginEnumeratedSourceSync

public void beginEnumeratedSourceSync(Connector connector)

Description copied from class: SynchronizerCallback

Called when the global process of Enumerated sources synchronization begins It includes the optional DeletedDocument detection (CleanUp), and the enumerations.

Specified by:

beginEnumeratedSourceSync in class SynchronizerCallback<SKey extends Key>

beginFolderOperationExecution

public void beginFolderOperationExecution(FolderOperation<SKey> operation,
                                          java.lang.String threadName)

Description copied from class: SynchronizerCallback

called when a FolderOperation is going to be executed

Specified by:

beginFolderOperationExecution in class SynchronizerCallback<SKey extends Key>

threadName - The thread in charge of the processing

beginUpdateDocumentEventTreatment

public void beginUpdateDocumentEventTreatment(Connector connector,
                                              Key key)

beginUpdateMetasDocumentEventTreatment

public void beginUpdateMetasDocumentEventTreatment(Connector connector,
                                                   Key key,
                                                   java.util.ArrayList<SKey> metaNameList)

documentKeySkipped

public void documentKeySkipped(EnumeratesFolderOperation<SKey> enumeratesFolderOperation,
                               SKey key)

Description copied from class: SynchronizerCallback

callback on skipped document

Specified by:

documentKeySkipped in class SynchronizerCallback<SKey extends Key>

endAddDocumentEventTreatment

public void endAddDocumentEventTreatment(Connector connector,
                                         SKey key)

endCleanUp

public void endCleanUp(Connector connector)

Description copied from class: SynchronizerCallback

called after the CleanUp process (DeletedDocument detection)

Specified by:

endCleanUp in class SynchronizerCallback<SKey extends Key>

endEnumeratedFolderTreatment

public void endEnumeratedFolderTreatment(Connector connector,
                                         SourceEnumerator<SKey> sourceEnumerator,
                                         SKey folderKey,
                                         SKey fatherFolderKey,
                                         FolderOperation<SKey> fatherOperation)

Description copied from class: SynchronizerCallback

called when a FolderKey treatment ends

Specified by:

endEnumeratedFolderTreatment in class SynchronizerCallback<SKey extends Key>

sourceEnumerator - The SourceEnumerator that produced the FolderKey

folderKey - The FolderKey treated

fatherFolderKey - The father's FolderKey

fatherOperation - The father FolderOperation

endEnumeratedKeyTreatment

public void endEnumeratedKeyTreatment(Connector connector,
                                      SourceEnumerator<SKey> sourceEnumerator,
                                      SKey key,
                                      SKey fatherFolderKey,
                                      FolderOperation<SKey> fatherOperation)

Specified by:

endEnumeratedKeyTreatment in class SynchronizerCallback<SKey extends Key>

sourceEnumerator - The SourceEnumerator that produced the FolderKey

key - The DocumentKey treated

fatherFolderKey - The FolderKey of the parent Folder

fatherOperation - The father FolderOperation

endEnumeratedSourceEnumeration

public void endEnumeratedSourceEnumeration(Connector connector)

Description copied from class: SynchronizerCallback

called when the Folder pipeline treatment is over but it may still remains some DocumentOperations in the Document pipeline

Specified by:

endEnumeratedSourceEnumeration in class SynchronizerCallback<SKey extends Key>

endEnumeratedSourceSync

public void endEnumeratedSourceSync(Connector connector)

Description copied from class: SynchronizerCallback

called when the global process of Enumerated sources synchronization ends

Specified by:

endEnumeratedSourceSync in class SynchronizerCallback<SKey extends Key>

errorDocumentOperationExecution

public void errorDocumentOperationExecution(DocumentOperation<SKey> operation,
                                            java.lang.String threadName,
                                            java.lang.Throwable e)

Description copied from class: SynchronizerCallback

called when a FolderOperation execution throw an Exception

Specified by:

errorDocumentOperationExecution in class SynchronizerCallback<SKey extends Key>

threadName - thread in charge of the processing

e - The Exception thrown during execution

errorFolderOperationExecution

public void errorFolderOperationExecution(FolderOperation<SKey> operation,
                                          java.lang.String threadName,
                                          java.lang.Throwable e)

Description copied from class: SynchronizerCallback

called when a FolderOperation execution throw an Exception

Specified by:

errorFolderOperationExecution in class SynchronizerCallback<SKey extends Key>

threadName - The thread in charge of the processing

e - The Exception thrown during execution

filterDocumentKey

public boolean filterDocumentKey(EnumeratesFolderOperation<SKey> enumeratesFolderOperation,
                                 SyncedEntry previousEntry,
                                 SKey key)

Description copied from class: SynchronizerCallback

called to offer the possibility to skip the Document's treatment

Specified by:

filterDocumentKey in class SynchronizerCallback<SKey extends Key>

previousEntry - The previous entry corresponding to this key. null if none

key - The DocumentKey to test

Returns:

true to skip the document

filterFolderKey

public boolean filterFolderKey(EnumeratesFolderOperation<SKey> enumeratesFolderOperation)

Description copied from class: SynchronizerCallback

called to offer the possibility to skip the folder's treatment

Specified by:

filterFolderKey in class SynchronizerCallback<SKey extends Key>

Returns:

true to skip the folder

folderKeySkipped

public void folderKeySkipped(EnumeratesFolderOperation<SKey> enumeratesFolderOperation)

Description copied from class: SynchronizerCallback

callback on skipped folder

Specified by:

folderKeySkipped in class SynchronizerCallback<SKey extends Key>

successDocumentOperationExecution

public void successDocumentOperationExecution(DocumentOperation<SKey> operation,
                                              java.lang.String threadName)

Description copied from class: SynchronizerCallback

called when a DocumentOperation execution is finish without error

Specified by:

successDocumentOperationExecution in class SynchronizerCallback<SKey extends Key>

threadName - thread in charge of the processing

successFolderOperationExecution

public void successFolderOperationExecution(FolderOperation<SKey> operation,
                                            java.lang.String threadName)

Description copied from class: SynchronizerCallback

called when a FolderOperation execution is finish without error

Specified by:

successFolderOperationExecution in class SynchronizerCallback<SKey extends Key>

threadName - The thread in charge of the processing