Merge pull request DSpace#11653 from 4Science/task/main/DSC-2444

feat(ror): Adds client-id in ROR requests if provided by config

Author: tdonohue

dspace-api/src/main/java/org/dspace/importer/external/ror/service/RorImportMetadataSourceServiceImpl.java

@@ -7,6 +7,8 @@
  */
 package org.dspace.importer.external.ror.service;
 
+import static org.dspace.importer.external.liveimportclient.service.LiveImportClientImpl.HEADER_PARAMETERS;
+
 import java.net.URISyntaxException;
 import java.util.ArrayList;
 import java.util.Collection;
@@ -32,6 +34,7 @@
 import org.dspace.importer.external.liveimportclient.service.LiveImportClient;
 import org.dspace.importer.external.service.AbstractImportMetadataSourceService;
 import org.dspace.importer.external.service.components.QuerySource;
+import org.dspace.services.factory.DSpaceServicesFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 
 /**
@@ -44,6 +47,8 @@ public class RorImportMetadataSourceServiceImpl extends AbstractImportMetadataSo
 
     private final static Logger log = LogManager.getLogger();
     protected static final String ROR_IDENTIFIER_PREFIX = "https://ror.org/";
+    protected static final String ROR_CLIENT_ID_HEADER = "Client-Id";
+    protected static final String ROR_CLIENT_ID_PROP = "ror.client-id";
 
     private String url;
 
@@ -161,7 +166,7 @@ public List<ImportRecord> call() throws Exception {
      * ROR query. This Callable uses as query value to ROR the string queryString
      * passed to constructor. If the object will be construct through {@code Query}
      * instance, the value of the Query's map with the key "query" will be used.
-     * 
+     *
      * @author Vincenzo Mecca (vins01-4science - vincenzo.mecca at 4science.com)
      */
     private class CountByQueryCallable implements Callable<Integer> {
@@ -190,7 +195,7 @@ public Integer call() throws Exception {
      */
     public Integer count(String query) {
         try {
-            Map<String, Map<String, String>> params = new HashMap<String, Map<String, String>>();
+            Map<String, Map<String, String>> params = getBaseParams();
 
             URIBuilder uriBuilder = new URIBuilder(this.url);
             uriBuilder.addParameter("query", query);
@@ -214,7 +219,7 @@ private List<ImportRecord> searchById(String id) {
         id = Strings.CS.removeStart(id, ROR_IDENTIFIER_PREFIX);
 
         try {
-            Map<String, Map<String, String>> params = new HashMap<String, Map<String, String>>();
+            Map<String, Map<String, String>> params = getBaseParams();
 
             URIBuilder uriBuilder = new URIBuilder(this.url + "/" + id);
 
@@ -235,7 +240,7 @@ private List<ImportRecord> searchById(String id) {
     private List<ImportRecord> search(String query) {
         List<ImportRecord> importResults = new ArrayList<>();
         try {
-            Map<String, Map<String, String>> params = new HashMap<String, Map<String, String>>();
+            Map<String, Map<String, String>> params = getBaseParams();
 
             URIBuilder uriBuilder = new URIBuilder(this.url);
             uriBuilder.addParameter("query", query);
@@ -262,6 +267,16 @@ private List<ImportRecord> search(String query) {
         return importResults;
     }
 
+    protected Map<String, Map<String, String>> getBaseParams() {
+        Map<String, Map<String, String>> params = new HashMap<>();
+        String rorClientId =
+            DSpaceServicesFactory.getInstance().getConfigurationService().getProperty(ROR_CLIENT_ID_PROP);
+        if (StringUtils.isNotEmpty(rorClientId)) {
+            params.put(HEADER_PARAMETERS, Map.of(ROR_CLIENT_ID_HEADER, rorClientId));
+        }
+        return params;
+    }
+
     private JsonNode convertStringJsonToJsonNode(String json) {
         try {
             return new ObjectMapper().readTree(json);

dspace/config/modules/external-providers.cfg

@@ -103,6 +103,9 @@ datacite.projectimport.entityfilterquery = AND ((types.resourceTypeGeneral:Proje
 #---------------------------------------------------------------#
 
 ror.orgunit-import.api-url = https://api.ror.org/v2/organizations
+# This client-id must be set inside local.cfg you can find details on how to generate it here:
+# https://ror.readme.io/docs/client-id#how-to-register-a-client-id
+# ror.client-id =
 #################################################################
 #------------------------- OpenAlex ----------------------------#
 #---------------------------------------------------------------#