Package com.emc.documentum.rest.dfc

Interface MultipartUploadManager

public interface MultipartUploadManager
The manager to handle multipart file uploads on a repository object.

  • Method Details

    • writePart

      void writePart(String objectId, String uploadId, InputStream contentStream, int partNumber, String partChecksum) throws com.documentum.fc.common.DfException
      Write a single part of a multipart upload for the given object. Each part is identified by its partNumber and streamed to the repository object under the given uploadId so that the parts can later be assembled into the complete content when the upload is completed.
      Parameters:
      objectId - the target object id the content belongs to
      uploadId - the unique upload id identifying the multipart upload this part belongs to
      contentStream - the input stream of the part content
      partNumber - the sequential number of the part being uploaded, identifying its position in the content
      partChecksum - the checksum of the part content used to verify its integrity, may be null
      Throws:
      com.documentum.fc.common.DfException - if the part content cannot be written to the repository

    • completeMultiPartUpload

      SysObject completeMultiPartUpload(String objectId, String uploadId, Boolean retainLock, String versionLabels, String fileChecksum) throws com.documentum.fc.common.DfException
      Throws:
      com.documentum.fc.common.DfException

    • abortMultiPartUpload

      void abortMultiPartUpload(String objectId, String uploadId) throws com.documentum.fc.common.DfException
      Abort an in-progress multipart upload for the given object, identified by uploadId. Any parts already written for this upload are discarded and the upload id becomes invalid for further part uploads or completion.
      Parameters:
      objectId - the target object id the multipart upload belongs to
      uploadId - the unique upload id identifying the multipart upload to abort
      Throws:
      com.documentum.fc.common.DfException - if the abort operation cannot be performed, e.g. the object or upload id does not exist, or the object is locked by another user

    • resolveMultipartUploadLinks

      List<MultipartUploadLink> resolveMultipartUploadLinks(String objectId, int partNumber, String uploadId, MediaUrlPolicy policy, String netLocId, String uploadNonce, String partChecksum, MultipartUploadLink localLink) throws com.documentum.fc.common.DfException
      Resolve the multipart upload location entries for the given object based on the requested MediaUrlPolicy, mirroring the resolution logic used for content-media links. Depending on the policy, the returned entries may include the local (REST server) upload location, one or more ACS/BOCS upload locations, or all of them.
      Parameters:
      objectId - the target object id
      partNumber - the part number
      partChecksum - the checksum of the content part to be uploaded
      uploadId - the multipart upload id previously generated for this object
      policy - the media URL policy that determines which upload locations are returned
      netLocId - the network location identifier for BOCS, may be null
      uploadNonce - the hash value for a random client token to authorize the client upload.
      localLink - the local (REST server) upload location entry
      Returns:
      the resolved list of multipart upload location entries
      Throws:
      com.documentum.fc.common.DfException - if there is an error resolving the upload locations