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

Class PatchOperation<M>

java.lang.Object

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

Direct Known Subclasses:

BitstreamRemoveOperation, BundleMoveOperation, DSpaceObjectMetadataAddOperation, DSpaceObjectMetadataCopyOperation, DSpaceObjectMetadataMoveOperation, DSpaceObjectMetadataRemoveOperation, DSpaceObjectMetadataReplaceOperation, EPersonCertificateReplaceOperation, EPersonEmailReplaceOperation, EPersonLoginReplaceOperation, EPersonNetidReplaceOperation, EPersonPasswordAddOperation, GroupNameReplaceOperation, ItemDiscoverableReplaceOperation, ItemWithdrawReplaceOperation, NotifyServiceDescriptionAddOperation, NotifyServiceDescriptionRemoveOperation, NotifyServiceDescriptionReplaceOperation, NotifyServiceEnabledReplaceOperation, NotifyServiceInboundPatternAutomaticReplaceOperation, NotifyServiceInboundPatternConstraintAddOperation, NotifyServiceInboundPatternConstraintRemoveOperation, NotifyServiceInboundPatternConstraintReplaceOperation, NotifyServiceInboundPatternPatternAddOperation, NotifyServiceInboundPatternPatternReplaceOperation, NotifyServiceInboundPatternRemoveOperation, NotifyServiceInboundPatternReplaceOperation, NotifyServiceInboundPatternsAddOperation, NotifyServiceInboundPatternsRemoveOperation, NotifyServiceInboundPatternsReplaceOperation, NotifyServiceLdnUrlReplaceOperation, NotifyServiceLowerIpReplaceOperation, NotifyServiceLowerOrUpperRemoveOperation, NotifyServiceNameOrLdnUrlRemoveOperation, NotifyServiceNameReplaceOperation, NotifyServiceScoreAddOperation, NotifyServiceScoreRemoveOperation, NotifyServiceScoreReplaceOperation, NotifyServiceUpperIpReplaceOperation, NotifyServiceUrlAddOperation, NotifyServiceUrlRemoveOperation, NotifyServiceUrlReplaceOperation, NotifyServiceUsesActorEmailIdReplaceOperation, QAEventStatusReplaceOperation, RegistrationEmailPatchOperation, ResearcherProfileAddOrcidOperation, ResearcherProfileRemoveOrcidOperation, ResearcherProfileReplaceOrcidSyncPreferencesOperation, ResearcherProfileVisibleReplaceOperation, ResourcePolicyActionAddOrReplaceOperation, ResourcePolicyDescriptionAddOperation, ResourcePolicyDescriptionRemoveOperation, ResourcePolicyDescriptionReplaceOperation, ResourcePolicyEndDateAddOperation, ResourcePolicyEndDateRemoveOperation, ResourcePolicyEndDateReplaceOperation, ResourcePolicyNameAddOperation, ResourcePolicyNameRemoveOperation, ResourcePolicyNameReplaceOperation, ResourcePolicyPolicyTypeAddOperation, ResourcePolicyPolicyTypeRemoveOperation, ResourcePolicyPolicyTypeReplaceOperation, ResourcePolicyStartDateAddOperation, ResourcePolicyStartDateRemoveOperation, ResourcePolicyStartDateReplaceOperation

public abstract class PatchOperation<M>
extends Object

Base class for all resource patch operations.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OPERATION_ADD
static final String	OPERATION_COPY
static final String	OPERATION_MOVE
static final String	OPERATION_REMOVE
static final String	OPERATION_REPLACE

Constructor Summary

Constructors

Constructor	Description
PatchOperation()

Method Summary

Modifier and Type	Method	Description
void	checkOperationValue(Object value)	Throws PatchBadRequestException for missing operation value.
protected Boolean	getBooleanOperationValue(Object value)	Allows clients to use either a boolean or a string representation of boolean value.
abstract M	perform(Context context, M resource, Operation operation)	Updates the rest model by applying the patch operation.
abstract 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 java.lang.Object

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

Field Details

OPERATION_REPLACE

public static final String OPERATION_REPLACE

See Also:

• Constant Field Values

OPERATION_ADD

public static final String OPERATION_ADD

See Also:

• Constant Field Values

OPERATION_COPY

public static final String OPERATION_COPY

See Also:

• Constant Field Values

OPERATION_MOVE

public static final String OPERATION_MOVE

See Also:

• Constant Field Values

OPERATION_REMOVE

public static final String OPERATION_REMOVE

See Also:

• Constant Field Values

Constructor Details

PatchOperation

public PatchOperation()

Method Details

perform

public abstract M perform(Context context,
 M resource,
 Operation operation)
                   throws SQLException

Updates the rest model by applying the patch operation.

Parameters:

context - context of patch operation

resource - the dso.

operation - the patch operation.

Returns:

the patched dso

Throws:

DSpaceBadRequestException

SQLException

checkOperationValue

public void checkOperationValue(Object value)

Throws PatchBadRequestException for missing operation value.

Parameters:

value - the value to test

getBooleanOperationValue

protected Boolean getBooleanOperationValue(Object value)

Allows clients to use either a boolean or a string representation of boolean value.

Parameters:

value - the operation value

Returns:

the original or derived boolean value

Throws:

DSpaceBadRequestException

supports

public abstract boolean supports(Object objectToMatch,
 Operation operation)

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

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