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

Interface IWorkspaceSynchronizer

public interface IWorkspaceSynchronizer

The Eclipse workspace synchronizer instance. Allows to open synchronization sessions to synchronize workspace projects content.

Method Summary

Modifier and Type	Method	Description
ISynchronizationSession	openSession(URI remoteUri, Path localPath)	Opens and returns the synchronization session to synchronize workspace.
ISynchronizationSession	openSession(URI remoteUri, Path localPath, SynchronizationConfiguration configuration)	Opens and returns the synchronization session to synchronize workspace using the provided configuration.

Method Detail

openSession

ISynchronizationSession openSession(URI remoteUri,
                                    Path localPath)
                             throws WorkspaceSynchronizationException

Opens and returns the synchronization session to synchronize workspace. Clients are responsible to close session when no longer needed.

Parameters:

remoteUri - the remote URI to start synchronization with, may be remote host URL with user info or local file-system path, cannot be null

localPath - the local path to synchronize to, cannot be null

Returns:

the created workspace synchronization session, never null

Throws:

WorkspaceSynchronizationException - open synchronization session failed

openSession

ISynchronizationSession openSession(URI remoteUri,
                                    Path localPath,
                                    SynchronizationConfiguration configuration)
                             throws WorkspaceSynchronizationException

Opens and returns the synchronization session to synchronize workspace using the provided configuration. Clients are responsible to close session when no longer needed.

Parameters:

remoteUri - the remote URI to start synchronization with, may be remote host URL with user info or local file-system path, cannot be null

localPath - the local path to synchronize to, cannot be null

configuration - the synchronization configuration to use, cannot be null

Returns:

the created workspace synchronization session, never null

Throws:

WorkspaceSynchronizationException - open synchronization session failed