Package org.dspace.app.rest.repository.patch.operation

Class ResearcherProfileAddOrcidOperation

java.lang.Object

org.dspace.app.rest.repository.patch.operation.PatchOperation<ResearcherProfile>

org.dspace.app.rest.repository.patch.operation.ResearcherProfileAddOrcidOperation

@Component
public class ResearcherProfileAddOrcidOperation
extends PatchOperation<ResearcherProfile>

Implementation of the PATCH operation used to establish the ORCID connection. Example:
curl -X PATCH http://${dspace.server.url}/api/eperson/profiles/<:id-eperson> -H " Content-Type: application/json" -d '[{ "op": "add", "path": "/orcid", value: "code" }]'
The value to be provided is the authorization code for an ORCID iD and 3-legged access token.

Field Summary

Fields inherited from class org.dspace.app.rest.repository.patch.operation.PatchOperation

OPERATION_ADD, OPERATION_COPY, OPERATION_MOVE, OPERATION_REMOVE, OPERATION_REPLACE

Constructor Summary

Constructors

Constructor	Description
ResearcherProfileAddOrcidOperation()

Method Summary

Modifier and Type	Method	Description
ResearcherProfile	perform(Context context, ResearcherProfile profile, Operation operation)	Updates the rest model by applying the patch operation.
void	setOrcidClient(OrcidClient orcidClient)
boolean	supports(Object objectToMatch, Operation operation)	Determines whether or not this Patch Operation can do this patch (Object of operation and path gets checked)

Methods inherited from class org.dspace.app.rest.repository.patch.operation.PatchOperation

checkOperationValue, getBooleanOperationValue

Methods inherited from class java.lang.Object

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

Constructor Details

ResearcherProfileAddOrcidOperation

public ResearcherProfileAddOrcidOperation()

Method Details

perform

public ResearcherProfile perform(Context context,
 ResearcherProfile profile,
 Operation operation)
                          throws SQLException

Description copied from class: PatchOperation

Updates the rest model by applying the patch operation.

Specified by:

perform in class PatchOperation<ResearcherProfile>

Parameters:

context - context of patch operation

profile - the dso.

operation - the patch operation.

Returns:

the patched dso

Throws:

SQLException

supports

public boolean supports(Object objectToMatch,
 Operation operation)

Description copied from class: PatchOperation

Determines whether or not this Patch Operation can do this patch (Object of operation and path gets checked)

Specified by:

supports in class PatchOperation<ResearcherProfile>

Parameters:

objectToMatch - Object whose class must be instance of type object for which this PatchOperation was created

operation - Operation of the patch, should match this type of Patch Operation

Returns:

True if this PatchOperation class can do the patch for this given dso type and Path

setOrcidClient

public void setOrcidClient(OrcidClient orcidClient)