Package org.dspace.app.rest.repository

Class RegistrationRestRepository

java.lang.Object

org.dspace.app.rest.repository.AbstractDSpaceRestRepository

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

org.dspace.app.rest.repository.RegistrationRestRepository

All Implemented Interfaces:

Aware, BeanNameAware, org.springframework.data.repository.CrudRepository<RegistrationRest,Integer>, org.springframework.data.repository.PagingAndSortingRepository<RegistrationRest,Integer>, org.springframework.data.repository.Repository<RegistrationRest,Integer>

@Component("eperson.registrations")
public class RegistrationRestRepository
extends DSpaceRestRepository<RegistrationRest,Integer>

This is the repository that is responsible for managing Registration Rest objects

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TOKEN_QUERY_PARAM
static final String	TYPE_FORGOT
static final String	TYPE_QUERY_PARAM
static final String	TYPE_REGISTER

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

converter

Constructor Summary

Constructors

Constructor	Description
RegistrationRestRepository()

Method Summary

Modifier and Type	Method	Description
RegistrationRest	createAndReturn(Context context)	Method to implement to support the creation of a new instance.
org.springframework.data.domain.Page<RegistrationRest>	findAll(Context context, org.springframework.data.domain.Pageable pageable)	Method to implement to support scroll of entity instances from the collection resource endpoint
RegistrationRest	findByToken(String token)	This method will find the RegistrationRest object that is associated with the token given
RegistrationRest	findOne(Context context, Integer integer)	Method to implement to support retrieval of a specific REST object instance
Class<RegistrationRest>	getDomainClass()	The REST model supported by the repository
RegistrationRest	patch(jakarta.servlet.http.HttpServletRequest request, String apiCategory, String model, Integer id, Patch patch)	This method can be used to update a RegistrationData with a given id that has a valid token with the actions described in the Patch object.
void	setCaptchaService(CaptchaService captchaService)

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

TOKEN_QUERY_PARAM

public static final String TOKEN_QUERY_PARAM

See Also:

• Constant Field Values

TYPE_QUERY_PARAM

public static final String TYPE_QUERY_PARAM

See Also:

• Constant Field Values

TYPE_REGISTER

public static final String TYPE_REGISTER

TYPE_FORGOT

public static final String TYPE_FORGOT

Constructor Details

RegistrationRestRepository

public RegistrationRestRepository()

Method Details

findOne

@PreAuthorize("permitAll()")
public RegistrationRest findOne(Context context,
 Integer integer)

Description copied from class: DSpaceRestRepository

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

Specified by:

findOne in class DSpaceRestRepository<RegistrationRest,Integer>

Parameters:

context - the dspace context

integer - the rest object id

Returns:

the REST object identified by its ID

findAll

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

Parameters:

context - the dspace context

pageable - object embedding the requested pagination info

Returns:

createAndReturn

public RegistrationRest createAndReturn(Context context)

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

Parameters:

context - the dspace context

Returns:

the created REST object

findByToken

public RegistrationRest findByToken(String token)
                             throws SQLException,
AuthorizeException

This method will find the RegistrationRest object that is associated with the token given

Parameters:

token - The token to be found and for which a RegistrationRest object will be found

Returns:

A RegistrationRest object for the given token

Throws:

SQLException - If something goes wrong

AuthorizeException - If something goes wrong

patch

public RegistrationRest patch(jakarta.servlet.http.HttpServletRequest request,
 String apiCategory,
 String model,
 Integer id,
 Patch patch)
                       throws UnprocessableEntityException,
DSpaceBadRequestException

This method can be used to update a RegistrationData with a given id that has a valid token with the actions described in the Patch object. This method is used to patch the email value, and will generate a completely new token that will be sent with an email RegistrationEmailPatchOperation.

Overrides:

patch in class DSpaceRestRepository<RegistrationRest,Integer>

Parameters:

request - the http request

id - the ID of the target REST object

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

Returns:

Throws:

UnprocessableEntityException

DSpaceBadRequestException

setCaptchaService

public void setCaptchaService(CaptchaService captchaService)

getDomainClass

public Class<RegistrationRest> getDomainClass()

Description copied from class: DSpaceRestRepository

The REST model supported by the repository

Specified by:

getDomainClass in class DSpaceRestRepository<RegistrationRest,Integer>