org.dspace.app.rest.repository

Class DSpaceRestRepository<T extends RestAddressableModel,ID extends Serializable>

java.lang.Object

org.dspace.app.rest.repository.AbstractDSpaceRestRepository

org.dspace.app.rest.repository.DSpaceRestRepository<T,ID>

All Implemented Interfaces:

org.springframework.data.repository.CrudRepository<T,ID>, org.springframework.data.repository.PagingAndSortingRepository<T,ID>, org.springframework.data.repository.Repository<T,ID>

Direct Known Subclasses:

AuthorityRestRepository, BitstreamFormatRestRepository, BrowseIndexRestRepository, ClaimedTaskRestRepository, DSpaceObjectRestRepository, EntityTypeRestRepository, FilteredDiscoveryPageRestRepository, MetadataFieldRestRepository, MetadataSchemaRestRepository, PoolTaskRestRepository, RelationshipRestRepository, RelationshipTypeRestRepository, ResourcePolicyRestRepository, SubmissionDefinitionRestRepository, SubmissionFormRestRepository, SubmissionPanelRestRepository, SubmissionUploadRestRepository, WorkflowItemRestRepository, WorkspaceItemRestRepository

public abstract class DSpaceRestRepository<T extends RestAddressableModel,ID extends Serializable>
extends AbstractDSpaceRestRepository
implements org.springframework.data.repository.PagingAndSortingRepository<T,ID>

This is the base class for any Rest Repository. It add a DSpaceContext to the normal Spring Data Repository methods signature and assure that the repository is able to wrap a DSpace Rest Object in a HAL Resource

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

Method Summary

Modifier and Type	Method and Description
protected T	action(Context context, javax.servlet.http.HttpServletRequest request, ID id)
T	action(javax.servlet.http.HttpServletRequest request, ID id)
long	count()
T	createAndReturn() Create and return a new instance.
protected T	createAndReturn(Context context) Method to implement to support the creation of a new instance.
protected T	createAndReturn(Context context, List<String> list) Method to implement to support the creation of a new instance.
T	createAndReturn(List<String> list) Create and return a new instance.
protected void	delete(Context context, ID id) Method to implement to support delete of a single object instance
void	delete(ID id)
void	delete(Iterable<? extends T> entities)
void	delete(T entity)
void	deleteAll()
boolean	exists(ID id)
Iterable<T>	findAll()
abstract org.springframework.data.domain.Page<T>	findAll(Context context, org.springframework.data.domain.Pageable pageable) Method to implement to support scroll of entity instances from the collection resource endpoin
Iterable<T>	findAll(Iterable<ID> ids)
org.springframework.data.domain.Page<T>	findAll(org.springframework.data.domain.Pageable pageable)
Iterable<T>	findAll(org.springframework.data.domain.Sort sort)
abstract T	findOne(Context context, ID id) Method to implement to support retrieval of a specific REST object instance
T	findOne(ID id)
abstract Class<T>	getDomainClass() The REST model supported by the repository
protected void	patch(Context context, javax.servlet.http.HttpServletRequest request, String apiCategory, String model, ID id, Patch patch) Method to implement to allow partial update of the REST object via JSON Patch
T	patch(javax.servlet.http.HttpServletRequest request, String apiCategory, String model, ID id, Patch patch) Apply a partial update to the REST object via JSON Patch
protected T	put(Context context, javax.servlet.http.HttpServletRequest request, String apiCategory, String model, ID id, com.fasterxml.jackson.databind.JsonNode jsonNode) Implement this method in the subclass to support updating a REST object.
protected T	put(Context context, javax.servlet.http.HttpServletRequest request, String apiCategory, String model, ID id, List<String> stringList) Implement this method in the subclass to support updating a DSpace instance.
T	put(javax.servlet.http.HttpServletRequest request, String apiCategory, String model, ID uuid, com.fasterxml.jackson.databind.JsonNode jsonNode) This method will fully replace the REST object with the given UUID with the REST object that is described in the JsonNode parameter
T	put(javax.servlet.http.HttpServletRequest request, String apiCategory, String model, ID id, List<String> stringList) Method to support updating a DSpace instance.
protected <S extends T> S	save(Context context, S entity) Method to implement to support full update of a REST object.
<S extends T> Iterable<S>	save(Iterable<S> entities)
<S extends T> S	save(S entity)
protected Iterable<T>	upload(Context context, javax.servlet.http.HttpServletRequest request, org.springframework.web.multipart.MultipartFile uploadfile) Method to implement to support bulk creation of objects from a file
Iterable<T>	upload(javax.servlet.http.HttpServletRequest request, org.springframework.web.multipart.MultipartFile uploadfile) Bulk create object instances from an uploaded file
T	upload(javax.servlet.http.HttpServletRequest request, String apiCategory, String model, ID id, org.springframework.web.multipart.MultipartFile file) Method to implement to attach/upload a file to a specific REST object
abstract DSpaceResource<T>	wrapResource(T model, String... rels) Wrap the REST model in a REST HAL Resource

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

