Package org.dspace.app.rest.repository

Class VersionRestRepository

java.lang.Object

org.dspace.app.rest.repository.AbstractDSpaceRestRepository

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

org.dspace.app.rest.repository.VersionRestRepository

All Implemented Interfaces:

ReloadableEntityObjectRepository<Version,Integer>, Aware, BeanNameAware, org.springframework.data.repository.CrudRepository<VersionRest,Integer>, org.springframework.data.repository.PagingAndSortingRepository<VersionRest,Integer>, org.springframework.data.repository.Repository<VersionRest,Integer>

@Component("versioning.versions")
public class VersionRestRepository
extends DSpaceRestRepository<VersionRest,Integer>
implements ReloadableEntityObjectRepository<Version,Integer>

This is the Repository that takes care of the operations on the VersionRest objects

Author:

Mykhaylo Boychuk (mykhaylo.boychuk at 4science.it)

Field Summary

Fields

Modifier and Type	Field	Description
protected WorkflowItemService	workflowItemService

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

converter, requestService, utils

Constructor Summary

Constructors

Constructor	Description
VersionRestRepository()

Method Summary

Modifier and Type	Method	Description
protected VersionRest	createAndReturn(Context context, List<String> stringList)	Method to implement to support the creation of a new instance.
org.springframework.data.domain.Page<VersionRest>	findAll(Context context, org.springframework.data.domain.Pageable pageable)	Method to implement to support scroll of entity instances from the collection resource endpoint
Version	findDomainObjectByPk(Context context, Integer id)
VersionRest	findOne(Context context, Integer id)	Method to implement to support retrieval of a specific REST object instance
Class<VersionRest>	getDomainClass()	The REST model supported by the repository
Class<Integer>	getPKClass()
protected void	patch(Context context, jakarta.servlet.http.HttpServletRequest request, String apiCategory, String model, Integer versionId, Patch patch)	Method to implement to allow partial update of the REST object via JSON Patch

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

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

workflowItemService

@Autowired(required=true)
protected WorkflowItemService workflowItemService

Constructor Details

VersionRestRepository

public VersionRestRepository()

Method Details

findOne

@PreAuthorize("@versioningSecurity.isEnableVersioning() && hasPermission(#id, \'VERSION\', \'READ\')")
public VersionRest 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<VersionRest,Integer>

Parameters:

context - the dspace context

id - the rest object id

Returns:

the REST object identified by its ID

createAndReturn

@PreAuthorize("@versioningSecurity.isEnableVersioning() && hasAuthority(\'AUTHENTICATED\')")
protected VersionRest createAndReturn(Context context,
 List<String> stringList)
                               throws AuthorizeException,
SQLException,
RepositoryMethodNotImplementedException

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

Parameters:

context - the dspace context

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

patch

@PreAuthorize("@versioningSecurity.isEnableVersioning() && hasPermission(#versionId, \'version\', \'ADMIN\')")
protected void patch(Context context,
 jakarta.servlet.http.HttpServletRequest request,
 String apiCategory,
 String model,
 Integer versionId,
 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<VersionRest,Integer>

request - the http request

versionId - the ID of the target REST object

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

Throws:

AuthorizeException

SQLException

findAll

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

Parameters:

context - the dspace context

pageable - object embedding the requested pagination info

Returns:

getDomainClass

public Class<VersionRest> getDomainClass()

Description copied from class: DSpaceRestRepository

The REST model supported by the repository

Specified by:

getDomainClass in class DSpaceRestRepository<VersionRest,Integer>

findDomainObjectByPk

public Version findDomainObjectByPk(Context context,
 Integer id)
                             throws SQLException

Specified by:

findDomainObjectByPk in interface ReloadableEntityObjectRepository<Version,Integer>

Parameters:

context - the DSpace context

id - the primary key shared between the rest and dspace api object

Returns:

the dspace api model object related to the specified id

Throws:

SQLException - if a database error occurs

getPKClass

public Class<Integer> getPKClass()

Specified by:

getPKClass in interface ReloadableEntityObjectRepository<Version,Integer>

Returns:

the class of the primary key