org.dspace.app.rest.repository

Class EPersonRestRepository

java.lang.Object

org.dspace.app.rest.repository.AbstractDSpaceRestRepository

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

org.dspace.app.rest.repository.DSpaceObjectRestRepository<EPerson,EPersonRest>

org.dspace.app.rest.repository.EPersonRestRepository

All Implemented Interfaces:

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

@Component(value="eperson.eperson")
public class EPersonRestRepository
extends DSpaceObjectRestRepository<EPerson,EPersonRest>

This is the repository responsible to manage EPerson Rest object

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
EPersonRestRepository(EPersonService dsoService, EPersonConverter dsoConverter, EPersonPatch dsoPatch)

Method Summary

Modifier and Type	Method and Description
protected EPersonRest	createAndReturn(Context context) Method to implement to support the creation of a new instance.
protected void	delete(Context context, UUID id) Method to implement to support delete of a single object instance
org.springframework.data.domain.Page<EPersonRest>	findAll(Context context, org.springframework.data.domain.Pageable pageable) Method to implement to support scroll of entity instances from the collection resource endpoin
EPersonRest	findByEmail(String email) Find the eperson with the provided email address if any.
org.springframework.data.domain.Page<EPersonRest>	findByName(String q, org.springframework.data.domain.Pageable pageable) Find the epersons matching the query q parameter.
EPersonRest	findOne(Context context, UUID id) Method to implement to support retrieval of a specific REST object instance
Class<EPersonRest>	getDomainClass() The REST model supported by the repository
protected void	patch(Context context, javax.servlet.http.HttpServletRequest request, String apiCategory, String model, UUID uuid, Patch patch) Method to implement to allow partial update of the REST object via JSON Patch
protected void	updateDSpaceObject(EPerson ePerson, EPersonRest ePersonRest) Applies the changes in the given rest DSpace object to the model DSpace object.
EPersonResource	wrapResource(EPersonRest eperson, String... rels) Wrap the REST model in a REST HAL Resource

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, delete, delete, delete, deleteAll, exists, findAll, findAll, findAll, findAll, findOne, patch, put, put, put, put, save, save, save, 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

EPersonRestRepository

public EPersonRestRepository(EPersonService dsoService,
                             EPersonConverter dsoConverter,
                             EPersonPatch dsoPatch)

Method Detail

createAndReturn

protected EPersonRest 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<EPersonRest,UUID>

Parameters:

context - the dspace context

Returns:

the created REST object

Throws:

AuthorizeException

findOne

@PreAuthorize(value="hasPermission(#id, \'EPERSON\', \'READ\')")
public EPersonRest 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<EPersonRest,UUID>

Parameters:

context - the dspace context

id - the rest object id

Returns:

the REST object identified by its ID

findAll

@PreAuthorize(value="hasAuthority(\'ADMIN\')")
public org.springframework.data.domain.Page<EPersonRest> 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<EPersonRest,UUID>

Parameters:

context - the dspace context

pageable - object embedding the requested pagination info

Returns:

findByName

public org.springframework.data.domain.Page<EPersonRest> findByName(String q,
                                                                    org.springframework.data.domain.Pageable pageable)

Find the epersons matching the query q parameter. The search is delegated to the EPersonService.search(Context, String, int, int) method

Parameters:

q - is the *required* query string

pageable - contains the pagination information

Returns:

a Page of EPersonRest instances matching the user query

findByEmail

public EPersonRest findByEmail(String email)

Find the eperson with the provided email address if any. The search is delegated to the EPersonService.findByEmail(Context, String) method

Parameters:

email - is the *required* email address

pageable - contains the pagination information

Returns:

a Page of EPersonRest instances matching the user query

patch

@PreAuthorize(value="hasPermission(#uuid, \'EPERSON\', #patch)")
protected void patch(Context context,
                                                                                       javax.servlet.http.HttpServletRequest request,
                                                                                       String apiCategory,
                                                                                       String model,
                                                                                       UUID uuid,
                                                                                       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<EPersonRest,UUID>

request - the http request

uuid - the ID of the target REST object

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

Throws:

AuthorizeException

SQLException

updateDSpaceObject

protected void updateDSpaceObject(EPerson ePerson,
                                  EPersonRest ePersonRest)
                           throws AuthorizeException,
                                  SQLException

Description copied from class: DSpaceObjectRestRepository

Applies the changes in the given rest DSpace object to the model DSpace object. The default implementation updates metadata if needed. Subclasses should extend to support updates of additional properties.

Overrides:

updateDSpaceObject in class DSpaceObjectRestRepository<EPerson,EPersonRest>

Parameters:

ePerson - the dso to apply changes to.

ePersonRest - the rest representation of the new desired state.

Throws:

AuthorizeException

SQLException

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

Parameters:

context - the dspace context

id - the id of the rest object to delete

Throws:

AuthorizeException

getDomainClass

public Class<EPersonRest> getDomainClass()

Description copied from class: DSpaceRestRepository

The REST model supported by the repository

Specified by:

getDomainClass in class DSpaceRestRepository<EPersonRest,UUID>

wrapResource

public EPersonResource wrapResource(EPersonRest eperson,
                                    String... rels)

Description copied from class: DSpaceRestRepository

Wrap the REST model in a REST HAL Resource

Specified by:

wrapResource in class DSpaceRestRepository<EPersonRest,UUID>

Parameters:

eperson - the rest model instance

rels - the HAL links

Returns:

the REST Resource