org.dspace.app.rest.repository

Class WorkspaceItemRestRepository

java.lang.Object

org.dspace.app.rest.repository.AbstractDSpaceRestRepository

org.dspace.app.rest.repository.DSpaceRestRepository<WorkspaceItemRest,Integer>

org.dspace.app.rest.repository.WorkspaceItemRestRepository

All Implemented Interfaces:

org.springframework.data.repository.CrudRepository<WorkspaceItemRest,Integer>, org.springframework.data.repository.PagingAndSortingRepository<WorkspaceItemRest,Integer>, org.springframework.data.repository.Repository<WorkspaceItemRest,Integer>

@Component(value="submission.workspaceitem")
public class WorkspaceItemRestRepository
extends DSpaceRestRepository<WorkspaceItemRest,Integer>

This is the repository responsible to manage WorkspaceItem Rest object

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_PATH_SECTIONS

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

requestService, utils

Constructor Summary

Constructors

Constructor and Description
WorkspaceItemRestRepository()

Method Summary

Modifier and Type	Method and Description
protected WorkspaceItemRest	createAndReturn(Context context) Method to implement to support the creation of a new instance.
protected void	delete(Context context, Integer id) Method to implement to support delete of a single object instance
org.springframework.data.domain.Page<WorkspaceItemRest>	findAll(Context context, org.springframework.data.domain.Pageable pageable) Method to implement to support scroll of entity instances from the collection resource endpoin
org.springframework.data.domain.Page<WorkspaceItemRest>	findBySubmitter(UUID submitterID, org.springframework.data.domain.Pageable pageable)
WorkspaceItemRest	findOne(Context context, Integer id) Method to implement to support retrieval of a specific REST object instance
Class<WorkspaceItemRest>	getDomainClass() The REST model supported by the repository
void	patch(Context context, javax.servlet.http.HttpServletRequest request, String apiCategory, String model, Integer id, Patch patch) Method to implement to allow partial update of the REST object via JSON Patch
protected WorkspaceItemRest	save(Context context, WorkspaceItemRest wsi) Method to implement to support full update of a REST object.
Iterable<WorkspaceItemRest>	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
WorkspaceItemRest	upload(javax.servlet.http.HttpServletRequest request, String apiCategory, String model, Integer id, org.springframework.web.multipart.MultipartFile file) Method to implement to attach/upload a file to a specific REST object
WorkspaceItemResource	wrapResource(WorkspaceItemRest witem, String... rels) Wrap the REST model in a REST HAL Resource

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, put, save, save, 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 Detail

OPERATION_PATH_SECTIONS

public static final String OPERATION_PATH_SECTIONS

See Also:

Constant Field Values

Constructor Detail

WorkspaceItemRestRepository

public WorkspaceItemRestRepository()
                            throws SubmissionConfigReaderException

Throws:

SubmissionConfigReaderException

Method Detail

findOne

public WorkspaceItemRest findOne(Context context,
                                 Integer id)

Description copied from class: DSpaceRestRepository

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

Specified by:

findOne in class DSpaceRestRepository<WorkspaceItemRest,Integer>

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<WorkspaceItemRest> 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<WorkspaceItemRest,Integer>

Parameters:

context - the dspace context

pageable - object embedding the requested pagination info

Returns:

findBySubmitter

public org.springframework.data.domain.Page<WorkspaceItemRest> findBySubmitter(UUID submitterID,
                                                                               org.springframework.data.domain.Pageable pageable)

createAndReturn

protected WorkspaceItemRest createAndReturn(Context context)
                                     throws SQLException,
                                            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<WorkspaceItemRest,Integer>

Parameters:

context - the dspace context

Returns:

the created REST object

Throws:

SQLException

AuthorizeException

save

protected WorkspaceItemRest save(Context context,
                                 WorkspaceItemRest wsi)

Description copied from class: DSpaceRestRepository

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

Overrides:

save in class DSpaceRestRepository<WorkspaceItemRest,Integer>

Parameters:

context - the dspace context

wsi - the REST object to update

Returns:

the new state of the REST object after persistence

getDomainClass

public Class<WorkspaceItemRest> getDomainClass()

Description copied from class: DSpaceRestRepository

The REST model supported by the repository

Specified by:

getDomainClass in class DSpaceRestRepository<WorkspaceItemRest,Integer>

wrapResource

public WorkspaceItemResource wrapResource(WorkspaceItemRest witem,
                                          String... rels)

Description copied from class: DSpaceRestRepository

Wrap the REST model in a REST HAL Resource

Specified by:

wrapResource in class DSpaceRestRepository<WorkspaceItemRest,Integer>

Parameters:

witem - the rest model instance

rels - the HAL links

Returns:

the REST Resource

upload

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

Description copied from class: DSpaceRestRepository

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

Overrides:

upload in class DSpaceRestRepository<WorkspaceItemRest,Integer>

Parameters:

request - the http request

id - the ID of the target REST object

file - the uploaded file

Returns:

the new state of the REST object

Throws:

Exception

patch

public void patch(Context context,
                  javax.servlet.http.HttpServletRequest request,
                  String apiCategory,
                  String model,
                  Integer id,
                  Patch patch)
           throws SQLException,
                  AuthorizeException

Description copied from class: DSpaceRestRepository

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

Overrides:

patch in class DSpaceRestRepository<WorkspaceItemRest,Integer>

request - the http request

id - the ID of the target REST object

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

Throws:

SQLException

AuthorizeException

delete

protected void delete(Context context,
                      Integer id)
               throws AuthorizeException

Description copied from class: DSpaceRestRepository

Method to implement to support delete of a single object instance

Overrides:

delete in class DSpaceRestRepository<WorkspaceItemRest,Integer>

Parameters:

context - the dspace context

id - the id of the rest object to delete

Throws:

AuthorizeException

upload

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

Description copied from class: DSpaceRestRepository

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

Overrides:

upload in class DSpaceRestRepository<WorkspaceItemRest,Integer>

request - the http request

uploadfile - the file to process

Returns:

the created objects

Throws:

SQLException

FileNotFoundException

IOException

AuthorizeException