DSpaceRestRepository

public DSpaceRestRepository()

Method Detail

save

public <S extends T> S save(S entity)

Specified by:

save in interface org.springframework.data.repository.CrudRepository<T extends RestAddressableModel,ID extends Serializable>

save

protected <S extends T> S save(Context context,
                               S entity)
                        throws AuthorizeException,
                               RepositoryMethodNotImplementedException

Method to implement to support full update of a REST object. This is usually required by a PUT request.

Parameters:

context - the dspace context

entity - the REST object to update

Returns:

the new state of the REST object after persistence

Throws:

AuthorizeException

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

save

public <S extends T> Iterable<S> save(Iterable<S> entities)

Specified by:

save in interface org.springframework.data.repository.CrudRepository<T extends RestAddressableModel,ID extends Serializable>

findOne

public T findOne(ID id)

Specified by:

findOne in interface org.springframework.data.repository.CrudRepository<T extends RestAddressableModel,ID extends Serializable>

findOne

public abstract T findOne(Context context,
                          ID id)

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

Parameters:

context - the dspace context

id - the rest object id

Returns:

the REST object identified by its ID

exists

public boolean exists(ID id)

Specified by:

exists in interface org.springframework.data.repository.CrudRepository<T extends RestAddressableModel,ID extends Serializable>

findAll

public final Iterable<T> findAll()

Specified by:

findAll in interface org.springframework.data.repository.CrudRepository<T extends RestAddressableModel,ID extends Serializable>

findAll

public Iterable<T> findAll(Iterable<ID> ids)

Specified by:

findAll in interface org.springframework.data.repository.CrudRepository<T extends RestAddressableModel,ID extends Serializable>

count

public long count()

Specified by:

count in interface org.springframework.data.repository.CrudRepository<T extends RestAddressableModel,ID extends Serializable>

delete

public void delete(ID id)

Specified by:

delete in interface org.springframework.data.repository.CrudRepository<T extends RestAddressableModel,ID extends Serializable>

delete

protected void delete(Context context,
                      ID id)
               throws AuthorizeException,
                      RepositoryMethodNotImplementedException

Method to implement to support delete of a single object instance

Parameters:

context - the dspace context

id - the id of the rest object to delete

Throws:

AuthorizeException

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

delete

public void delete(T entity)

Specified by:

delete in interface org.springframework.data.repository.CrudRepository<T extends RestAddressableModel,ID extends Serializable>

delete

public void delete(Iterable<? extends T> entities)

Specified by:

delete in interface org.springframework.data.repository.CrudRepository<T extends RestAddressableModel,ID extends Serializable>

deleteAll

public void deleteAll()

Specified by:

deleteAll in interface org.springframework.data.repository.CrudRepository<T extends RestAddressableModel,ID extends Serializable>

findAll

public final Iterable<T> findAll(org.springframework.data.domain.Sort sort)

Specified by:

findAll in interface org.springframework.data.repository.PagingAndSortingRepository<T extends RestAddressableModel,ID extends Serializable>

findAll

public org.springframework.data.domain.Page<T> findAll(org.springframework.data.domain.Pageable pageable)

Specified by:

findAll in interface org.springframework.data.repository.PagingAndSortingRepository<T extends RestAddressableModel,ID extends Serializable>

findAll

public abstract org.springframework.data.domain.Page<T> findAll(Context context,
                                                                org.springframework.data.domain.Pageable pageable)

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

Parameters:

context - the dspace context

pageable - object embedding the requested pagination info

Returns:

getDomainClass

public abstract Class<T> getDomainClass()

The REST model supported by the repository

wrapResource

public abstract DSpaceResource<T> wrapResource(T model,
                                               String... rels)

Wrap the REST model in a REST HAL Resource

Parameters:

model - the rest model instance

rels - the HAL links

Returns:

the REST Resource

createAndReturn

public T createAndReturn(List<String> list)

Create and return a new instance. Data is recovered from the thread bound HTTP request and the list of DSpaceObjects provided in the uri-list body

Parameters:

list - The list of Strings to be used in the createAndReturn method

Returns:

The created REST object

createAndReturn

public T createAndReturn()

Create and return a new instance. Data are usually retrieved from the thread bound http request

Returns:

the created REST object

createAndReturn

protected T createAndReturn(Context context,
                            List<String> list)
                     throws AuthorizeException,
                            SQLException,
                            RepositoryMethodNotImplementedException

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

Parameters:

context - the dspace context

list - The list of Strings that will be used as data for the object that's to be created This list is retrieved from the uri-list body

