Package org.dspace.app.rest.submit

Interface UploadableStep

  • All Superinterfaces:
    RestProcessingStep
    All Known Implementing Classes:
    ExtractMetadataStep, UploadStep
    public interface UploadableStep
extends RestProcessingStep
    The interface for submission Steps that need to deal with file upload
    Author:
    Luigi Andrea Pascarelli (luigiandrea.pascarelli at 4science.it), Andrea Bollini (andrea.bollini at 4science.it)

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ErrorRest upload​(org.dspace.core.Context context, SubmissionService submissionService, org.dspace.app.util.SubmissionStepConfig stepConfig, org.dspace.content.InProgressSubmission wsi, org.springframework.web.multipart.MultipartFile file)
      The method to implement to support upload of a file in the submission section (aka panel / step)

    • Method Detail

      • upload

        ErrorRest upload​(org.dspace.core.Context context,
                 SubmissionService submissionService,
                 org.dspace.app.util.SubmissionStepConfig stepConfig,
                 org.dspace.content.InProgressSubmission wsi,
                 org.springframework.web.multipart.MultipartFile file)
          throws IOException
        The method to implement to support upload of a file in the submission section (aka panel / step)
        Parameters:
        context - the dspace context
        submissionService - the submission service
        stepConfig - the configuration of the submission section
        wsi - the inprogress submission
        file - the multipart file, please note that it is a complex object containing additional information other than just the binary such as the filename and the mimetype
        Returns:
        the encountered error if any
        Throws:
        IOException