org.dspace.app.rest.repository

Class ItemRestRepository

java.lang.Object

org.dspace.app.rest.repository.AbstractDSpaceRestRepository

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

org.dspace.app.rest.repository.DSpaceObjectRestRepository<Item,ItemRest>

org.dspace.app.rest.repository.ItemRestRepository

All Implemented Interfaces:

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

@Component(value="core.item")
public class ItemRestRepository
extends DSpaceObjectRestRepository<Item,ItemRest>

This is the repository responsible to manage Item Rest object

Author:

Andrea Bollini (andrea.bollini at 4science.it)

Field Summary

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

requestService, utils

Constructor Summary

Constructors

Constructor and Description
ItemRestRepository(ItemService dsoService, ItemConverter dsoConverter, ItemPatch dsoPatch)

Method Summary

Modifier and Type	Method and Description
protected ItemRest	createAndReturn(Context context) Method to implement to support the creation of a new instance.
protected void	delete(Context context, UUID id) Method to implement to support delete of a single object instance
org.springframework.data.domain.Page<ItemRest>	findAll(Context context, org.springframework.data.domain.Pageable pageable) Method to implement to support scroll of entity instances from the collection resource endpoin
ItemRest	findOne(Context context, UUID id) Method to implement to support retrieval of a specific REST object instance
Class<ItemRest>	getDomainClass() The REST model supported by the repository
protected void	patch(Context context, javax.servlet.http.HttpServletRequest request, String apiCategory, String model, UUID id, Patch patch) Method to implement to allow partial update of the REST object via JSON Patch
protected ItemRest	put(Context context, javax.servlet.http.HttpServletRequest request, String apiCategory, String model, UUID uuid, com.fasterxml.jackson.databind.JsonNode jsonNode) Implement this method in the subclass to support updating a REST object.
protected void	updateDSpaceObject(Item item, ItemRest itemRest) Applies the changes in the given rest DSpace object to the model DSpace object.
ItemResource	wrapResource(ItemRest item, String... rels) Wrap the REST model in a REST HAL Resource

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

patchDSpaceObject

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

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

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

Constructor Detail

ItemRestRepository

public ItemRestRepository(ItemService dsoService,
                          ItemConverter dsoConverter,
                          ItemPatch dsoPatch)

Method Detail

findOne

@PreAuthorize(value="hasPermission(#id, \'ITEM\', \'READ\')")
public ItemRest findOne(Context context,
                                                                                       UUID id)

Description copied from class: DSpaceRestRepository

Method to implement to support retrieval of a specific REST object instance

Specified by:

findOne in class DSpaceRestRepository<ItemRest,UUID>

Parameters:

context - the dspace context

id - the rest object id

Returns:

the REST object identified by its ID

findAll

@PreAuthorize(value="hasAuthority(\'ADMIN\')")
public org.springframework.data.domain.Page<ItemRest> findAll(Context context,
                                                                                                              org.springframework.data.domain.Pageable pageable)

Description copied from class: DSpaceRestRepository

Method to implement to support scroll of entity instances from the collection resource endpoin

Specified by:

findAll in class DSpaceRestRepository<ItemRest,UUID>

Parameters:

context - the dspace context

pageable - object embedding the requested pagination info

Returns:

patch

@PreAuthorize(value="hasPermission(#id, \'ITEM\', #patch)")
protected void patch(Context context,
                                                                                  javax.servlet.http.HttpServletRequest request,
                                                                                  String apiCategory,
                                                                                  String model,
                                                                                  UUID id,
                                                                                  Patch patch)
                                                                           throws AuthorizeException,
                                                                                  SQLException

Description copied from class: DSpaceRestRepository

Method to implement to allow partial update of the REST object via JSON Patch

Overrides:

patch in class DSpaceRestRepository<ItemRest,UUID>

request - the http request

id - the ID of the target REST object

patch - the JSON Patch (https://tools.ietf.org/html/rfc6902) operation

Throws:

AuthorizeException

SQLException

updateDSpaceObject

protected void updateDSpaceObject(Item item,
                                  ItemRest itemRest)
                           throws AuthorizeException,
                                  SQLException

Description copied from class: DSpaceObjectRestRepository

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.

Overrides:

updateDSpaceObject in class DSpaceObjectRestRepository<Item,ItemRest>

Parameters:

item - the dso to apply changes to.

itemRest - the rest representation of the new desired state.

Throws:

AuthorizeException

SQLException

getDomainClass

public Class<ItemRest> getDomainClass()

Description copied from class: DSpaceRestRepository

The REST model supported by the repository

Specified by:

getDomainClass in class DSpaceRestRepository<ItemRest,UUID>

wrapResource

public ItemResource wrapResource(ItemRest item,
                                 String... rels)

Description copied from class: DSpaceRestRepository

Wrap the REST model in a REST HAL Resource

Specified by:

wrapResource in class DSpaceRestRepository<ItemRest,UUID>

Parameters:

item - the rest model instance

rels - the HAL links

Returns:

the REST Resource

delete

@PreAuthorize(value="hasAuthority(\'ADMIN\')")
protected void delete(Context context,
                                                                      UUID id)
                                                               throws AuthorizeException

Description copied from class: DSpaceRestRepository

Method to implement to support delete of a single object instance

Overrides:

delete in class DSpaceRestRepository<ItemRest,UUID>

Parameters:

context - the dspace context

id - the id of the rest object to delete

Throws:

AuthorizeException

createAndReturn

@PreAuthorize(value="hasAuthority(\'ADMIN\')")
protected ItemRest createAndReturn(Context context)
                                                                            throws AuthorizeException,
                                                                                   SQLException

Description copied from class: DSpaceRestRepository

Method to implement to support the creation of a new instance. Usually require to retrieve the http request from the thread bound attribute

Overrides:

createAndReturn in class DSpaceRestRepository<ItemRest,UUID>

Parameters:

context - the dspace context

Returns:

the created REST object

Throws:

AuthorizeException

SQLException

put

@PreAuthorize(value="hasPermission(#id, \'ITEM\', \'WRITE\')")
protected ItemRest put(Context context,
                                                                                       javax.servlet.http.HttpServletRequest request,
                                                                                       String apiCategory,
                                                                                       String model,
                                                                                       UUID uuid,
                                                                                       com.fasterxml.jackson.databind.JsonNode jsonNode)
                                                                                throws RepositoryMethodNotImplementedException,
                                                                                       SQLException,
                                                                                       AuthorizeException

Description copied from class: DSpaceRestRepository

Implement this method in the subclass to support updating a REST object.

Overrides:

put in class DSpaceRestRepository<ItemRest,UUID>

Parameters:

context - the dspace context

apiCategory - the API category e.g. "api"

model - the DSpace model e.g. "metadatafield"

uuid - the ID of the target REST object

jsonNode - the part of the request body representing the updated rest object

Returns:

the updated REST object

Throws:

RepositoryMethodNotImplementedException - returned by the default implementation when the operation is not supported for the entity

SQLException - when the database returns an error

AuthorizeException - if the context user is not authorized to perform this operation