Returns:

the created REST object

Throws:

AuthorizeException

SQLException

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

createAndReturn

protected T createAndReturn(Context context)
                     throws AuthorizeException,
                            SQLException,
                            RepositoryMethodNotImplementedException

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

Parameters:

context - the dspace context

Returns:

the created REST object

Throws:

AuthorizeException

SQLException

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

upload

public T upload(javax.servlet.http.HttpServletRequest request,
                String apiCategory,
                String model,
                ID id,
                org.springframework.web.multipart.MultipartFile file)
         throws Exception

Method to implement to attach/upload a file to a specific REST object

Parameters:

request - the http request

apiCategory -

model -

id - the ID of the target REST object

file - the uploaded file

Returns:

the new state of the REST object

Throws:

Exception

patch

public T patch(javax.servlet.http.HttpServletRequest request,
               String apiCategory,
               String model,
               ID id,
               Patch patch)
        throws org.springframework.web.HttpRequestMethodNotSupportedException,
               UnprocessableEntityException,
               PatchBadRequestException

Apply a partial update to the REST object via JSON Patch

Parameters:

request - the http request

apiCategory -

model -

id - the ID of the target REST object

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

Returns:

Throws:

org.springframework.web.HttpRequestMethodNotSupportedException

UnprocessableEntityException

PatchBadRequestException

patch

protected void patch(Context context,
                     javax.servlet.http.HttpServletRequest request,
                     String apiCategory,
                     String model,
                     ID id,
                     Patch patch)
              throws RepositoryMethodNotImplementedException,
                     SQLException,
                     AuthorizeException,
                     DCInputsReaderException

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

Parameters:

request - the http request

apiCategory -

model -

id - the ID of the target REST object

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

Throws:

org.springframework.web.HttpRequestMethodNotSupportedException

UnprocessableEntityException

PatchBadRequestException

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

SQLException

AuthorizeException

DCInputsReaderException

action

public T action(javax.servlet.http.HttpServletRequest request,
                ID id)
         throws SQLException,
                IOException

Throws:

SQLException

IOException

action

protected T action(Context context,
                   javax.servlet.http.HttpServletRequest request,
                   ID id)
            throws SQLException,
                   IOException

Throws:

SQLException

IOException

upload

public Iterable<T> upload(javax.servlet.http.HttpServletRequest request,
                          org.springframework.web.multipart.MultipartFile uploadfile)
                   throws SQLException,
                          FileNotFoundException,
                          IOException,
                          AuthorizeException

Bulk create object instances from an uploaded file

Parameters:

request - the http request

uploadfile - the file to process

Returns:

the created objects

Throws:

SQLException

FileNotFoundException

IOException

AuthorizeException

upload

protected Iterable<T> upload(Context context,
                             javax.servlet.http.HttpServletRequest request,
                             org.springframework.web.multipart.MultipartFile uploadfile)
                      throws SQLException,
                             FileNotFoundException,
                             IOException,
                             AuthorizeException

Method to implement to support bulk creation of objects from a file

Parameters:

request - the http request

uploadfile - the file to process

Returns:

the created objects

Throws:

SQLException

FileNotFoundException

IOException

AuthorizeException

RepositoryMethodNotImplementedException

put

public T put(javax.servlet.http.HttpServletRequest request,
             String apiCategory,
             String model,
             ID uuid,
             com.fasterxml.jackson.databind.JsonNode jsonNode)

This method will fully replace the REST object with the given UUID with the REST object that is described in the JsonNode parameter

Parameters:

request - the http request

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

put

public T put(javax.servlet.http.HttpServletRequest request,
             String apiCategory,
             String model,
             ID id,
             List<String> stringList)

Method to support updating a DSpace instance.

Parameters:

request - the http request

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

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

id - the ID of the target REST object

stringList - The list of Strings that will be used as data for the put

Returns:

the updated REST object

put

protected T put(Context context,
                javax.servlet.http.HttpServletRequest request,
                String apiCategory,
                String model,
                ID id,
                com.fasterxml.jackson.databind.JsonNode jsonNode)
         throws RepositoryMethodNotImplementedException,
                SQLException,
                AuthorizeException

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

Parameters:

context - the dspace context

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

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

id - 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:

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

SQLException - when the database returns an error

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

put

protected T put(Context context,
                javax.servlet.http.HttpServletRequest request,
                String apiCategory,
                String model,
                ID id,
                List<String> stringList)
         throws RepositoryMethodNotImplementedException,
                SQLException,
                AuthorizeException

Implement this method in the subclass to support updating a DSpace instance.

Parameters:

context - the dspace context

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

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

id - the ID of the target REST object

stringList - The list of Strings that will be used as data for the put

Returns:

the updated REST object

Throws:

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

SQLException - when the database returns an error

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