org.dspace.app.rest.repository

Class DSpaceObjectRestRepository<M extends DSpaceObject,R extends DSpaceObjectRest>

java.lang.Object

org.dspace.app.rest.repository.AbstractDSpaceRestRepository

org.dspace.app.rest.repository.DSpaceRestRepository<R,UUID>

org.dspace.app.rest.repository.DSpaceObjectRestRepository<M,R>

Type Parameters:

M - the specific type of DSpaceObject.

R - the corresponding DSpaceObjectRest.

All Implemented Interfaces:

org.springframework.data.repository.CrudRepository<R,UUID>, org.springframework.data.repository.PagingAndSortingRepository<R,UUID>, org.springframework.data.repository.Repository<R,UUID>

Direct Known Subclasses:

BitstreamRestRepository, CollectionRestRepository, CommunityRestRepository, EPersonRestRepository, GroupRestRepository, ItemRestRepository, SiteRestRepository

public abstract class DSpaceObjectRestRepository<M extends DSpaceObject,R extends DSpaceObjectRest>
extends DSpaceRestRepository<R,UUID>

Base class for DSpaceObject-based Rest Repositories, providing common functionality.

Field Summary

Fields inherited from class org.dspace.app.rest.repository.AbstractDSpaceRestRepository

requestService, utils

Method Summary

Modifier and Type	Method and Description
protected void	patchDSpaceObject(String apiCategory, String model, UUID id, Patch patch) Updates the DSpaceObject according to the given Patch.
protected void	updateDSpaceObject(M dso, R dsoRest) Applies the changes in the given rest DSpace object to the model DSpace object.

Methods inherited from class org.dspace.app.rest.repository.DSpaceRestRepository

action, action, count, createAndReturn, createAndReturn, createAndReturn, createAndReturn, delete, delete, delete, delete, deleteAll, exists, findAll, findAll, findAll, findAll, findAll, findOne, findOne, getDomainClass, patch, patch, put, put, put, put, save, save, save, upload, upload, upload, wrapResource

Methods inherited from class org.dspace.app.rest.repository.AbstractDSpaceRestRepository

getRequestService, obtainContext

Methods inherited from class java.lang.Object

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

Method Detail

patchDSpaceObject

protected void patchDSpaceObject(String apiCategory,
                                 String model,
                                 UUID id,
                                 Patch patch)
                          throws AuthorizeException,
                                 org.springframework.data.rest.webmvc.ResourceNotFoundException,
                                 SQLException,
                                 UnprocessableEntityException

Updates the DSpaceObject according to the given Patch.

Parameters:

apiCategory - the api category.

model - the api model.

id - the id of the DSpaceObject.

patch - the patch to apply.

Throws:

AuthorizeException - if the action is unauthorized.

org.springframework.data.rest.webmvc.ResourceNotFoundException - if the DSpace object was not found.

SQLException - if a database error occurs.

UnprocessableEntityException - if the patch attempts to modify an unmodifiable attribute of the object.

updateDSpaceObject

protected void updateDSpaceObject(M dso,
                                  R dsoRest)
                           throws AuthorizeException,
                                  SQLException

Applies the changes in the given rest DSpace object to the model DSpace object. The default implementation updates metadata if needed. Subclasses should extend to support updates of additional properties.

Parameters:

dso - the dso to apply changes to.

dsoRest - the rest representation of the new desired state.

Throws:

AuthorizeException

SQLException