Interface Sink

  • All Known Implementing Classes:
    RemoteSink

    public interface Sink
    A Sink maintains a different file system somewhere. This API synchronizes known files between a Source and the Sink.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int version  
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void cancel​(java.lang.String areaId)  
      boolean clearCache()  
      Area createArea​(java.lang.String areaId)
      Create a new area
      void exit()  
      int exit​(java.lang.String area)  
      Area getArea​(java.lang.String areaId)
      Get a specific area
      java.util.Collection<? extends Area> getAreas()
      Return a list of areas
      Welcome getWelcome​(int highestAccepted)
      Return the protocol version that must be used.
      void input​(java.lang.String area, java.lang.String text)  
      boolean launch​(java.lang.String areaId, java.util.Map<java.lang.String,​java.lang.String> env, java.util.List<java.lang.String> args)
      Launch
      boolean removeArea​(java.lang.String areaId)
      Remove an area
      boolean sync​(java.lang.String areaId, java.util.Collection<Delta> deltas)  
      byte[] view​(java.lang.String areaId, java.lang.String path)
      View a file or dir
    • Method Detail

      • sync

        boolean sync​(java.lang.String areaId,
                     java.util.Collection<Delta> deltas)
              throws java.lang.Exception
        Throws:
        java.lang.Exception
      • getWelcome

        Welcome getWelcome​(int highestAccepted)
        Return the protocol version that must be used. The parameter passed specifies the highest supported by the caller.
      • getAreas

        java.util.Collection<? extends Area> getAreas()
                                               throws java.lang.Exception
        Return a list of areas
        Throws:
        java.lang.Exception
      • getArea

        Area getArea​(java.lang.String areaId)
              throws java.lang.Exception
        Get a specific area
        Throws:
        java.lang.Exception
      • removeArea

        boolean removeArea​(java.lang.String areaId)
                    throws java.lang.Exception
        Remove an area
        Throws:
        java.lang.Exception
      • createArea

        Area createArea​(java.lang.String areaId)
                 throws java.lang.Exception
        Create a new area
        Parameters:
        areaId - area id, or null for a new area
        Throws:
        java.lang.Exception
      • launch

        boolean launch​(java.lang.String areaId,
                       java.util.Map<java.lang.String,​java.lang.String> env,
                       java.util.List<java.lang.String> args)
                throws java.lang.Exception
        Launch
        Throws:
        java.lang.Exception
      • exit

        int exit​(java.lang.String area)
          throws java.lang.Exception
        Throws:
        java.lang.Exception
      • view

        byte[] view​(java.lang.String areaId,
                    java.lang.String path)
             throws java.lang.Exception
        View a file or dir
        Throws:
        java.lang.Exception
      • exit

        void exit()
           throws java.lang.Exception
        Throws:
        java.lang.Exception
      • input

        void input​(java.lang.String area,
                   java.lang.String text)
            throws java.lang.Exception
        Throws:
        java.lang.Exception
      • cancel

        void cancel​(java.lang.String areaId)
             throws java.lang.Exception
        Throws:
        java.lang.Exception
      • clearCache

        boolean clearCache()