org.gcube.usecases.ws.thredds

Interface SyncEngine

All Known Implementing Classes:

SynchEngineImpl

public interface SyncEngine

Method Summary

Modifier and Type	Method and Description
SyncFolderDescriptor	check(String folderId, boolean recursively) Checked Access Method
ProcessDescriptor	doSync(String folderId) Checked Access Method
void	forceUnlock(String folderId) Checked Access Method
static SyncEngine	get()
Set<CatalogBean>	getAvailableCatalogs()
SynchFolderConfiguration	getConfig(String fodlerId)
SynchronizedElementInfo	getInfo(String elementId) NB Method To Be Implemented
ProcessDescriptor	getProcessDescriptorByFolderId(String folderId)
ProcessStatus	getProcessStatusByFolderId(String folderId)
String	getRequestLoggerPath()
SyncEngineStatusDescriptor	getStatus()
boolean	isRequestLoggerEnabled()
static SynchronizedElementInfo	parseInfo(Map<String,Object> itemProperties, ContainerType itemType)
void	registerCallBack(String folderId, SyncOperationCallBack callback)
void	setRequestLogger(String path)
void	setSynchronizedFolder(SynchFolderConfiguration config, String folderId) Checked Access Method
void	shutDown()
void	stopSynch(String folderId) Checked Access Method
void	unsetSynchronizedFolder(String folderId, boolean deleteRemoteContent) Checked Access Method
void	updateCatalogFile(String folderId, File toUpdate) Checked Access Method

Method Detail

get

static SyncEngine get()

check

SyncFolderDescriptor check(String folderId,
                           boolean recursively)
                    throws WorkspaceInteractionException,
                           InternalException

Checked Access Method

Throws:

WorkspaceInteractionException

InternalException

registerCallBack

void registerCallBack(String folderId,
                      SyncOperationCallBack callback)
               throws ProcessNotFoundException

Throws:

ProcessNotFoundException

doSync

ProcessDescriptor doSync(String folderId)
                  throws WorkspaceInteractionException,
                         InternalException

Checked Access Method

Throws:

WorkspaceInteractionException

InternalException

stopSynch

void stopSynch(String folderId)
        throws ProcessNotFoundException,
               WorkspaceInteractionException,
               InternalException

Checked Access Method

Throws:

ProcessNotFoundException

WorkspaceInteractionException

InternalException

setSynchronizedFolder

void setSynchronizedFolder(SynchFolderConfiguration config,
                           String folderId)
                    throws WorkspaceInteractionException,
                           InternalException

Checked Access Method

Throws:

WorkspaceInteractionException

InternalException

unsetSynchronizedFolder

void unsetSynchronizedFolder(String folderId,
                             boolean deleteRemoteContent)
                      throws WorkspaceInteractionException,
                             InternalException

Checked Access Method

Throws:

WorkspaceInteractionException

InternalException

getInfo

SynchronizedElementInfo getInfo(String elementId)

NB Method To Be Implemented

Parameters:

elementId -

Returns:

updateCatalogFile

void updateCatalogFile(String folderId,
                       File toUpdate)
                throws InternalException,
                       WorkspaceInteractionException

Checked Access Method

Throws:

WorkspaceInteractionException

InternalException

forceUnlock

void forceUnlock(String folderId)
          throws InternalException,
                 WorkspaceInteractionException

Checked Access Method

Parameters:

folderId -

Throws:

InternalException

WorkspaceInteractionException

shutDown

void shutDown()

getProcessDescriptorByFolderId

ProcessDescriptor getProcessDescriptorByFolderId(String folderId)
                                          throws ProcessNotFoundException

Throws:

ProcessNotFoundException

getProcessStatusByFolderId

ProcessStatus getProcessStatusByFolderId(String folderId)
                                  throws ProcessNotFoundException

Throws:

ProcessNotFoundException

setRequestLogger

void setRequestLogger(String path)

isRequestLoggerEnabled

boolean isRequestLoggerEnabled()

getRequestLoggerPath

String getRequestLoggerPath()

getAvailableCatalogs

Set<CatalogBean> getAvailableCatalogs()
                               throws InternalException

Throws:

InternalException

getStatus

SyncEngineStatusDescriptor getStatus()

getConfig

SynchFolderConfiguration getConfig(String fodlerId)
                            throws WorkspaceInteractionException,
                                   WorkspaceNotSynchedException

Throws:

WorkspaceInteractionException

WorkspaceNotSynchedException

parseInfo

static SynchronizedElementInfo parseInfo(Map<String,Object> itemProperties,
                                         ContainerType itemType)
                                  throws WorkspaceNotSynchedException

Throws:

WorkspaceNotSynchedException