Package com.e1c.g5.v8.dt.platform.cloud.core.sync

Interface ISynchronizationSession

All Superinterfaces:

AutoCloseable

public interface ISynchronizationSession
extends AutoCloseable

The workspace synchronization session.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ISynchronizationSession.ISynchronizationMonitor	Synchronization monitor periodically checks staging process and report proggress as Eclipse Jobs.

Method Summary

Modifier and Type	Method	Description
void	close()	Permanently terminates the synchronization session.
void	flush()	Forces a synchronization cycle.
List<Path>	getConflictFiles()	Returns a list of conflict files.
ISynchronizationSession.ISynchronizationMonitor	monitorSynchronization()	Creates sycnhronization process monitor that periodically checks staging process and report proggress as Eclipse Jobs.
void	overrideConflictFiles()	Overrides all conflict files with external copy.
void	pause()	Pauses the synchronization session.
void	resume()	Resumes the paused or disconnected synchronization session.
void	waitForSynchronization(org.eclipse.core.runtime.IProgressMonitor monitor)	Waits for current sycnhronization process to compleete and reports progress information about synchronization to the provided progress monitor.

Method Detail

pause

void pause()
    throws WorkspaceSynchronizationException

Pauses the synchronization session.

Throws:

WorkspaceSynchronizationException - if pause failed

resume

void resume()
     throws WorkspaceSynchronizationException

Resumes the paused or disconnected synchronization session.

Throws:

WorkspaceSynchronizationException - if resume failed

flush

void flush()
    throws WorkspaceSynchronizationException

Forces a synchronization cycle.

Throws:

WorkspaceSynchronizationException - if flush failed

waitForSynchronization

void waitForSynchronization(org.eclipse.core.runtime.IProgressMonitor monitor)
                     throws WorkspaceSynchronizationException

Waits for current sycnhronization process to compleete and reports progress information about synchronization to the provided progress monitor.

Parameters:

monitor - to display progress, cannot be null

Throws:

WorkspaceSynchronizationException - if synchronization wait wait failed

monitorSynchronization

ISynchronizationSession.ISynchronizationMonitor monitorSynchronization()
                                                                throws WorkspaceSynchronizationException

Creates sycnhronization process monitor that periodically checks staging process and report proggress as Eclipse Jobs. Returns monitor handle to close monitoring process.

Returns:

the monitor handle to close monitoring process, never null

Throws:

WorkspaceSynchronizationException - if synchronization wait wait failed

getConflictFiles

List<Path> getConflictFiles()
                     throws WorkspaceSynchronizationException

Returns a list of conflict files.

Returns:

a list conflict files, never null

Throws:

WorkspaceSynchronizationException - if files get failed

overrideConflictFiles

void overrideConflictFiles()
                    throws WorkspaceSynchronizationException

Overrides all conflict files with external copy.

Throws:

WorkspaceSynchronizationException - if files override failed

close

void close()
    throws WorkspaceSynchronizationException

Permanently terminates the synchronization session.

Specified by:

close in interface AutoCloseable

Throws:

WorkspaceSynchronizationException - if close failed