Package org.duracloud.syncui.service

Interface SyncProcess

All Known Subinterfaces:
SyncProcessManager
All Known Implementing Classes:
SyncProcessManagerImpl
public interface SyncProcess
Author:
Daniel Bernstein

  • Method Summary

    Modifier and Type
    Method
    Description
    SyncProcessState
    getProcessState()
    Returns an enum designating the runtime state of the sync process
    SyncProcessStats
    getProcessStats()
    Returns stats related the sync process
    void
    pause()
    Pauses the sync process.
    void
    restart()
    Equivalent to a stop and a restart.
    void
    resume()
    Resumes the sync process from the paused state.
    void
    start()
    Starts the sync process.
    void
    stop()
    Stops the sync process.

  • Method Details

    • start

      void start() throws SyncProcessException
      Starts the sync process. Invocations are ignored if the sync process is already running.
      Throws:
      SyncProcessException

    • resume

      void resume() throws SyncProcessException
      Resumes 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: