OGC API Records

.github/workflows/ci.yaml

@@ -0,0 +1,26 @@
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: "Checking out"
+      uses: actions/checkout@v2
+
+    - name: "Setting up Java"
+      uses: actions/setup-java@v1
+      with:
+        java-version: '11.x'
+
+    - name: "Maven repository caching"
+      uses: actions/cache@v1
+      with:
+        path: ~/.m2/repository
+        key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+        restore-keys: |
+          ${{ runner.os }}-maven-
+
+    - name: "Run the testsuite"
+      run: ./mvnw clean install -P-docker --no-transfer-progress -B

config/application.yml

@@ -5,13 +5,15 @@ jwt.secret: geonetwork
 gn:
   datadir: ${java.io.tmpdir}/gn-datadir
   baseurl: http://geonetwork:8080
+  legacy.url: http://geonetwork:8080/geonetwork
   index:
     url: http://elasticsearch:9200
     records: gn-records
   indexing:
     batch.size: 40
     threadPool.size: 20
 
+
 # Enable actuator endpoints by default
 management:
   endpoint:

modules/library/README.md

@@ -0,0 +1,27 @@
+# Logging configuration
+
+Slf4j is used as a logging facade, and by default the logs will be redirected
+onto the standard output.
+
+
+Create a topic in the class and use the log:
+```java
+@Slf4j(topic = "org.fao.geonet.indexing.tasks")
+public class IndexingService {
+    ...
+    log.info(String.format(
+             "Index %s removed.",
+             index));
+```
+
+
+If one need to tweak the log level, it can be done by modifying the
+`bootstrap.yml` file of the spring-boot application, e.g.:
+
+```
+logging.level:
+  org.springframework: DEBUG
+  org.hibernate.SQL: DEBUG
+  org.hibernate.type.descriptor.sql.BasicBinder: TRACE
+```
+

modules/library/common-error/README.md

@@ -0,0 +1,36 @@
+## Error
+
+The error module defines rules and core implementation of error handling and capacity to return multilingual error messages in format corresponding to the request.
+
+
+Errors handling conventions:
+
+* All errors are localized. Use `exception.properties` file:
+
+```java
+new IllegalArgumentException(messages.getMessage(
+        "api.exception.record.notFound", new String[]{"abcd"},
+        request.getLocale()))
+```
+
+And add in `src/main/resources/messages/(exception|api|view).properties` the corresponding property:
+
+```properties
+api.exception.record.notFound=No record could be found with id {0}.
+```
+
+* Errors return the error cause but also if possible options to solve the problem. eg. an invalid parameter based on an enum, error MUST return the possibilities.
+
+
+* Errors can be returned as JSON/XML/HTML depending on `Accept` header:
+
+```shell script
+curl -v -H "Accept:application/json" -H "Accept-language:en" http://localhost:9902/errortestlocalized
+
+curl -v -H "Accept:application/json" -H "Accept-language:fr" http://localhost:9902/errortestlocalized
+
+curl -v -H "Accept:application/xml" -H "Accept-language:fr" http://localhost:9902/errortestlocalized
+
+curl -v -H "Accept:text/html" -H "Accept-language:fr" http://localhost:9902/errortestlocalized
+```
+

modules/library/common-error/pom.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <parent>
+    <artifactId>gn-cloud-lib</artifactId>
+    <groupId>org.geonetwork-opensource.cloud</groupId>
+    <version>0.1-SNAPSHOT</version>
+  </parent>
+  <modelVersion>4.0.0</modelVersion>
+
+  <artifactId>gn-cloud-common-error</artifactId>
+  <name>GeoNetwork common error</name>
+  <url>http://geonetwork-opensource.org</url>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.geonetwork-opensource.cloud</groupId>
+      <artifactId>gn-cloud-common-view</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-web</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-cache</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>javax.xml.bind</groupId>
+      <artifactId>jaxb-api</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.projectlombok</groupId>
+      <artifactId>lombok</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>commons-io</groupId>
+      <artifactId>commons-io</artifactId>
+    </dependency>
+  </dependencies>
+</project>

modules/library/common-error/src/main/java/org/fao/geonet/errors/GeoNetworkErrorAttributes.java

@@ -0,0 +1,32 @@
+/**
+ * (c) 2020 Open Source Geospatial Foundation - all rights reserved This code is licensed under the
+ * GPL 2.0 license, available at the root application directory.
+ */
+
+package org.fao.geonet.errors;
+
+import java.util.Map;
+import org.springframework.boot.web.error.ErrorAttributeOptions;
+import org.springframework.boot.web.servlet.error.DefaultErrorAttributes;
+import org.springframework.stereotype.Component;
+import org.springframework.web.context.request.WebRequest;
+
+@Component
+public class GeoNetworkErrorAttributes extends DefaultErrorAttributes {
+
+  @Override
+  public Map<String, Object> getErrorAttributes(
+      WebRequest webRequest, ErrorAttributeOptions options) {
+    Map<String, Object> errorAttributes =
+        super.getErrorAttributes(webRequest, options);
+    errorAttributes.put("locale", webRequest.getLocale()
+        .toString());
+    //errorAttributes.remove("error");
+
+    //...
+    // overriding the Whitelabel Page
+
+    return errorAttributes;
+  }
+}
+

