Migrate OAIPMH server API to Spring MVC

docs/manual/docs/api/oai-pmh.md

@@ -4,7 +4,7 @@ The OAI-PMH end point exposes the metadata records in your catalog in XML format
 
 ## Configuration
 
-The following URL is the standard end point for the catalog (substitute your GeoNetwork URL): <http://localhost:8080/geonetwork/srv/eng/oaipmh>?
+The following URL is the standard end point for the catalog (substitute your GeoNetwork URL): <http://localhost:8080/geonetwork/srv/api/oaipmh>?
 
 ## Requests
 

services/src/main/java/org/fao/geonet/api/oaipmh/OaiPmhApi.java

@@ -0,0 +1,108 @@
+/*
+ * Copyright (C) 2001-2023 Food and Agriculture Organization of the
+ * United Nations (FAO-UN), United Nations World Food Programme (WFP)
+ * and United Nations Environment Programme (UNEP)
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or (at
+ * your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ *
+ * Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2,
+ * Rome - Italy. email: [email protected]
+ */
+
+package org.fao.geonet.api.oaipmh;
+
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import jeeves.server.context.ServiceContext;
+import org.apache.commons.lang.StringUtils;
+import org.fao.geonet.api.ApiUtils;
+import org.fao.geonet.api.tools.i18n.LanguageUtils;
+import org.fao.geonet.kernel.oaipmh.OaiPmhDispatcher;
+import org.jdom.Element;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.*;
+
+import javax.servlet.http.HttpServletRequest;
+import java.util.Locale;
+
+@RequestMapping(value = {
+    "/{portal}/api/oaipmh"
+})
+@Tag(name = "oaipmh",
+    description = "OAIPMH server operations")
+@Controller("oaipmh")
+public class OaiPmhApi {
+
+    @Autowired
+    private LanguageUtils languageUtils;
+
+    @Autowired
+    private OaiPmhDispatcher oaiPmhDispatcher;
+
+    @io.swagger.v3.oas.annotations.Operation(
+        summary = "Oaiphm server",
+        description = "")
+    @GetMapping(
+        produces = MediaType.APPLICATION_XML_VALUE)
+    @ResponseStatus(HttpStatus.OK)
+    @ApiResponses(value = {
+        @ApiResponse(responseCode = "200", description = "Oaiphm server response.")
+    })
+    @ResponseBody
+    public Element dispatch(
+        @RequestParam(required = false) final String verb,
+        @RequestParam(required = false) final String metadataPrefix,
+        @RequestParam(required = false) final String set,
+        @RequestParam(required = false) final String from,
+        @RequestParam(required = false) final String until,
+        @RequestParam(required = false) final String resumptionToken,
+        final HttpServletRequest request
+    ) {
+        Locale locale = languageUtils.parseAcceptLanguage(request.getLocales());
+        ServiceContext serviceContext = ApiUtils.createServiceContext(request, locale.getISO3Country());
+
+        Element params = new Element("params");
+        if (StringUtils.isNotEmpty(verb)) {
+            params.addContent(new Element("verb").setText(verb));
+        }
+
+        if (StringUtils.isNotEmpty(metadataPrefix)) {
+            params.addContent(new Element("metadataPrefix").setText(metadataPrefix));
+        }
+
+        if (StringUtils.isNotEmpty(set)) {
+            params.addContent(new Element("set").setText(set));
+        }
+
+        if (StringUtils.isNotEmpty(from)) {
+            params.addContent(new Element("from").setText(from));
+        }
+
+        if (StringUtils.isNotEmpty(until)) {
+            params.addContent(new Element("until").setText(until));
+        }
+
+        if (StringUtils.isNotEmpty(resumptionToken)) {
+            params.addContent(new Element("resumptionToken").setText(resumptionToken));
+        }
+
+        return oaiPmhDispatcher.dispatch(params, serviceContext);
+    }
+
+}

web/src/main/webapp/WEB-INF/config-security/config-security-mapping.xml

@@ -78,7 +78,6 @@
 
         <sec:intercept-url pattern="/[a-zA-Z0-9_\-]+/[a-z]{2,3}/q!?.*" access="permitAll"/>
         <sec:intercept-url pattern="/[a-zA-Z0-9_\-]+/[a-z]{2,3}/qi!?.*" access="permitAll"/>
-        <sec:intercept-url pattern="/[a-zA-Z0-9_\-]+/[a-z]{2,3}/oaipmh!?.*" access="permitAll"/>
         <sec:intercept-url pattern="/[a-zA-Z0-9_\-]+/[a-z]{2,3}/info!?.*" access="permitAll"/>
 
 
@@ -236,7 +235,7 @@
         <sec:intercept-url pattern="/[a-zA-Z0-9_\-]+/atom/describe/service!?.*" access="permitAll"/>
         <sec:intercept-url pattern="/[a-zA-Z0-9_\-]+/atom/describe/dataset!?.*" access="permitAll"/>
         <sec:intercept-url pattern="/[a-zA-Z0-9_\-]+/atom/download/dataset!?.*" access="permitAll"/>
-        
+
         <!-- Metadata identifier templates -->
         <sec:intercept-url pattern="/[a-zA-Z0-9_\-]+/[a-z]{2,3}/metadataIdentifierTemplates!?.*"
                            access="hasAuthority('Editor')"/>

web/src/main/webapp/WEB-INF/config.xml

@@ -149,7 +149,6 @@
 
   <include>config/config-service-search.xml</include>
   <include>config/config-service-sru.xml</include>
-  <include>config/config-service-oai.xml</include>
   <include>config/config-service-rss.xml</include>
   <include>config/config-service-dcat-rdf.xml</include>
   <include>config/config-service-thesaurus.xml</include>