org.dspace.app.rest.submit

Interface AbstractRestProcessingStep

All Superinterfaces:

ListenerProcessingStep

All Known Implementing Classes:

CollectionStep, DescribeStep, LicenseStep, UploadStep

public interface AbstractRestProcessingStep
extends ListenerProcessingStep

Interface for the submission steps to populate sections in the in progress submission and react to patch requests.

Author:

Luigi Andrea Pascarelli (luigiandrea.pascarelli at 4science.it), Andrea Bollini (andrea.bollini at 4science.it)

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLLECTION_STEP_OPERATION_ENTRY
static String	DESCRIBE_STEP_METADATA_OPERATION_ENTRY
static String	LICENSE_STEP_OPERATION_ENTRY
static String	UPLOAD_STEP_ACCESSCONDITIONS_OPERATION_ENTRY
static String	UPLOAD_STEP_METADATA_OPERATION_ENTRY
static String	UPLOAD_STEP_METADATA_PATH
static String	UPLOAD_STEP_MOVE_OPERATION_ENTRY
static String	UPLOAD_STEP_REMOVE_OPERATION_ENTRY

Method Summary

Modifier and Type	Method and Description
void	doPatchProcessing(Context context, Request currentRequest, InProgressSubmission source, Operation op) Method to react to a patch request against the step managed section data
<T extends Serializable> T	getData(SubmissionService submissionService, InProgressSubmission obj, SubmissionStepConfig config) Method to expose data in the a dedicated section of the in progress submission.
default List<ErrorRest>	validate(SubmissionService submissionService, InProgressSubmission obj, SubmissionStepConfig config) The method will expose the list of validation errors identified by the step.

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

doPostProcessing, doPreProcessing

Field Detail

DESCRIBE_STEP_METADATA_OPERATION_ENTRY

static final String DESCRIBE_STEP_METADATA_OPERATION_ENTRY

See Also:

Constant Field Values

COLLECTION_STEP_OPERATION_ENTRY

static final String COLLECTION_STEP_OPERATION_ENTRY

See Also:

Constant Field Values

UPLOAD_STEP_METADATA_OPERATION_ENTRY

static final String UPLOAD_STEP_METADATA_OPERATION_ENTRY

See Also:

Constant Field Values

UPLOAD_STEP_REMOVE_OPERATION_ENTRY

static final String UPLOAD_STEP_REMOVE_OPERATION_ENTRY

See Also:

Constant Field Values

UPLOAD_STEP_MOVE_OPERATION_ENTRY

static final String UPLOAD_STEP_MOVE_OPERATION_ENTRY

See Also:

Constant Field Values

UPLOAD_STEP_ACCESSCONDITIONS_OPERATION_ENTRY

static final String UPLOAD_STEP_ACCESSCONDITIONS_OPERATION_ENTRY

See Also:

Constant Field Values

LICENSE_STEP_OPERATION_ENTRY

static final String LICENSE_STEP_OPERATION_ENTRY

See Also:

Constant Field Values

UPLOAD_STEP_METADATA_PATH

static final String UPLOAD_STEP_METADATA_PATH

See Also:

Constant Field Values

Method Detail

getData

<T extends Serializable> T getData(SubmissionService submissionService,
                                   InProgressSubmission obj,
                                   SubmissionStepConfig config)
                            throws Exception

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

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

validate

default List<ErrorRest> validate(SubmissionService submissionService,
                                 InProgressSubmission obj,
                                 SubmissionStepConfig config)
                          throws Exception

The method will expose the list of validation errors identified by the step. The default implementation will found a Validation spring bean in the context with the same name that the step id

Parameters:

submissionService -

obj -

config -

Returns:

Throws:

Exception

doPatchProcessing

void doPatchProcessing(Context context,
                       Request currentRequest,
                       InProgressSubmission source,
                       Operation op)
                throws Exception

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

Parameters:

context - the DSpace context

currentRequest - the http request

source - the in progress submission

op - the json patch operation

Throws:

Exception