Package org.dspace.app.rest

Class ExternalSourcesRestController

java.lang.Object

org.dspace.app.rest.ExternalSourcesRestController

@RestController
@RequestMapping("/api/integration/externalsources/{externalSourceName}")
public class ExternalSourcesRestController
extends Object

This RestController takes care of the retrieval of External data from various endpoints and providers depending on the calls it receives

Field Summary

Fields

Modifier and Type	Field	Description
protected Utils	utils

Constructor Summary

Constructors

Constructor	Description
ExternalSourcesRestController()

Method Summary

Modifier and Type	Method	Description
org.springframework.hateoas.PagedModel<ExternalSourceEntryResource>	getExternalSourceEntries(String externalSourceName, String query, String parent, org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler assembler)	This method will retrieve all the ExternalSourceEntries for the ExternalSource for the given externalSourceName param curl -X GET http://<dspace.server.url>/api/integration/externalsources/orcidV2/entries
ExternalSourceEntryResource	getExternalSourceEntryValue(String externalSourceName, String entryId)	This method will retrieve one ExternalSourceEntryResource based on the ExternalSource for the given externalSourceName and with the given entryId curl -X GET http://<dspace.server.url>/api/integration/externalsources/orcidV2/entries/0000-0000-0000-0000

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

utils

@Autowired
protected Utils utils

Constructor Details

ExternalSourcesRestController

public ExternalSourcesRestController()

Method Details

getExternalSourceEntries

@RequestMapping(method=GET,
                value="/entries")
public org.springframework.hateoas.PagedModel<ExternalSourceEntryResource> getExternalSourceEntries(@PathVariable("externalSourceName")
 String externalSourceName,
 @RequestParam(name="query")
 String query,
 @RequestParam(name="parent",required=false)
 String parent,
 org.springframework.data.domain.Pageable pageable,
 org.springframework.data.web.PagedResourcesAssembler assembler)

This method will retrieve all the ExternalSourceEntries for the ExternalSource for the given externalSourceName param curl -X GET http://<dspace.server.url>/api/integration/externalsources/orcidV2/entries

Parameters:

externalSourceName - The externalSourceName that defines which ExternalDataProvider is used

query - The query used in the lookup

parent - The parent used in the lookup

pageable - The pagination object

assembler - The assembler object

Returns:

A paginated list of ExternalSourceEntryResource objects that comply with the params

getExternalSourceEntryValue

@RequestMapping(method=GET,
                value="/entryValues/{entryId}")
public ExternalSourceEntryResource getExternalSourceEntryValue(@PathVariable("externalSourceName")
 String externalSourceName,
 @PathVariable("entryId")
 String entryId)

This method will retrieve one ExternalSourceEntryResource based on the ExternalSource for the given externalSourceName and with the given entryId curl -X GET http://<dspace.server.url>/api/integration/externalsources/orcidV2/entries/0000-0000-0000-0000

Parameters:

externalSourceName - The externalSourceName that defines which ExternalDataProvider is used

entryId - The entryId used for the lookup

Returns:

An ExternalSourceEntryResource that complies with the above params