Package org.dspace.app.rest.repository

Class ConfigurationRestRepository

java.lang.Object

org.dspace.app.rest.repository.AbstractDSpaceRestRepository

org.dspace.app.rest.repository.DSpaceRestRepository<PropertyRest,String>

org.dspace.app.rest.repository.ConfigurationRestRepository

All Implemented Interfaces:

org.springframework.data.repository.CrudRepository<PropertyRest,String>, org.springframework.data.repository.PagingAndSortingRepository<PropertyRest,String>, org.springframework.data.repository.Repository<PropertyRest,String>

@Component("config.property")
public class ConfigurationRestRepository
extends DSpaceRestRepository<PropertyRest,String>

This is the repository responsible of exposing configuration properties

Field Summary

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

converter, requestService, utils

Constructor Summary

Constructors

Constructor	Description
ConfigurationRestRepository(ConfigurationService configurationService)

Method Summary

Modifier and Type	Method	Description
org.springframework.data.domain.Page<PropertyRest>	findAll(Context context, org.springframework.data.domain.Pageable pageable)	Method to implement to support scroll of entity instances from the collection resource endpoint
PropertyRest	findOne(Context context, String property)	Gets the value of a configuration property if it is exposed via REST Example:
Class<PropertyRest>	getDomainClass()	The REST model supported by the repository

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

action, action, count, createAndReturn, createAndReturn, createAndReturn, createAndReturn, createAndReturn, createAndReturn, delete, delete, deleteAll, deleteAll, deleteById, existsById, findAll, findAll, findAll, findAllById, findById, patch, patch, put, put, put, put, save, save, saveAll, 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

ConfigurationRestRepository

@Autowired
public ConfigurationRestRepository(ConfigurationService configurationService)

Method Detail

findOne

@PreAuthorize("permitAll()")
public PropertyRest findOne(Context context,
                            String property)

Gets the value of a configuration property if it is exposed via REST Example:

 
 curl http://<dspace.server.url>/api/config/properties/google.analytics.key
  -XGET \
  -H 'Authorization: Bearer eyJhbGciOiJI...'
 
 

Specified by:

findOne in class DSpaceRestRepository<PropertyRest,String>

Parameters:

property -

context - the dspace context

Returns:

findAll

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

Parameters:

context - the dspace context

pageable - object embedding the requested pagination info

Returns:

getDomainClass

public Class<PropertyRest> getDomainClass()

Description copied from class: DSpaceRestRepository

The REST model supported by the repository

Specified by:

getDomainClass in class DSpaceRestRepository<PropertyRest,String>