Package org.alfresco.service.cmr.transfer

Interface TransferReceiver

  • All Known Implementing Classes:
    RepoTransferReceiverImpl
    public interface TransferReceiver
    Author:
    brian The server side Transfer Receiver.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void cancel​(java.lang.String transferId)
      Abort
      void commit​(java.lang.String transferId)
      Commit
      void commitAsync​(java.lang.String transferId)
      Commit asynchronously
      void end​(java.lang.String transferId)
      Asks the receiver to end (and clean up) the specified transfer
      void generateRequsite​(java.lang.String transferId, java.io.OutputStream requsiteStream)
      Write the requsite (the bits required to support the Manifest) to the output stream.
      TransferProgressMonitor getProgressMonitor()  
      java.io.File getStagingFolder​(java.lang.String transferId)  
      TransferProgress getStatus​(java.lang.String transferId)  
      org.alfresco.service.cmr.repository.NodeRef getTempFolder​(java.lang.String transferId)  
      java.io.InputStream getTransferReport​(java.lang.String transferId)
      get the transfer report for the specified transfer
      TransferVersion getVersion()
      Get the version that we are transfering to.
      void prepare​(java.lang.String transferId)
      Prepare
      void saveContent​(java.lang.String transferId, java.lang.String contentId, java.io.InputStream contentStream)
      Save a content item
      void saveSnapshot​(java.lang.String transferId, java.io.InputStream snapshotStream)
      Store the specified snapshot file into the transfer staging area.
      void setTransferRootNode​(java.lang.String rootFileSystem)
      set the root node for the file system receiver
      java.lang.String start​(java.lang.String fromRepositoryId, boolean allowTransferToSelf, TransferVersion fromVersion)
      Asks the receiver to setup a new transfer.

    • Method Detail

      • getStagingFolder

        java.io.File getStagingFolder​(java.lang.String transferId)
        Parameters:
        transferId - String
        Returns:
        File

      • getTempFolder

        org.alfresco.service.cmr.repository.NodeRef getTempFolder​(java.lang.String transferId)
        Parameters:
        transferId - String
        Returns:
        NodeRef

      • start

        java.lang.String start​(java.lang.String fromRepositoryId,
                       boolean allowTransferToSelf,
                       TransferVersion fromVersion)
                throws TransferException
        Asks the receiver to setup a new transfer.
        Parameters:
        fromRepositoryId - the repositoryId of the sending system
        allowTransferToSelf - are transfers to the same repository allowed?
        fromVersion - the version sending
        Returns:
        The identifier of the new transfer
        Throws:
        TransferException - if an error occurred while setting up the transfer

      • end

        void end​(java.lang.String transferId)
  throws TransferException
        Asks the receiver to end (and clean up) the specified transfer
        Parameters:
        transferId - The transfer to end
        Throws:
        TransferException - If the process of ending the transfer fails

      • saveSnapshot

        void saveSnapshot​(java.lang.String transferId,
                  java.io.InputStream snapshotStream)
           throws TransferException
        Store the specified snapshot file into the transfer staging area. The specified transfer must currently be the holder of the transfer lock, otherwise an exception is thrown. This operation does not close the supplied stream, so the caller must do it as appropriate. The caller should assume that the supplied stream has been fully read when this operation returns.
        Parameters:
        transferId - The identifier of the transfer with which this snapshot is associated
        snapshotStream - The open stream that holds the snapshot file.
        Throws:
        TransferException - If an error occurs while saving the snapshot file.

      • saveContent

        void saveContent​(java.lang.String transferId,
                 java.lang.String contentId,
                 java.io.InputStream contentStream)
          throws TransferException
        Save a content item
        Parameters:
        transferId - String
        contentId - String
        contentStream - InputStream
        Throws:
        TransferException

      • generateRequsite

        void generateRequsite​(java.lang.String transferId,
                      java.io.OutputStream requsiteStream)
               throws TransferException
        Write the requsite (the bits required to support the Manifest) to the output stream.
        Parameters:
        requsiteStream - an open stream to receive the requisite
        Throws:
        TransferException

      • getVersion

        TransferVersion getVersion()
        Get the version that we are transfering to.

      • getTransferReport

        java.io.InputStream getTransferReport​(java.lang.String transferId)
        get the transfer report for the specified transfer
        Parameters:
        transferId - String

      • setTransferRootNode

        void setTransferRootNode​(java.lang.String rootFileSystem)
        set the root node for the file system receiver
        Parameters:
        rootFileSystem - String