Package org.dspace.app.rest.repository
Class SystemWideAlertRestRepository
java.lang.Object
org.dspace.app.rest.repository.AbstractDSpaceRestRepository
org.dspace.app.rest.repository.DSpaceRestRepository<SystemWideAlertRest,Integer>
org.dspace.app.rest.repository.SystemWideAlertRestRepository
- All Implemented Interfaces:
Aware,BeanNameAware,org.springframework.data.repository.CrudRepository<SystemWideAlertRest,,Integer> org.springframework.data.repository.PagingAndSortingRepository<SystemWideAlertRest,,Integer> org.springframework.data.repository.Repository<SystemWideAlertRest,Integer>
@Component("system.systemwidealerts")
public class SystemWideAlertRestRepository
extends DSpaceRestRepository<SystemWideAlertRest,Integer>
The repository for the SystemWideAlert workload
-
Field Summary
Fields inherited from class org.dspace.app.rest.repository.AbstractDSpaceRestRepository
converter, requestService, utils -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected SystemWideAlertRestcreateAndReturn(Context context) Method to implement to support the creation of a new instance.org.springframework.data.domain.Page<SystemWideAlertRest>Method to implement to support scroll of entity instances from the collection resource endpointorg.springframework.data.domain.Page<SystemWideAlertRest>findAllActive(org.springframework.data.domain.Pageable pageable) Search method to retrieve all active system-wide alertsThis method will retrieve the system-wide alert for the provided ID However, only admins will be able to retrieve the inactive alerts.The REST model supported by the repositoryprotected SystemWideAlertRestput(Context context, jakarta.servlet.http.HttpServletRequest request, String apiCategory, String model, Integer id, com.fasterxml.jackson.databind.JsonNode jsonNode) 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, delete, deleteAll, deleteAll, deleteAllById, deleteById, existsById, findAll, findAll, findAll, findAllById, findById, patch, patch, put, put, put, save, save, saveAll, setBeanName, upload, upload, uploadMethods inherited from class org.dspace.app.rest.repository.AbstractDSpaceRestRepository
getRequestService, obtainContext
-
Constructor Details
-
SystemWideAlertRestRepository
public SystemWideAlertRestRepository()
-
-
Method Details
-
createAndReturn
@PreAuthorize("hasAuthority(\'ADMIN\')") protected SystemWideAlertRest createAndReturn(Context context) throws SQLException, AuthorizeException Description copied from class:DSpaceRestRepositoryMethod to implement to support the creation of a new instance. Usually require to retrieve the http request from the thread bound attribute- Overrides:
createAndReturnin classDSpaceRestRepository<SystemWideAlertRest,Integer> - Parameters:
context- the dspace context- Returns:
- the created REST object
- Throws:
SQLExceptionAuthorizeException
-
findOne
This method will retrieve the system-wide alert for the provided ID However, only admins will be able to retrieve the inactive alerts. Non-admin users will only be able to retrieve active alerts. This is necessary also to be able to return the results through the search endpoint, since the PreAuthorization will be checked when converting the results to a list. Therefore, closing this endpoint fully off will prevent results from being displayed in the search endpoint- Specified by:
findOnein classDSpaceRestRepository<SystemWideAlertRest,Integer> - Parameters:
context- the dspace contextid- the rest object id- Returns:
- retrieve the system-wide alert for the provided ID
-
findAll
@PreAuthorize("hasAuthority(\'ADMIN\')") public org.springframework.data.domain.Page<SystemWideAlertRest> findAll(Context context, org.springframework.data.domain.Pageable pageable) Description copied from class:DSpaceRestRepositoryMethod to implement to support scroll of entity instances from the collection resource endpoint- Specified by:
findAllin classDSpaceRestRepository<SystemWideAlertRest,Integer> - Parameters:
context- the dspace contextpageable- object embedding the requested pagination info- Returns:
-
put
@PreAuthorize("hasAuthority(\'ADMIN\')") protected SystemWideAlertRest put(Context context, jakarta.servlet.http.HttpServletRequest request, String apiCategory, String model, Integer id, com.fasterxml.jackson.databind.JsonNode jsonNode) throws SQLException, AuthorizeException Description copied from class:DSpaceRestRepositoryImplement this method in the subclass to support updating a REST object.- Overrides:
putin classDSpaceRestRepository<SystemWideAlertRest,Integer> - Parameters:
context- the dspace contextapiCategory- the API category e.g. "api"model- the DSpace model e.g. "metadatafield"id- the ID of the target REST objectjsonNode- the part of the request body representing the updated rest object- Returns:
- the updated REST object
- Throws:
SQLException- when the database returns an errorAuthorizeException- if the context user is not authorized to perform this operation
-
findAllActive
@PreAuthorize("permitAll()") public org.springframework.data.domain.Page<SystemWideAlertRest> findAllActive(org.springframework.data.domain.Pageable pageable) Search method to retrieve all active system-wide alerts- Parameters:
pageable- The page object- Returns:
- all active system-wide alerts for the provided page
-
getDomainClass
Description copied from class:DSpaceRestRepositoryThe REST model supported by the repository- Specified by:
getDomainClassin classDSpaceRestRepository<SystemWideAlertRest,Integer>
-