Package org.craftercms.studio.api.v2.sync

Interface RepositoryWatcher

All Known Implementing Classes:
RepositoryWatcherImpl
public interface RepositoryWatcher
The RepositoryWatcher is responsible for watching the file system for changes to registered sites' repositories.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    deregisterSite(String siteId)
    De-register a site from being watched.
    void
    registerSite(String siteId, Path sitePath)
    Register a site to be watched.
    void
    startWatching()
    Start watching the registered sites.

  • Method Details

    • registerSite

      void registerSite(String siteId, Path sitePath) throws SiteNotFoundException, IOException
      Register a site to be watched.
      Parameters:
      siteId - The site ID.
      sitePath - The path to the site's repository.
      Throws:
      SiteNotFoundException
      IOException

    • deregisterSite

      void deregisterSite(String siteId)
      De-register a site from being watched.
      Parameters:
      siteId - The site ID.

    • startWatching

      void startWatching()
      Start watching the registered sites. This method is here to allow async processing by Spring.