Package org.dspace.app.rest.repository

Class GroupRestRepository

java.lang.Object

org.dspace.app.rest.repository.AbstractDSpaceRestRepository

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

org.dspace.app.rest.repository.DSpaceObjectRestRepository<Group,GroupRest>

org.dspace.app.rest.repository.GroupRestRepository

All Implemented Interfaces:

ReloadableEntityObjectRepository<Group,UUID>, Aware, BeanNameAware, org.springframework.data.repository.CrudRepository<GroupRest,UUID>, org.springframework.data.repository.PagingAndSortingRepository<GroupRest,UUID>, org.springframework.data.repository.Repository<GroupRest,UUID>

@Component("eperson.groups")
public class GroupRestRepository
extends DSpaceObjectRestRepository<Group,GroupRest>

This is the repository responsible to manage Group Rest object

Author:

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

Field Summary

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

converter, requestService, utils

Method Summary

Modifier and Type	Method	Description
protected GroupRest	createAndReturn(Context context)	Method to implement to support the creation of a new instance.
protected void	delete(Context context, UUID uuid)	Method to implement to support delete of a single object instance
org.springframework.data.domain.Page<GroupRest>	findAll(Context context, org.springframework.data.domain.Pageable pageable)	Method to implement to support scroll of entity instances from the collection resource endpoint
org.springframework.data.domain.Page<GroupRest>	findByMetadata(String query, org.springframework.data.domain.Pageable pageable)	Find the groups matching the query parameter.
org.springframework.data.domain.Page<GroupRest>	findIsNotMemberOf(UUID groupUUID, String query, org.springframework.data.domain.Pageable pageable)	Find the Groups matching the query parameter which are NOT a member of the given parent Group.
GroupRest	findOne(Context context, UUID id)	Method to implement to support retrieval of a specific REST object instance
Class<GroupRest>	getDomainClass()	The REST model supported by the repository
protected void	patch(Context context, jakarta.servlet.http.HttpServletRequest request, String apiCategory, String model, UUID id, 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.DSpaceObjectRestRepository

findDomainObjectByPk, getPKClass, patchDSpaceObject

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

action, action, count, createAndReturn, createAndReturn, createAndReturn, createAndReturn, createAndReturn, 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

Method Details

createAndReturn

@PreAuthorize("hasAuthority(\'ADMIN\')")
protected GroupRest createAndReturn(Context context)
                             throws AuthorizeException,
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<GroupRest,UUID>

Parameters:

context - the dspace context

Returns:

the created REST object

Throws:

AuthorizeException

RepositoryMethodNotImplementedException - returned by the default implementation when the operation is not supported for the entity

findOne

@PreAuthorize("hasPermission(#id, \'GROUP\', \'READ\')")
public GroupRest 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<GroupRest,UUID>

Parameters:

context - the dspace context

id - the rest object id

Returns:

the REST object identified by its ID

findAll

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

Parameters:

context - the dspace context

pageable - object embedding the requested pagination info

Returns:

patch

@PreAuthorize("hasPermission(#id, \'GROUP\', \'WRITE\')")
protected void patch(Context context,
 jakarta.servlet.http.HttpServletRequest request,
 String apiCategory,
 String model,
 UUID id,
 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<GroupRest,UUID>

request - the http request

id - the ID of the target REST object

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

Throws:

AuthorizeException

SQLException

findByMetadata

@PreAuthorize("hasAuthority(\'ADMIN\') || hasAuthority(\'MANAGE_ACCESS_GROUP\')")
public org.springframework.data.domain.Page<GroupRest> findByMetadata(String query,
 org.springframework.data.domain.Pageable pageable)

Find the groups matching the query parameter. The search is delegated to the GroupService.search(Context, String, int, int) method

Parameters:

query - is the *required* query string

pageable - contains the pagination information

Returns:

a Page of GroupRest instances matching the user query

findIsNotMemberOf

@PreAuthorize("hasAuthority(\'ADMIN\') || hasAuthority(\'MANAGE_ACCESS_GROUP\')")
public org.springframework.data.domain.Page<GroupRest> findIsNotMemberOf(UUID groupUUID,
 String query,
 org.springframework.data.domain.Pageable pageable)

Find the Groups matching the query parameter which are NOT a member of the given parent Group. The search is delegated to the GroupService.searchNonMembers(Context, String, Group, int, int) method

Parameters:

groupUUID - the parent group UUID

query - is the *required* query string

pageable - contains the pagination information

Returns:

a Page of GroupRest instances matching the user query

getDomainClass

public Class<GroupRest> getDomainClass()

Description copied from class: DSpaceRestRepository

The REST model supported by the repository

Specified by:

getDomainClass in class DSpaceRestRepository<GroupRest,UUID>

delete

@PreAuthorize("hasAuthority(\'ADMIN\')")
protected void delete(Context context,
 UUID uuid)
               throws AuthorizeException

Description copied from class: DSpaceRestRepository

Method to implement to support delete of a single object instance

Overrides:

delete in class DSpaceRestRepository<GroupRest,UUID>

Parameters:

context - the dspace context

uuid - the id of the rest object to delete

Throws:

AuthorizeException