modules/library/common-error/src/main/java/org/fao/geonet/errors/GeoNetworkExceptionHandler.java

@@ -0,0 +1,26 @@
+/**
+ * (c) 2020 Open Source Geospatial Foundation - all rights reserved This code is licensed under the
+ * GPL 2.0 license, available at the root application directory.
+ */
+
+package org.fao.geonet.errors;
+
+import org.fao.geonet.errors.model.GeoNetworkError;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
+
+@ControllerAdvice
+public class GeoNetworkExceptionHandler extends ResponseEntityExceptionHandler {
+
+  //  @ExceptionHandler(EntityNotFoundException.class)
+  //  protected ResponseEntity<Object> handleEntityNotFound(
+  //      EntityNotFoundException ex) {
+  //    Error apiError = new Error(ex, NOT_FOUND);
+  //    return buildResponseEntity(apiError);
+  //  }
+
+  private ResponseEntity<Object> buildResponseEntity(GeoNetworkError apiError) {
+    return new ResponseEntity<>(apiError, apiError.getStatus());
+  }
+}

modules/library/common-error/src/main/java/org/fao/geonet/errors/controller/GeoNetworkErrorController.java

@@ -0,0 +1,114 @@
+/**
+ * (c) 2020 Open Source Geospatial Foundation - all rights reserved This code is licensed under the
+ * GPL 2.0 license, available at the root application directory.
+ */
+
+package org.fao.geonet.errors.controller;
+
+import java.io.StringWriter;
+import javax.servlet.RequestDispatcher;
+import javax.servlet.http.HttpServletRequest;
+import javax.xml.bind.JAXBContext;
+import javax.xml.bind.JAXBException;
+import javax.xml.bind.Marshaller;
+import org.apache.commons.io.IOUtils;
+import org.fao.geonet.errors.model.GeoNetworkError;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.web.servlet.error.ErrorController;
+import org.springframework.context.MessageSource;
+import org.springframework.http.HttpEntity;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+import org.springframework.ui.Model;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+/**
+ * Basic Controller which is called for unhandled Error.
+ */
+@Controller
+public class GeoNetworkErrorController implements ErrorController {
+
+  @Autowired
+  MessageSource messages;
+
+  /**
+   * Test error.
+   */
+  @GetMapping(value = "/errortest")
+  public String errorTest() {
+    throw new IllegalArgumentException("Error reported");
+  }
+
+
+  /**
+   * Test error localized.
+   */
+  @GetMapping(value = "/errortestlocalized")
+  public String errorTestException(
+      HttpServletRequest request) {
+    throw new IllegalArgumentException(messages.getMessage(
+        "api.exception.record.notFound", new String[]{"abcd"},
+        request.getLocale()));
+  }
+
+  /**
+   * XML or JSON error.
+   */
+  @RequestMapping(
+      value = "/error",
+      produces = {
+          MediaType.APPLICATION_JSON_VALUE,
+          MediaType.APPLICATION_XML_VALUE
+      }
+  )
+  @ResponseBody
+  public HttpEntity<GeoNetworkError> handleError(
+      HttpServletRequest request) {
+    GeoNetworkError error = getError(request);
+    return ResponseEntity
+        .status(error.getStatus())
+        .body(error);
+  }
+
+  /**
+   * HTML version of an error.
+   */
+  @RequestMapping(
+      value = "/error",
+      produces = {
+          MediaType.TEXT_HTML_VALUE,
+          MediaType.APPLICATION_XHTML_XML_VALUE
+      }
+  )
+  public String handleErrorAsHtml(
+      HttpServletRequest request,
+      Model model) {
+    StringWriter sw = new StringWriter();
+    try {
+      JAXBContext context = JAXBContext.newInstance(GeoNetworkError.class);
+      Marshaller marshaller = context.createMarshaller();
+      marshaller.marshal(getError(request), sw);
+    } catch (JAXBException e) {
+      e.printStackTrace();
+    }
+    model.addAttribute("source", IOUtils.toInputStream(sw.toString()));
+    return "core/errors/error";
+  }
+
+  protected GeoNetworkError getError(HttpServletRequest request) {
+    Integer status = (Integer) request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE);
+    Exception exception = (Exception) request.getAttribute(RequestDispatcher.ERROR_EXCEPTION);
+    String errorMessage = (String) request.getAttribute(RequestDispatcher.ERROR_MESSAGE);
+    String path = (String) request.getAttribute(RequestDispatcher.ERROR_REQUEST_URI);
+    return new GeoNetworkError(exception, errorMessage, HttpStatus.valueOf(status), path);
+  }
+
+  @Override
+  public String getErrorPath() {
+    return null;
+  }
+}