[DSC-2782] rename SherpaAuthority to OpenPolicyFinderAuthority and update related configurations

Author: Mykhaylo Boychuk

dspace-api/src/main/java/org/dspace/app/openpolicyfinder/OpenPolicyFinderService.java

@@ -27,10 +27,12 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.dspace.app.client.DSpaceHttpClientFactory;
-import org.dspace.app.sherpa.v2.SHERPAFormat;
+import org.dspace.app.openpolicyfinder.v2.OpenPolicyFinderFormat;
 import org.dspace.app.openpolicyfinder.v2.OpenPolicyFinderPublisherResponse;
 import org.dspace.app.openpolicyfinder.v2.OpenPolicyFinderResponse;
 import org.dspace.app.openpolicyfinder.v2.OpenPolicyFinderUtils;
+import org.dspace.external.provider.impl.OpenPolicyFinderJournalDataProvider;
+import org.dspace.external.provider.impl.OpenPolicyFinderPublisherDataProvider;
 import org.dspace.services.ConfigurationService;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.cache.annotation.Cacheable;
@@ -41,21 +43,22 @@
  * Note, this service is ported from DSpace 6 for the ability to search policies by ISSN
  * There are also new DataProvider implementations provided for use as 'external sources'
  * of journal and publisher data
- * @see org.dspace.external.provider.impl.OpenPolicyFinderJournalDataProvider
- * @see org.dspace.external.provider.impl.OpenPolicyFinderPublisherDataProvider
+ * @see OpenPolicyFinderJournalDataProvider
+ * @see OpenPolicyFinderPublisherDataProvider
  * @author Kim Shepherd
  */
 public class OpenPolicyFinderService {
 
+    private static final Logger log = LogManager.getLogger(OpenPolicyFinderService.class);
+
+    public static final String OPEN_POLICY_FINDER_URL = "https://api.openpolicyfinder.jisc.ac.uk/retrieve";
+
     private int maxNumberOfTries;
     private long sleepBetweenTimeouts;
     private int timeout = 5000;
     private String endpoint = null;
     private String apiKey = null;
 
-    /** log4j category */
-    private static final Logger log = LogManager.getLogger(OpenPolicyFinderService.class);
-
     @Autowired
     ConfigurationService configurationService;
 
@@ -68,14 +71,15 @@ private void init() {
         // Get endpoint and API key from configuration, with fallback to legacy property names
         String newUrl = configurationService.getProperty("openpolicyfinder.url");
         String legacyUrl = configurationService.getProperty("sherpa.romeo.url");
-            if (newUrl != null) {
+        if (newUrl != null) {
             endpoint = newUrl;
         } else if (legacyUrl != null) {
             endpoint = legacyUrl;
-            log.warn("Configuration property 'sherpa.romeo.url' is deprecated. "
-                + "Please use 'openpolicyfinder.url' instead.");
+            log.warn("Configuration property 'sherpa.romeo.url' is deprecated. " +
+                     "If it points to v2.sherpa.ac.uk, that endpoint is being retired in April 2026." +
+                     "Please set 'openpolicyfinder.url =" + OPEN_POLICY_FINDER_URL);
         } else {
-            endpoint = "https://api.openpolicyfinder.jisc.ac.uk/retrieve";
+            endpoint = OPEN_POLICY_FINDER_URL;
         }
 
         String newApiKey = configurationService.getProperty("openpolicyfinder.apikey");
@@ -116,9 +120,8 @@ public OpenPolicyFinderResponse searchByJournalISSN(String query) {
      * @param limit         maximum search results to return
      * @return              OpenPolicyFinderPublisherResponse object
      */
-    public OpenPolicyFinderPublisherResponse performPublisherRequest(
-            String type, String field, String predicate, String value,
-            int start, int limit) {
+    public OpenPolicyFinderPublisherResponse performPublisherRequest(String type, String field, String predicate,
+                                                                     String value, int start, int limit) {
         // API Key is *required* for API calls
         if (null == apiKey) {
             log.error("Open Policy Finder API Key missing: "
@@ -133,9 +136,8 @@ public OpenPolicyFinderPublisherResponse performPublisherRequest(
         while (numberOfTries < maxNumberOfTries && opfResponse == null) {
             numberOfTries++;
 
-            log.debug(String.format(
-                "Trying to contact Open Policy Finder - attempt %d of %d; timeout is %d; "
-                    + "sleep between timeouts is %d",
+            log.debug(String.format("Trying to contact Open Policy Finder - attempt %d of %d; timeout is %d; "
+                                  + "sleep between timeouts is %d",
                 numberOfTries,
                 maxNumberOfTries,
                 timeout,
@@ -151,13 +153,11 @@ public OpenPolicyFinderPublisherResponse performPublisherRequest(
                 try (CloseableHttpResponse response = client.execute(method)) {
                     int statusCode = response.getStatusLine().getStatusCode();
 
-                    log.debug(response.getStatusLine().getStatusCode() + ": "
-                                  + response.getStatusLine().getReasonPhrase());
+                    log.debug(statusCode + ": " + response.getStatusLine().getReasonPhrase());
 
                     if (statusCode != HttpStatus.SC_OK) {
-                        opfResponse = new OpenPolicyFinderPublisherResponse(
-                            "Open Policy Finder return not OK status: "
-                                                                         + statusCode);
+                        opfResponse = new OpenPolicyFinderPublisherResponse("Open Policy Finder return not OK status: "
+                                                                            + statusCode);
                         String errorBody = IOUtils.toString(response.getEntity().getContent(), StandardCharsets.UTF_8);
                         log.error("Error from Open Policy Finder HTTP request: " + errorBody);
                     }
@@ -208,8 +208,7 @@ public OpenPolicyFinderPublisherResponse performPublisherRequest(
 
         if (opfResponse == null) {
             log.debug("Response is still null");
-            opfResponse = new OpenPolicyFinderPublisherResponse(
-                "Error processing the Open Policy Finder answer");
+            opfResponse = new OpenPolicyFinderPublisherResponse("Error processing the Open Policy Finder answer");
         }
 
         // Return the final response
@@ -265,9 +264,8 @@ public OpenPolicyFinderResponse performRequest(String type, String field, String
                                   + response.getStatusLine().getReasonPhrase());
 
                     if (statusCode != HttpStatus.SC_OK) {
-                        opfResponse = new OpenPolicyFinderResponse(
-                            "Open Policy Finder return not OK status: "
-                                                                + statusCode);
+                        opfResponse = new OpenPolicyFinderResponse("Open Policy Finder return not OK status: "
+                                                                   + statusCode);
                         String errorBody = IOUtils.toString(response.getEntity().getContent(), StandardCharsets.UTF_8);
                         log.error("Error from Open Policy Finder HTTP request: " + errorBody);
                     }
@@ -280,8 +278,7 @@ public OpenPolicyFinderResponse performRequest(String type, String field, String
                         InputStream content = null;
                         try {
                             content = responseBody.getContent();
-                            opfResponse = new OpenPolicyFinderResponse(
-                                    content, OpenPolicyFinderResponse.ResponseFormat.JSON);
+                            opfResponse = new OpenPolicyFinderResponse(content, OpenPolicyFinderFormat.JSON);
                         } catch (IOException e) {
                             log.error("Encountered exception while contacting Open Policy Finder: "
                                 + e.getMessage(), e);
@@ -316,16 +313,15 @@ public OpenPolicyFinderResponse performRequest(String type, String field, String
 
         if (opfResponse == null) {
             log.debug("Response is still null");
-            opfResponse = new OpenPolicyFinderResponse(
-                "Error processing the Open Policy Finder answer");
+            opfResponse = new OpenPolicyFinderResponse("Error processing the Open Policy Finder answer");
         }
 
         // Return the final response
         return opfResponse;
     }
 
     /**
-     * Perform an API request to the SHERPA v2 API to count the results related to the given parameters.
+     * Perform an API request to the Open Policy Finder API to count the results related to the given parameters.
      *
      * @param type          entity type eg "publication" or "publisher"
      * @param field         field eg "issn" or "title"
@@ -334,47 +330,45 @@ public OpenPolicyFinderResponse performRequest(String type, String field, String
      * @return              the count
      */
     public int performCountRequest(String type, String field, String predicate, String value) {
-
         // API Key is *required* for v2 API calls
         if (null == apiKey) {
-            log.error("SHERPA ROMeO API Key missing: please register for an API key and set sherpa.romeo.apikey");
+            log.error("Open Policy Finder API Key missing: " +
+                      "please register for an API key and set openpolicyfinder.apikey");
             return 0;
         }
 
         HttpGet method = null;
-
         try (CloseableHttpClient client = DSpaceHttpClientFactory.getInstance().buildWithoutAutomaticRetries(5)) {
             Thread.sleep(sleepBetweenTimeouts);
 
-            method = constructHttpGet(type, field, predicate, value, SHERPAFormat.IDS, 0, 0);
+            method = constructHttpGet(type, field, predicate, value, OpenPolicyFinderFormat.IDS, 0, 0);
 
             HttpResponse response = client.execute(method);
             int statusCode = response.getStatusLine().getStatusCode();
 
             if (statusCode != HttpStatus.SC_OK) {
                 String errorBody = IOUtils.toString(response.getEntity().getContent(), StandardCharsets.UTF_8);
-                log.error("Error from SHERPA HTTP request: " + errorBody);
+                log.error("Error from OpenPolicyFinder HTTP request: " + errorBody);
                 return 0;
             }
 
             HttpEntity responseBody = response.getEntity();
             if (responseBody == null) {
-                log.debug("Empty SHERPA response body for query on " + value);
+                log.debug("Empty OpenPolicyFinder response body for query on " + value);
                 return 0;
             }
 
             String responseContent = IOUtils.toString(responseBody.getContent(), StandardCharsets.UTF_8);
             return (int) responseContent.lines().count();
 
         } catch (Exception ex) {
-            log.error("An error occurs counting the SHERPA entries", ex);
+            log.error("An error occurs counting the OpenPolicyFinder entries", ex);
             return 0;
         } finally {
             if (method != null) {
                 method.releaseConnection();
             }
         }
-
     }
 
     /**
@@ -404,7 +398,7 @@ public HttpGet constructHttpGet(String type, String field, String predicate, Str
      */
     public HttpGet constructHttpGet(String type, String field, String predicate, String value, int start, int limit)
         throws URISyntaxException {
-        return constructHttpGet(type, field, predicate, value, SHERPAFormat.JSON, start, limit);
+        return constructHttpGet(type, field, predicate, value, OpenPolicyFinderFormat.JSON, start, limit);
     }
 
     /**
@@ -419,9 +413,8 @@ public HttpGet constructHttpGet(String type, String field, String predicate, Str
      * @return HttpGet object to be executed by the client
      * @throws URISyntaxException
      */
-    public HttpGet constructHttpGet(String type, String field, String predicate, String value, SHERPAFormat format,
-        int start, int limit) throws URISyntaxException {
-
+    public HttpGet constructHttpGet(String type, String field, String predicate, String value,
+        OpenPolicyFinderFormat format,int start, int limit) throws URISyntaxException {
         // Sanitise query string (strip some characters) field, predicate and value
         if (null == type) {
             type = "publication";
@@ -455,13 +448,11 @@ public HttpGet constructHttpGet(String type, String field, String predicate, Str
         }
 
         // Set connection parameters
-        int timeout = 5000;
         method.setConfig(RequestConfig.custom()
-            .setConnectionRequestTimeout(timeout)
-            .setConnectTimeout(timeout)
-            .setSocketTimeout(timeout)
+            .setConnectionRequestTimeout(this.timeout)
+            .setConnectTimeout(this.timeout)
+            .setSocketTimeout(this.timeout)
             .build());
-
         return method;
     }
 
@@ -489,7 +480,7 @@ public URI prepareQuery(String query, String endpoint, String apiKey) throws URI
             log.warn("No ISSN supplied as query string for Open Policy Finder service search");
         }
         uriBuilder.addParameter("filter", "[[\"issn\",\"equals\",\"" + query + "\"]]");
-        uriBuilder.addParameter("format", SHERPAFormat.JSON.getValue());
+        uriBuilder.addParameter("format", OpenPolicyFinderFormat.JSON.getValue());
         log.debug("Would search Open Policy Finder endpoint with " + uriBuilder.toString());
 
         // Return final built URI

dspace-api/src/main/java/org/dspace/app/openpolicyfinder/submit/OpenPolicyFinderSubmitService.java

@@ -20,8 +20,9 @@
 import org.dspace.core.LogHelper;
 
 /**
- * OpenPolicyFinderSubmitService is
- * @see
+ * OpenPolicyFinderSubmitService is responsible for querying the Open Policy Finder API
+ * during item submission to retrieve journal publishing policies by ISSN.
+ *
  * @author Kim Shepherd
  */
 public class OpenPolicyFinderSubmitService {

…pp/openpolicyfinder/v2/SHERPAFormat.java …icyfinder/v2/OpenPolicyFinderFormat.javadspace-api/src/main/java/org/dspace/app/openpolicyfinder/v2/SHERPAFormat.java renamed to dspace-api/src/main/java/org/dspace/app/openpolicyfinder/v2/OpenPolicyFinderFormat.java dspace-api/src/main/java/org/dspace/app/openpolicyfinder/v2/SHERPAFormat.java renamed to dspace-api/src/main/java/org/dspace/app/openpolicyfinder/v2/OpenPolicyFinderFormat.java

@@ -5,22 +5,22 @@
  *
  * http://www.dspace.org/license/
  */
-package org.dspace.app.sherpa.v2;
+package org.dspace.app.openpolicyfinder.v2;
 
 /**
- * Enum that list the supported format by Sherpa API.
+ * Enum that list the supported format by Open Policy Finder API.
  *
  * @author Luca Giamminonni (luca.giamminonni at 4Science)
  *
  */
-public enum SHERPAFormat {
+public enum OpenPolicyFinderFormat {
 
     JSON("Json"),
     IDS("Ids");
 
     private final String value;
 
-    private SHERPAFormat(String value) {
+    private OpenPolicyFinderFormat(String value) {
         this.value = value;
     }
 

dspace-api/src/main/java/org/dspace/app/openpolicyfinder/v2/OpenPolicyFinderJournal.java

@@ -27,7 +27,7 @@ public class OpenPolicyFinderJournal implements Serializable {
     private List<String> titles;
     private String url;
     private List<String> issns;
-    private String romeoPub;
+    private String publisherDisplay;
     private String zetoPub;
     private OpenPolicyFinderPublisher publisher;
     private List<OpenPolicyFinderPublisher> publishers;
@@ -62,12 +62,12 @@ public void setIssns(List<String> issns) {
         this.issns = issns;
     }
 
-    public String getRomeoPub() {
-        return romeoPub;
+    public String getPublisherDisplay() {
+        return publisherDisplay;
     }
 
-    public void setRomeoPub(String romeoPub) {
-        this.romeoPub = romeoPub;
+    public void setPublisherDisplay(String publisherDisplay) {
+        this.publisherDisplay = publisherDisplay;
     }
 
     public String getZetoPub() {

dspace-api/src/main/java/org/dspace/app/openpolicyfinder/v2/OpenPolicyFinderResponse.java

@@ -61,11 +61,6 @@ public class OpenPolicyFinderResponse implements Serializable {
     @JsonIgnore
     private Date retrievalTime = new Date();
 
-    // Format enum - currently only JSON is supported
-    public enum ResponseFormat {
-        JSON, XML
-    };
-
     private static Logger log = LogManager.getLogger();
 
     /**
@@ -74,8 +69,8 @@ public enum ResponseFormat {
      * @param format - requested format
      * @throws IOException
      */
-    public OpenPolicyFinderResponse(InputStream input, ResponseFormat format) throws IOException {
-        if (format == ResponseFormat.JSON) {
+    public OpenPolicyFinderResponse(InputStream input, OpenPolicyFinderFormat format) throws IOException {
+        if (format == OpenPolicyFinderFormat.JSON) {
             parseJSON(input);
         }
     }
@@ -86,7 +81,7 @@ public OpenPolicyFinderResponse(InputStream input, ResponseFormat format) throws
     public OpenPolicyFinderResponse() {}
 
     /**
-     * Parse the Open Policy Finder API JSON and construct Romeo policy data for display
+     * Parse the Open Policy Finder API JSON and construct publisher policy data for display
      * This method does not return a value, but rather populates the metadata and journals objects
      * with data parsed from the JSON.
      * @param jsonData - the JSON input stream from the API result response body
@@ -275,7 +270,7 @@ private OpenPolicyFinderJournal parseJournal(JSONObject item, String publisherNa
                 journal.setTitles(titleList);
                 if (titleList.size() > 0) {
                     // Faking this a bit based on what I'd seen - not in the API v2 data
-                    journal.setRomeoPub(publisherName + ": "
+                    journal.setPublisherDisplay(publisherName + ": "
                         + titleList.get(0));
                     journal.setZetoPub(publisherName + ": "
                         + titleList.get(0));