Package org.dspace.app.rest.submit.step

Class UploadStep

java.lang.Object

org.dspace.app.rest.submit.AbstractProcessingStep

org.dspace.app.rest.submit.step.UploadStep

All Implemented Interfaces:

DataProcessingStep, RestProcessingStep, UploadableStep

public class UploadStep
extends AbstractProcessingStep
implements UploadableStep

Upload step for DSpace Spring Rest. Expose information about the bitstream uploaded for the in progress submission.

Author:

Luigi Andrea Pascarelli (luigiandrea.pascarelli at 4science.it)

Field Summary

Fields inherited from class org.dspace.app.rest.submit.AbstractProcessingStep

authorizeService, bitstreamFormatService, bitstreamService, bundleService, coarNotifySubmissionService, collectionService, configurationService, itemService, metadataFieldService, workspaceItemService

Fields inherited from interface org.dspace.app.rest.submit.DataProcessingStep

ACCESS_CONDITION_POLICY_STEP_OPERATION_ENTRY, ACCESS_CONDITION_STEP_OPERATION_ENTRY, CCLICENSE_STEP_OPERATION_ENTRY, COARNOTIFY_STEP_PATH, COLLECTION_STEP_OPERATION_ENTRY, DESCRIBE_STEP_METADATA_OPERATION_ENTRY, LICENSE_STEP_OPERATION_ENTRY, PRIMARY_FLAG_ENTRY, SHOW_IDENTIFIERS_ENTRY, UPLOAD_STEP_ACCESSCONDITIONS_OPERATION_ENTRY, UPLOAD_STEP_METADATA_OPERATION_ENTRY, UPLOAD_STEP_METADATA_PATH, UPLOAD_STEP_MOVE_OPERATION_ENTRY, UPLOAD_STEP_REMOVE_OPERATION_ENTRY

Constructor Summary

Constructors

Constructor	Description
UploadStep()

Method Summary

Modifier and Type	Method	Description
void	doPatchProcessing(Context context, jakarta.servlet.http.HttpServletRequest currentRequest, InProgressSubmission source, Operation op, SubmissionStepConfig stepConf)	Method to react to a patch request against the step managed section data
DataUpload	getData(SubmissionService submissionService, InProgressSubmission obj, SubmissionStepConfig config)	Method to expose data in the a dedicated section of the in progress submission.
ErrorRest	upload(Context context, SubmissionService submissionService, SubmissionStepConfig stepConfig, InProgressSubmission wsi, MultipartFile file)	The method to implement to support upload of a file in the submission section (aka panel / step)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dspace.app.rest.submit.DataProcessingStep

validate

Constructor Details

UploadStep

public UploadStep()

Method Details

getData

public DataUpload getData(SubmissionService submissionService,
 InProgressSubmission obj,
 SubmissionStepConfig config)
                   throws Exception

Description copied from interface: DataProcessingStep

Method to expose data in the a dedicated section of the in progress submission. The step needs to return a serializable object that will be included in a section with the name (id) assigned to the step in the item-submission.xml file

Specified by:

getData in interface DataProcessingStep

Parameters:

submissionService - the submission service

obj - the in progress submission

config - the submission step configuration

Returns:

the serializable object to include in the step generated section

Throws:

Exception

doPatchProcessing

public void doPatchProcessing(Context context,
 jakarta.servlet.http.HttpServletRequest currentRequest,
 InProgressSubmission source,
 Operation op,
 SubmissionStepConfig stepConf)
                       throws Exception

Description copied from interface: DataProcessingStep

Method to react to a patch request against the step managed section data

Specified by:

doPatchProcessing in interface DataProcessingStep

Parameters:

context - the DSpace context

currentRequest - the http request

source - the in progress submission

op - the json patch operation

Throws:

Exception

upload

public ErrorRest upload(Context context,
 SubmissionService submissionService,
 SubmissionStepConfig stepConfig,
 InProgressSubmission wsi,
 MultipartFile file)

Description copied from interface: UploadableStep

The method to implement to support upload of a file in the submission section (aka panel / step)

Specified by:

upload in interface UploadableStep

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