Package org.duracloud.syncui.service
Interface SyncProcess
-
- All Known Subinterfaces:
SyncProcessManager
- All Known Implementing Classes:
SyncProcessManagerImpl
public interface SyncProcess- Author:
- Daniel Bernstein
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SyncProcessStategetProcessState()Returns an enum designating the runtime state of the sync processSyncProcessStatsgetProcessStats()Returns stats related the sync processvoidpause()Pauses the sync process.voidrestart()Equivalent to a stop and a restart.voidresume()Resumes the sync process from the paused state.voidstart()Starts the sync process.voidstop()Stops the sync process.
-
-
-
Method Detail
-
start
void start() throws SyncProcessExceptionStarts the sync process. Invocations are ignored if the sync process is already running.- Throws:
SyncProcessException
-
resume
void resume() throws SyncProcessExceptionResumes the sync process from the paused state. Invocations are ignored if the sync process is already running.- Throws:
SyncProcessException
-
stop
void stop()
Stops the sync process. Invocations are ignored if the sync process is already stopped. All work state is deleted. On start, the sync will start from scratch after this method has been invoked.
-
pause
void pause()
Pauses the sync process. Any any stored queue state information will be preserved when the sync process is restarted. It can be invoked from any state.
-
restart
void restart()
Equivalent to a stop and a restart.
-
getProcessState
SyncProcessState getProcessState()
Returns an enum designating the runtime state of the sync process- Returns:
-
getProcessStats
SyncProcessStats getProcessStats()
Returns stats related the sync process- Returns:
-
-