Package org.dspace.app.rest.repository

Class CommunityRestRepository

java.lang.Object

org.dspace.app.rest.repository.AbstractDSpaceRestRepository

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

org.dspace.app.rest.repository.DSpaceObjectRestRepository<Community,CommunityRest>

org.dspace.app.rest.repository.CommunityRestRepository

All Implemented Interfaces:

ReloadableEntityObjectRepository<Community,UUID>, Aware, BeanNameAware, org.springframework.data.repository.CrudRepository<CommunityRest,UUID>, org.springframework.data.repository.PagingAndSortingRepository<CommunityRest,UUID>, org.springframework.data.repository.Repository<CommunityRest,UUID>

@Component("core.communities")
public class CommunityRestRepository
extends DSpaceObjectRestRepository<Community,CommunityRest>

This is the repository responsible to manage Community 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

Constructor Summary

Constructors

Constructor	Description
CommunityRestRepository(CommunityService dsoService)

Method Summary

Modifier and Type	Method	Description
GroupRest	createAdminGroup(Context context, jakarta.servlet.http.HttpServletRequest request, Community community)	This method will create an AdminGroup for the given Community with the given Information through JSON
protected CommunityRest	createAndReturn(Context context)	Method to implement to support the creation of a new instance.
protected CommunityRest	createAndReturn(Context context, UUID id)	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
void	deleteAdminGroup(Context context, Community community)	This method will delete the AdminGroup for the given Community
org.springframework.data.domain.Page<CommunityRest>	findAdminAuthorized(org.springframework.data.domain.Pageable pageable, String query)
org.springframework.data.domain.Page<CommunityRest>	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<CommunityRest>	findAllTop(org.springframework.data.domain.Pageable pageable)
CommunityRest	findOne(Context context, UUID id)	Method to implement to support retrieval of a specific REST object instance
Class<CommunityRest>	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
protected CommunityRest	put(Context context, jakarta.servlet.http.HttpServletRequest request, String apiCategory, String model, UUID id, com.fasterxml.jackson.databind.JsonNode jsonNode)	Implement this method in the subclass to support updating a REST object.
BitstreamRest	setLogo(Context context, Community community, MultipartFile uploadfile)	Method to install a logo on a Community which doesn't have a logo Called by request mappings in CommunityLogoController

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

Constructor Details

CommunityRestRepository

public CommunityRestRepository(CommunityService dsoService)

Method Details

createAndReturn

@PreAuthorize("hasAuthority(\'ADMIN\')")
protected CommunityRest 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<CommunityRest,UUID>

Parameters:

context - the dspace context

Returns:

the created REST object

Throws:

AuthorizeException

createAndReturn

@PreAuthorize("hasPermission(#id, \'COMMUNITY\', \'ADD\')")
protected CommunityRest createAndReturn(Context context,
 UUID id)
                                 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<CommunityRest,UUID>

Parameters:

context - the dspace context

id - The uuid of the parent object retrieved from the query param.

Returns:

the created REST object

Throws:

AuthorizeException

findOne

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

Parameters:

context - the dspace context

id - the rest object id

Returns:

the REST object identified by its ID

findAll

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

Parameters:

context - the dspace context

pageable - object embedding the requested pagination info

Returns:

findAllTop

public org.springframework.data.domain.Page<CommunityRest> findAllTop(org.springframework.data.domain.Pageable pageable)

findAdminAuthorized

@PreAuthorize("hasAuthority(\'AUTHENTICATED\')")
public org.springframework.data.domain.Page<CommunityRest> findAdminAuthorized(org.springframework.data.domain.Pageable pageable,
 String query)

patch

@PreAuthorize("hasPermission(#id, \'COMMUNITY\', \'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<CommunityRest,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

getDomainClass

public Class<CommunityRest> getDomainClass()

Description copied from class: DSpaceRestRepository

The REST model supported by the repository

Specified by:

getDomainClass in class DSpaceRestRepository<CommunityRest,UUID>

put

@PreAuthorize("hasPermission(#id, \'COMMUNITY\', \'WRITE\')")
protected CommunityRest put(Context context,
 jakarta.servlet.http.HttpServletRequest request,
 String apiCategory,
 String model,
 UUID id,
 com.fasterxml.jackson.databind.JsonNode jsonNode)
                     throws RepositoryMethodNotImplementedException,
SQLException,
AuthorizeException

Description copied from class: DSpaceRestRepository

Implement this method in the subclass to support updating a REST object.

Overrides:

put in class DSpaceRestRepository<CommunityRest,UUID>

Parameters:

context - the dspace context

apiCategory - the API category e.g. "api"

model - the DSpace model e.g. "metadatafield"

id - the ID of the target REST object

jsonNode - the part of the request body representing the updated rest object

Returns:

the updated REST object

Throws:

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

SQLException - when the database returns an error

AuthorizeException - if the context user is not authorized to perform this operation

delete

@PreAuthorize("hasPermission(#id, \'COMMUNITY\', \'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<CommunityRest,UUID>

Parameters:

context - the dspace context

id - the id of the rest object to delete

Throws:

AuthorizeException

setLogo

public BitstreamRest setLogo(Context context,
 Community community,
 MultipartFile uploadfile)
                      throws IOException,
AuthorizeException,
SQLException

Method to install a logo on a Community which doesn't have a logo Called by request mappings in CommunityLogoController

Parameters:

context -

community - The community on which to install the logo

uploadfile - The new logo

Returns:

The created bitstream containing the new logo

Throws:

IOException

AuthorizeException

SQLException

createAdminGroup

public GroupRest createAdminGroup(Context context,
 jakarta.servlet.http.HttpServletRequest request,
 Community community)
                           throws SQLException,
AuthorizeException

This method will create an AdminGroup for the given Community with the given Information through JSON

Parameters:

context - The current context

request - The current request

community - The community for which we'll create an admingroup

Returns:

The created AdminGroup's REST object

Throws:

SQLException - If something goes wrong

AuthorizeException - If something goes wrong

deleteAdminGroup

public void deleteAdminGroup(Context context,
 Community community)
                      throws SQLException,
AuthorizeException,
IOException

This method will delete the AdminGroup for the given Community

Parameters:

context - The current context

community - The community for which we'll delete the admingroup

Throws:

SQLException - If something goes wrong

AuthorizeException - If something goes wrong

IOException - If something goes wrong