com.exalead.papi.framework.callbacks

Class SynchronizerCallback<SKey extends Key>

java.lang.Object

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

Direct Known Subclasses:

DefaultSynchronizerCallback, SynchronizerCallbackContainer

public abstract class SynchronizerCallback<SKey extends Key>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SynchronizerCallback()

Method Summary

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

SynchronizerCallback

public SynchronizerCallback()

Method Detail

beginEnumeratedSourceSync

public abstract void beginEnumeratedSourceSync(Connector connector)

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

Parameters:

connector -

endEnumeratedSourceSync

public abstract void endEnumeratedSourceSync(Connector connector)

called when the global process of Enumerated sources synchronization ends

Parameters:

connector -

beginCleanUp

public abstract void beginCleanUp(Connector connector)

called before the CleanUp process (DeletedDocument detection)

Parameters:

connector -

endCleanUp

public abstract void endCleanUp(Connector connector)

called after the CleanUp process (DeletedDocument detection)

Parameters:

connector -

beginEnumeratedSourceEnumeration

public abstract void beginEnumeratedSourceEnumeration(Connector connector)

called before the Folder pipeline treatment begins

Parameters:

connector -

endEnumeratedSourceEnumeration

public abstract void endEnumeratedSourceEnumeration(Connector connector)

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

Parameters:

connector -

beginEnumeratedFolderTreatment

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

called when a FolderKey treatment begins

Parameters:

connector -

sourceEnumerator - The SourceEnumerator that produced the FolderKey

folderKey - The FolderKey treated

fatherFolderKey - The father's FolderKey

fatherOperation - The father FolderOperation

endEnumeratedFolderTreatment

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

called when a FolderKey treatment ends

Parameters:

connector -

sourceEnumerator - The SourceEnumerator that produced the FolderKey

folderKey - The FolderKey treated

fatherFolderKey - The father's FolderKey

fatherOperation - The father FolderOperation

beginEnumeratedKeyTreatment

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

called when a DocumentKey treatment begins

Parameters:

connector -

sourceEnumerator - The SourceEnumerator that produced the FolderKey

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

The - deletion handler, null if none particular is provided by the connector

key - The DocumentKey treated

fatherFolderKey - The FolderKey of the parent Folder

fatherOperation - The father FolderOperation

Throws:

java.lang.Exception

endEnumeratedKeyTreatment

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

Parameters:

connector -

sourceEnumerator - The SourceEnumerator that produced the FolderKey

key - The DocumentKey treated

fatherFolderKey - The FolderKey of the parent Folder

fatherOperation - The father FolderOperation

filterFolderKey

public abstract boolean filterFolderKey(EnumeratesFolderOperation<SKey> enumeratesFolderOperation)

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

Parameters:

enumeratesFolderOperation -

Returns:

true to skip the folder

filterDocumentKey

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

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

Parameters:

enumeratesFolderOperation -

key - The DocumentKey to test

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

Returns:

true to skip the document

folderKeySkipped

public abstract void folderKeySkipped(EnumeratesFolderOperation<SKey> enumeratesFolderOperation)

callback on skipped folder

Parameters:

enumeratesFolderOperation -

documentKeySkipped

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

callback on skipped document

Parameters:

enumeratesFolderOperation -

key -

beginFolderOperationExecution

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

called when a FolderOperation is going to be executed

Parameters:

operation -

threadName - The thread in charge of the processing

successFolderOperationExecution

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

called when a FolderOperation execution is finish without error

Parameters:

operation -

threadName - The thread in charge of the processing

errorFolderOperationExecution

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

called when a FolderOperation execution throw an Exception

Parameters:

operation -

threadName - The thread in charge of the processing

e - The Exception thrown during execution

beginDocumentOperationExecution

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

called when a DocumentOperation is going to be executed

Parameters:

operation -

threadName - thread in charge of the processing

successDocumentOperationExecution

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

called when a DocumentOperation execution is finish without error

Parameters:

operation -

threadName - thread in charge of the processing

errorDocumentOperationExecution

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

called when a FolderOperation execution throw an Exception

Parameters:

operation -

threadName - thread in charge of the processing

e - The Exception thrown during execution