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

Class SherpaPolicyStep

java.lang.Object

org.dspace.app.rest.submit.AbstractProcessingStep

org.dspace.app.rest.submit.step.SherpaPolicyStep

All Implemented Interfaces:

DataProcessingStep, RestProcessingStep

public class SherpaPolicyStep
extends AbstractProcessingStep

SherpaPolicy step for DSpace Spring Rest. Expose information about the Sherpa policies for the in progress submission.

Author:

Mykhaylo Boychuk (mykhaylo.boychuk at 4science.com)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SHERPA_RETRIEVAL_TIME

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
SherpaPolicyStep()

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
SherpaPolicy	getData(SubmissionService submissionService, InProgressSubmission obj, SubmissionStepConfig config)	Method to expose data in the a dedicated section of the in progress submission.

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

Field Details

SHERPA_RETRIEVAL_TIME

public static final String SHERPA_RETRIEVAL_TIME

See Also:

• Constant Field Values

Constructor Details

SherpaPolicyStep

public SherpaPolicyStep()

Method Details

getData

public SherpaPolicy 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

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

Parameters:

context - the DSpace context

currentRequest - the http request

source - the in progress submission

op - the json patch operation

Throws:

Exception