org.javlo.service.syncro

Class AbstractSynchroService<SC extends AbstractSynchroContext>

java.lang.Object

org.javlo.service.syncro.AbstractSynchroService<SC>

Type Parameters:

SC - A subclass of AbstractSynchroContext specialized for subclasses.

Direct Known Subclasses:

BaseSynchroService

public abstract class AbstractSynchroService<SC extends AbstractSynchroContext>
extends Object

Abstract service defining required elements for synchronisation.

Author:

bdumont

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	logger

Constructor Summary

Constructors

Constructor and Description
AbstractSynchroService()

Method Summary

Modifier and Type	Method and Description
protected abstract void	applyAction(SC context, String path, AbstractSynchroContext.SynchroAction action) Apply the action required for the path.
protected void	applyActions(SC context) Call #applyAction(AbstractSynchroContext, String, SynchroAction) for each path with a required action.
protected AbstractSynchroContext.SynchroAction	defineAction(SC context, String path) Called to define the required action for the specified path.
protected void	defineActions(SC context) Called in the synchro process.
abstract String	getDistantName() Get the name of the distant side.
abstract String	getLocalName() Get the name of the local side.
protected void	initializeContext(SC context, Object previousState) Initialize the context.
protected abstract SC	newSynchroContext() Instanciate a context for ONE synchro run.
protected void	onActionsApplied(SC context) Called when all actions are applied.
protected void	onActionsDefined(SC context) Called when all paths are analysed and required actions defined.
protected void	onFatalException(SC context, SynchroFatalException ex) Called when an SynchroFatalException is thrown during the synchro process.
protected void	onNonFatalException(SC context, SynchroNonFatalException ex, String currentFilePath) Called when an SynchroNonFatalException is thrown during the synchro process.
protected void	onShutdown(SC context) Called every time a synchro run is finished even if a SynchroFatalException is thrown.
protected void	onUncaughtException(SC context, Throwable ex) Called when an exception is thrown during the synchro process.
boolean	synchronize() The synchronisation process main method.

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static Logger logger

Constructor Detail

AbstractSynchroService

public AbstractSynchroService()

Method Detail

getLocalName

public abstract String getLocalName()

Get the name of the local side. Can be used in conflict file name.

Returns:

the local name

getDistantName

public abstract String getDistantName()

Get the name of the distant side.

Returns:

the ditant name

synchronize

public boolean synchronize()

The synchronisation process main method.

Returns:

true if the synchronisation ended without error.

initializeContext

protected void initializeContext(SC context,
                                 Object previousState)
                          throws SynchroFatalException

Initialize the context. It's the first method that can thrown synchro exception.

Parameters:

context -

previousState -

Throws:

SynchroFatalException

newSynchroContext

protected abstract SC newSynchroContext()

Instanciate a context for ONE synchro run.

Returns:

an instance of AbstractSynchroContext specialized for the current AbstractSynchroService implementation.

defineActions

protected void defineActions(SC context)
                      throws SynchroFatalException

Called in the synchro process. Call defineAction(AbstractSynchroContext, String) for each path and AbstractSynchroContext.setAction(String, SynchroAction) with the result.

Parameters:

context - the current AbstractSynchroContext

Throws:

SynchroFatalException

defineAction

protected AbstractSynchroContext.SynchroAction defineAction(SC context,
                                                            String path)
                                                     throws SynchroNonFatalException,
                                                            SynchroFatalException

Called to define the required action for the specified path.

Parameters:

context - the current AbstractSynchroContext

path -

Returns:

the required action.

Throws:

SynchroNonFatalException

SynchroFatalException

onActionsDefined

protected void onActionsDefined(SC context)

Called when all paths are analysed and required actions defined.

Parameters:

context - the current AbstractSynchroContext

applyActions

protected void applyActions(SC context)

Call #applyAction(AbstractSynchroContext, String, SynchroAction) for each path with a required action.

Parameters:

context - the current AbstractSynchroContext

applyAction

protected abstract void applyAction(SC context,
                                    String path,
                                    AbstractSynchroContext.SynchroAction action)
                             throws SynchroNonFatalException

Apply the action required for the path.

Parameters:

context - the current AbstractSynchroContext

path -

action -

Throws:

SynchroNonFatalException

onActionsApplied

protected void onActionsApplied(SC context)

Called when all actions are applied.

Parameters:

context - the current AbstractSynchroContext

onNonFatalException

protected void onNonFatalException(SC context,
                                   SynchroNonFatalException ex,
                                   String currentFilePath)

Called when an SynchroNonFatalException is thrown during the synchro process. Only the current file will be skipped.

Parameters:

context - the current AbstractSynchroContext

ex -

currentFilePath -

onFatalException

protected void onFatalException(SC context,
                                SynchroFatalException ex)

Called when an SynchroFatalException is thrown during the synchro process. This is fatal for ONE run.

Parameters:

context - the current AbstractSynchroContext

ex -

onUncaughtException

protected void onUncaughtException(SC context,
                                   Throwable ex)

Called when an exception is thrown during the synchro process. This is fatal for ONE run.

Parameters:

context - the current AbstractSynchroContext. Can be null if the exception is thrown during the call of newSynchroContext().

ex -

onShutdown

protected void onShutdown(SC context)

Called every time a synchro run is finished even if a SynchroFatalException is thrown. See AbstractSynchroContext.isErrorOccured().
Not called the newSynchroContext() failed.

Parameters:

context - the current AbstractSynchroContext