Package org.dspace.app.rest.repository

Class RequestItemRepository

java.lang.Object

org.dspace.app.rest.repository.AbstractDSpaceRestRepository

org.dspace.app.rest.repository.DSpaceRestRepository<RequestItemRest,String>

org.dspace.app.rest.repository.RequestItemRepository

All Implemented Interfaces:

Aware, BeanNameAware, org.springframework.data.repository.CrudRepository<RequestItemRest,String>, org.springframework.data.repository.PagingAndSortingRepository<RequestItemRest,String>, org.springframework.data.repository.Repository<RequestItemRest,String>

@Component("tools.itemrequests")
public class RequestItemRepository
extends DSpaceRestRepository<RequestItemRest,String>

Component to expose item requests and handle operations like create (request), put (grant/deny), and email sending. Support for requested item access by a secure token / link is supported as well as the legacy "attach files to email" method. See dspace.cfg for configuration.

Author:

Mark H. Wood <mwood@iupui.edu>, Kim Shepherd

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthorizeService	authorizeService
protected BitstreamService	bitstreamService
protected ConfigurationService	configurationService
protected ItemService	itemService
protected RequestItemConverter	requestItemConverter
protected RequestItemEmailNotifier	requestItemEmailNotifier
protected RequestItemService	requestItemService

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

converter, requestService, utils

Constructor Summary

Constructors

Constructor	Description
RequestItemRepository()

Method Summary

Modifier and Type	Method	Description
RequestItemRest	createAndReturn(Context ctx)	Method to implement to support the creation of a new instance.
void	delete(Context context, String token)	Method to implement to support delete of a single object instance
org.springframework.data.domain.Page<RequestItemRest>	findAll(Context context, org.springframework.data.domain.Pageable pageable)	Method to implement to support scroll of entity instances from the collection resource endpoint
RequestItemRest	findByAccessToken(String accessToken)
RequestItemRest	findOne(Context context, String token)	Method to implement to support retrieval of a specific REST object instance
Class<RequestItemRest>	getDomainClass()	The REST model supported by the repository
RequestItemRest	put(Context context, jakarta.servlet.http.HttpServletRequest request, String apiCategory, String model, String token, com.fasterxml.jackson.databind.JsonNode requestBody)	Implement this method in the subclass to support updating a REST object.

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

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

Field Details

requestItemService

@Autowired(required=true)
protected RequestItemService requestItemService

bitstreamService

@Autowired(required=true)
protected BitstreamService bitstreamService

itemService

@Autowired(required=true)
protected ItemService itemService

requestItemConverter

@Autowired(required=true)
protected RequestItemConverter requestItemConverter

configurationService

@Autowired(required=true)
protected ConfigurationService configurationService

requestItemEmailNotifier

@Autowired(required=true)
protected RequestItemEmailNotifier requestItemEmailNotifier

authorizeService

@Autowired
protected AuthorizeService authorizeService

Constructor Details

RequestItemRepository

public RequestItemRepository()

Method Details

findOne

@PreAuthorize("permitAll()")
public RequestItemRest findOne(Context context,
 String token)

Description copied from class: DSpaceRestRepository

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

Specified by:

findOne in class DSpaceRestRepository<RequestItemRest,String>

Parameters:

context - the dspace context

token - the rest object id

Returns:

the REST object identified by its ID

findAll

public org.springframework.data.domain.Page<RequestItemRest> 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<RequestItemRest,String>

Parameters:

context - the dspace context

pageable - object embedding the requested pagination info

Returns:

createAndReturn

@PreAuthorize("permitAll()")
public RequestItemRest createAndReturn(Context ctx)
                                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<RequestItemRest,String>

Parameters:

ctx - the dspace context

Returns:

the created REST object

Throws:

AuthorizeException

SQLException

delete

public void delete(Context context,
 String token)
            throws AuthorizeException,
RepositoryMethodNotImplementedException

Description copied from class: DSpaceRestRepository

Method to implement to support delete of a single object instance

Overrides:

delete in class DSpaceRestRepository<RequestItemRest,String>

Parameters:

context - the dspace context

token - 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

put

@PreAuthorize("permitAll()")
public RequestItemRest put(Context context,
 jakarta.servlet.http.HttpServletRequest request,
 String apiCategory,
 String model,
 String token,
 com.fasterxml.jackson.databind.JsonNode requestBody)
                    throws AuthorizeException

Description copied from class: DSpaceRestRepository

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

Overrides:

put in class DSpaceRestRepository<RequestItemRest,String>

Parameters:

context - the dspace context

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

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

token - the ID of the target REST object

requestBody - 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

findByAccessToken

@PreAuthorize("permitAll()")
public RequestItemRest findByAccessToken(String accessToken)

Parameters:

accessToken -

Returns:

getDomainClass

public Class<RequestItemRest> getDomainClass()

Description copied from class: DSpaceRestRepository

The REST model supported by the repository

Specified by:

getDomainClass in class DSpaceRestRepository<RequestItemRest,String>