Package org.dspace.app.rest.repository

Class CollectionRestRepository

java.lang.Object

org.dspace.app.rest.repository.AbstractDSpaceRestRepository

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

org.dspace.app.rest.repository.DSpaceObjectRestRepository<Collection,CollectionRest>

org.dspace.app.rest.repository.CollectionRestRepository

All Implemented Interfaces:

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

@Component("core.collection")
public class CollectionRestRepository
extends DSpaceObjectRestRepository<Collection,CollectionRest>

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

converter, requestService, utils

Constructor Summary

Constructors

Constructor	Description
CollectionRestRepository(CollectionService dsoService)

Method Summary

Modifier and Type	Method	Description
protected CollectionRest	createAndReturn(Context context)	Method to implement to support the creation of a new instance.
protected CollectionRest	createAndReturn(Context context, UUID id)	Method to implement to support the creation of a new instance.
TemplateItemRest	createTemplateItem(Context context, Collection collection, TemplateItemRest inputItemRest)	This method creates a new Item to be used as a template in a Collection
protected void	delete(Context context, UUID id)	Method to implement to support delete of a single object instance
org.springframework.data.domain.Page<CollectionRest>	findAll(Context context, org.springframework.data.domain.Pageable pageable)	Method to implement to support scroll of entity instances from the collection resource endpoint
org.springframework.data.domain.Page<CollectionRest>	findAuthorized(org.springframework.data.domain.Pageable pageable)
org.springframework.data.domain.Page<CollectionRest>	findAuthorizedByCommunity(UUID communityUuid, org.springframework.data.domain.Pageable pageable)
CollectionRest	findOne(Context context, UUID id)	Method to implement to support retrieval of a specific REST object instance
Class<CollectionRest>	getDomainClass()	The REST model supported by the repository
TemplateItemRest	getTemplateItem(Collection collection)	This method looks up the template Item associated with a Collection
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 CollectionRest	put(Context context, javax.servlet.http.HttpServletRequest request, String apiCategory, String model, UUID id, com.fasterxml.jackson.databind.JsonNode jsonNode)	Implement this method in the subclass to support updating a REST object.
BitstreamRest	setLogo(Context context, Collection collection, org.springframework.web.multipart.MultipartFile uploadfile)	Method to install a logo on a Collection which doesn't have a logo Called by request mappings in CollectionLogoController

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, createAndReturn, delete, deleteAll, deleteAll, deleteById, existsById, findAll, findAll, findAll, findAllById, findById, patch, put, put, put, save, save, saveAll, 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

CollectionRestRepository

public CollectionRestRepository(CollectionService dsoService)

Method Detail

findOne

@PreAuthorize("hasPermission(#id, \'COLLECTION\', \'READ\')")
public CollectionRest 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<CollectionRest,UUID>

Parameters:

context - the dspace context

id - the rest object id

Returns:

the REST object identified by its ID

findAll

public org.springframework.data.domain.Page<CollectionRest> 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 endpoint

Specified by:

findAll in class DSpaceRestRepository<CollectionRest,UUID>

Parameters:

context - the dspace context

pageable - object embedding the requested pagination info

Returns:

findAuthorizedByCommunity

public org.springframework.data.domain.Page<CollectionRest> findAuthorizedByCommunity(UUID communityUuid,
                                                                                      org.springframework.data.domain.Pageable pageable)

findAuthorized

public org.springframework.data.domain.Page<CollectionRest> findAuthorized(org.springframework.data.domain.Pageable pageable)

patch

@PreAuthorize("hasPermission(#id, \'COLLECTION\', \'WRITE\')")
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<CollectionRest,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

getDomainClass

public Class<CollectionRest> getDomainClass()

Description copied from class: DSpaceRestRepository

The REST model supported by the repository

Specified by:

getDomainClass in class DSpaceRestRepository<CollectionRest,UUID>

createAndReturn

protected CollectionRest createAndReturn(Context context)
                                  throws AuthorizeException

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<CollectionRest,UUID>

Parameters:

context - the dspace context

Returns:

the created REST object

Throws:

AuthorizeException

createAndReturn

@PreAuthorize("hasPermission(#id, \'COMMUNITY\', \'ADD\')")
protected CollectionRest createAndReturn(Context context,
                                         UUID id)
                                  throws AuthorizeException

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<CollectionRest,UUID>

Parameters:

context - the dspace context

id - The uuid of the parent object retrieved from the query param.

Returns:

the created REST object

Throws:

AuthorizeException

put

@PreAuthorize("hasPermission(#id, \'COLLECTION\', \'WRITE\')")
protected CollectionRest put(Context context,
                             javax.servlet.http.HttpServletRequest request,
                             String apiCategory,
                             String model,
                             UUID id,
                             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<CollectionRest,UUID>

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:

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

delete

@PreAuthorize("hasPermission(#id, \'COLLECTION\', \'DELETE\')")
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<CollectionRest,UUID>

Parameters:

context - the dspace context

id - the id of the rest object to delete

Throws:

AuthorizeException

setLogo

public BitstreamRest setLogo(Context context,
                             Collection collection,
                             org.springframework.web.multipart.MultipartFile uploadfile)
                      throws IOException,
                             AuthorizeException,
                             SQLException

Method to install a logo on a Collection which doesn't have a logo Called by request mappings in CollectionLogoController

Parameters:

context -

collection - The collection on which to install the logo

uploadfile - The new logo

Returns:

The created bitstream containing the new logo

Throws:

IOException

AuthorizeException

SQLException

createTemplateItem

public TemplateItemRest createTemplateItem(Context context,
                                           Collection collection,
                                           TemplateItemRest inputItemRest)
                                    throws SQLException,
                                           AuthorizeException

This method creates a new Item to be used as a template in a Collection

Parameters:

context -

collection - The collection for which to make the item

inputItemRest - The new item

Returns:

The created TemplateItem

Throws:

SQLException

AuthorizeException

getTemplateItem

public TemplateItemRest getTemplateItem(Collection collection)
                                 throws SQLException

This method looks up the template Item associated with a Collection

Parameters:

collection - The Collection for which to find the template

Returns:

The template Item from the Collection

Throws:

SQLException