Interface SyncSession

All Known Subinterfaces:
BmSyncSession
All Known Implementing Classes:
AbstractBmSyncSession, ConfigurationSyncSession, ExtensionSyncSession, ExternalObjectSyncSession

public interface SyncSession
The session creates each time when synchronizing projects. The session responsible for creation of the target project and actions before and after synchronization.
  • Method Summary

    Modifier and Type
    Method
    Description
    default org.eclipse.core.runtime.IStatus
    afterSynchronized(org.eclipse.core.runtime.IProgressMonitor monitor)
    After synchronized the target project.
    default org.eclipse.core.runtime.IStatus
    beforeSynchronizing(org.eclipse.core.runtime.IProgressMonitor monitor)
    Before synchronizing projects, but after creating target project.
    void
    Begins synchronization operation.
    org.eclipse.core.runtime.IStatus
    createProject(org.eclipse.core.runtime.IProgressMonitor monitor)
    Creates the target project with all specific.
    void
    Ends the operation.
    Collection<org.eclipse.core.runtime.IPath>
    Gets the resources skipped duaring this sync session.
  • Method Details

    • createProject

      org.eclipse.core.runtime.IStatus createProject(org.eclipse.core.runtime.IProgressMonitor monitor)
      Creates the target project with all specific.
      Parameters:
      monitor - the monitor
      Returns:
      the status of creation
    • beforeSynchronizing

      default org.eclipse.core.runtime.IStatus beforeSynchronizing(org.eclipse.core.runtime.IProgressMonitor monitor)
      Before synchronizing projects, but after creating target project.
      Parameters:
      monitor - the monitor
      Returns:
      the status
    • afterSynchronized

      default org.eclipse.core.runtime.IStatus afterSynchronized(org.eclipse.core.runtime.IProgressMonitor monitor)
      After synchronized the target project.
      Parameters:
      monitor - the monitor
      Returns:
      the status
    • getSkipped

      Collection<org.eclipse.core.runtime.IPath> getSkipped()
      Gets the resources skipped duaring this sync session.
      Returns:
      the skipped resources, cannot return null.
    • beginSyncOperation

      void beginSyncOperation()
      Begins synchronization operation. Performs all necessary lifecycle checks and resource blocking. Must preceed any business actions within the session. May be called only once per session
    • endSyncOperation

      void endSyncOperation()
      Ends the operation. Must be called after internal synchronization logic is finished to remove LC/resource locks