110 bis add an openapi spec inside the project

.gitignore

@@ -33,3 +33,5 @@ out/
 
 ### VS Code ###
 .vscode/
+/.smarttomcat/
+*.trig

README.md

@@ -4,3 +4,13 @@
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3702/badge)](https://bestpractices.coreinfrastructure.org/projects/3702)
 
 An API specification for accessing statistical metadata
+
+## Contribute to Metadata-API
+
+If you contribute to Metadata-API, you may fall in troubles with IntelliJ because the module [`metadata-api-interface`](./interface)
+contains generated source code which can be ignored by IntelliJ and cause failures in `metadata-api-impl` builds. To prevent this, 
+the directory `interface/target/generated-sources/openapi/src/main/java` must be marked as a _Generated Sources Root_. This can be done in two steps :
+1. Run maven clean then maven install for the whole project (all modules)
+2. Two possibilities. Either :
+- by executing the action "Reload All Maven Projects" : the directory is marked automatically
+- by marking the directory manually : right-click on the directory in project explorer > "Mark directory as"

compose.yaml

@@ -0,0 +1,9 @@
+name: metadata-api
+services:
+  graphdb:
+    image: ontotext/graphdb:10.8.4
+    restart: always
+    ports:
+      - "7200:7200"
+    environment:
+      GDB_JAVA_OPTS: "-Xmx1g -Xms512M"

impl/pom.xml

@@ -0,0 +1,119 @@
+<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">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>fr.insee.rmes</groupId>
+        <artifactId>metadata-api-parent</artifactId>
+        <version>3.8.4</version>
+    </parent>
+
+    <artifactId>metadata-api-impl</artifactId>
+
+    <packaging>jar</packaging>
+
+    <dependencies>
+        <dependency>
+            <groupId>fr.insee.rmes</groupId>
+            <artifactId>metadata-api-interface</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-webmvc</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.dataformat</groupId>
+            <artifactId>jackson-dataformat-csv</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.datatype</groupId>
+            <artifactId>jackson-datatype-jsr310</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.openapitools</groupId>
+            <artifactId>jackson-databind-nullable</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.freemarker</groupId>
+            <artifactId>freemarker</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>jakarta.platform</groupId>
+            <artifactId>jakarta.jakartaee-web-api</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>joda-time</groupId>
+            <artifactId>joda-time</artifactId>
+            <version>2.12.7</version>
+        </dependency>
+        <dependency>
+            <groupId>jakarta.ws.rs</groupId>
+            <artifactId>jakarta.ws.rs-api</artifactId>
+            <version>3.1.0</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>testcontainers</artifactId>
+            <version>1.21.3</version>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <annotationProcessorPaths>
+                        <path>
+                            <groupId>org.projectlombok</groupId>
+                            <artifactId>lombok</artifactId>
+                        </path>
+                    </annotationProcessorPaths>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+                <configuration>
+                    <excludes>
+                        <exclude>
+                            <groupId>org.projectlombok</groupId>
+                            <artifactId>lombok</artifactId>
+                        </exclude>
+                    </excludes>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>

impl/src/main/java/fr/insee/rmes/metadata/Metadata.java

@@ -0,0 +1,11 @@
+package fr.insee.rmes.metadata;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class Metadata {
+    public static void main(String[] args) {
+        SpringApplication.run(Metadata.class, args);
+    }
+}

impl/src/main/java/fr/insee/rmes/metadata/api/GeoAireDAttractionDesVillesEndpoints.java

@@ -0,0 +1,53 @@
+package fr.insee.rmes.metadata.api;
+
+import fr.insee.rmes.metadata.api.requestprocessor.RequestProcessor;
+import fr.insee.rmes.metadata.model.AireDAttractionDesVilles2020;
+import fr.insee.rmes.metadata.model.Pays;
+import fr.insee.rmes.metadata.model.TerritoireTousAttributs;
+import fr.insee.rmes.metadata.model.TypeEnumDescendantsAireDAttractionDesVilles;
+import fr.insee.rmes.metadata.queries.parameters.AscendantsDescendantsRequestParametizer;
+import fr.insee.rmes.metadata.queries.parameters.TerritoireRequestParametizer;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+
+import java.time.LocalDate;
+import java.util.List;
+
+
+@Controller
+public class GeoAireDAttractionDesVillesEndpoints implements GeoAireDAttractionDesVillesApi {
+
+    private final RequestProcessor requestProcessor;
+
+    public GeoAireDAttractionDesVillesEndpoints(RequestProcessor requestProcessor) {
+        this.requestProcessor = requestProcessor;
+    }
+
+    @Override
+    public ResponseEntity<AireDAttractionDesVilles2020> getcogaav (String code, LocalDate date) {
+        return requestProcessor.queryforFindTerritoire()
+                .with(new TerritoireRequestParametizer(code, date, AireDAttractionDesVilles2020.class, "none"))
+                .executeQuery()
+                .singleResult(AireDAttractionDesVilles2020.class).toResponseEntity();
+    }
+
+    @Override
+    public ResponseEntity<List<TerritoireTousAttributs>>  getcogaavdesc (String code, LocalDate date, TypeEnumDescendantsAireDAttractionDesVilles type) {
+        return requestProcessor.queryforFindAscendantsDescendants()
+                .with(new AscendantsDescendantsRequestParametizer(code, date, type, AireDAttractionDesVilles2020.class))
+                .executeQuery()
+                .listResult(TerritoireTousAttributs.class)
+                .toResponseEntity();
+    }
+
+    @Override
+    public ResponseEntity<List<AireDAttractionDesVilles2020>> getcogaavliste (LocalDate date) {
+        return requestProcessor.queryforFindTerritoire()
+                .with(new TerritoireRequestParametizer(date, AireDAttractionDesVilles2020.class, "none"))
+                .executeQuery()
+                .listResult(AireDAttractionDesVilles2020.class)
+                .toResponseEntity();
+
+    }
+
+}

impl/src/main/java/fr/insee/rmes/metadata/api/GeoArrondissementEndpoints.java

@@ -0,0 +1,63 @@
+package fr.insee.rmes.metadata.api;
+
+
+import fr.insee.rmes.metadata.api.requestprocessor.RequestProcessor;
+import fr.insee.rmes.metadata.model.Arrondissement;
+import fr.insee.rmes.metadata.model.TerritoireTousAttributs;
+import fr.insee.rmes.metadata.model.TypeEnumAscendantsArrondissement;
+import fr.insee.rmes.metadata.model.TypeEnumDescendantsArrondissement;
+import fr.insee.rmes.metadata.queries.parameters.AscendantsDescendantsRequestParametizer;
+import fr.insee.rmes.metadata.queries.parameters.TerritoireRequestParametizer;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+
+import java.time.LocalDate;
+import java.util.List;
+
+@Controller
+public class GeoArrondissementEndpoints implements GeoArrondissementApi {
+
+    private final RequestProcessor requestProcessor;
+
+    public GeoArrondissementEndpoints(RequestProcessor requestProcessor) {
+        this.requestProcessor = requestProcessor;
+    }
+
+    @Override
+    public ResponseEntity<List<TerritoireTousAttributs>>  getcogarrasc (String code, LocalDate date, TypeEnumAscendantsArrondissement type) {
+        return requestProcessor.queryforFindAscendantsDescendants()
+                .with(new AscendantsDescendantsRequestParametizer(code, date, type, Arrondissement.class))
+                .executeQuery()
+                .listResult(TerritoireTousAttributs.class)
+                .toResponseEntity();
+    }
+
+    @Override
+    public ResponseEntity<Arrondissement> getcogarr(String code, LocalDate date) {
+        return requestProcessor.queryforFindTerritoire()
+                .with(new TerritoireRequestParametizer(code, date, Arrondissement.class, "sousPrefecture"))
+                .executeQuery()
+                .singleResult(Arrondissement.class).toResponseEntity();
+    }
+
+    @Override
+    public ResponseEntity<List<TerritoireTousAttributs>>  getcogarrdes (String code, LocalDate date, TypeEnumDescendantsArrondissement type) {
+        return requestProcessor.queryforFindAscendantsDescendants()
+                .with(new AscendantsDescendantsRequestParametizer(code, date, type, Arrondissement.class))
+                .executeQuery()
+                .listResult(TerritoireTousAttributs.class)
+                .toResponseEntity();
+    }
+
+    @Override
+    public ResponseEntity<List<Arrondissement>> getcogarrliste (LocalDate date) {
+        return requestProcessor.queryforFindTerritoire()
+                .with(new TerritoireRequestParametizer(date, Arrondissement.class, "*"))
+                .executeQuery()
+                .listResult(Arrondissement.class)
+                .toResponseEntity();
+
+    }
+
+}
+

impl/src/main/java/fr/insee/rmes/metadata/api/GeoArrondissementMunipalEndpoints.java

@@ -0,0 +1,51 @@
+package fr.insee.rmes.metadata.api;
+
+import fr.insee.rmes.metadata.api.requestprocessor.RequestProcessor;
+import fr.insee.rmes.metadata.model.*;
+import fr.insee.rmes.metadata.queries.parameters.AscendantsDescendantsRequestParametizer;
+import fr.insee.rmes.metadata.queries.parameters.TerritoireRequestParametizer;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+
+import java.time.LocalDate;
+import java.util.List;
+
+
+@Controller
+public class GeoArrondissementMunipalEndpoints implements GeoArrondissementMunicipalApi {
+
+    private final RequestProcessor requestProcessor;
+
+    public GeoArrondissementMunipalEndpoints(RequestProcessor requestProcessor) {
+        this.requestProcessor = requestProcessor;
+    }
+
+    @Override
+    public ResponseEntity<List<TerritoireTousAttributs>>  getcogarrmuasc (String code, LocalDate date, TypeEnumAscendantsArrondissementMunicipal type) {
+        return requestProcessor.queryforFindAscendantsDescendants()
+                .with(new AscendantsDescendantsRequestParametizer(code, date, type, ArrondissementMunicipal.class))
+                .executeQuery()
+                .listResult(TerritoireTousAttributs.class)
+                .toResponseEntity();
+    }
+
+    @Override
+    public ResponseEntity<ArrondissementMunicipal>  getcogarrmu (String code, LocalDate date) {
+        return requestProcessor.queryforFindTerritoire()
+                .with(new TerritoireRequestParametizer(code, date, ArrondissementMunicipal.class, "none"))
+                .executeQuery()
+                .singleResult(ArrondissementMunicipal.class).toResponseEntity();
+    }
+
+    @Override
+    public ResponseEntity<List<ArrondissementMunicipal>> getcogarrmuliste (LocalDate date) {
+        return requestProcessor.queryforFindTerritoire()
+                .with(new TerritoireRequestParametizer(date, ArrondissementMunicipal.class, "none"))
+                .executeQuery()
+                .listResult(ArrondissementMunicipal.class)
+                .toResponseEntity();
+
+    }
+
+}
+

impl/src/main/java/fr/insee/rmes/metadata/api/GeoBassinDeVieEndpoints.java

@@ -0,0 +1,53 @@
+package fr.insee.rmes.metadata.api;
+
+import fr.insee.rmes.metadata.api.requestprocessor.RequestProcessor;
+import fr.insee.rmes.metadata.model.BassinDeVie2022;
+import fr.insee.rmes.metadata.model.TerritoireTousAttributs;
+import fr.insee.rmes.metadata.model.TypeEnumDescendantsBassinDeVie;
+import fr.insee.rmes.metadata.queries.parameters.AscendantsDescendantsRequestParametizer;
+import fr.insee.rmes.metadata.queries.parameters.TerritoireRequestParametizer;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+
+import java.time.LocalDate;
+import java.util.List;
+
+
+@Controller
+public class GeoBassinDeVieEndpoints implements GeoBassinDeVieApi {
+
+    private final RequestProcessor requestProcessor;
+
+    public GeoBassinDeVieEndpoints(RequestProcessor requestProcessor) {
+        this.requestProcessor = requestProcessor;
+    }
+
+    @Override
+    public ResponseEntity<BassinDeVie2022> getcogbass(String code, LocalDate date) {
+        return requestProcessor.queryforFindTerritoire()
+                .with(new TerritoireRequestParametizer(code, date, BassinDeVie2022.class, "none"))
+                .executeQuery()
+                .singleResult(BassinDeVie2022.class).toResponseEntity();
+    }
+
+    @Override
+    public ResponseEntity<List<TerritoireTousAttributs>>  getcogbassdes (String code, LocalDate date, TypeEnumDescendantsBassinDeVie type) {
+        return requestProcessor.queryforFindAscendantsDescendants()
+                .with(new AscendantsDescendantsRequestParametizer(code, date, type, BassinDeVie2022.class))
+                .executeQuery()
+                .listResult(TerritoireTousAttributs.class)
+                .toResponseEntity();
+    }
+
+    @Override
+    public ResponseEntity<List<BassinDeVie2022>> getcogbassliste (LocalDate date, String filtreNom) {
+        String finalFiltreNom = filtreNom == null ? "*" : filtreNom;
+        return requestProcessor.queryforFindTerritoire()
+                .with(new TerritoireRequestParametizer(date, BassinDeVie2022.class, finalFiltreNom,"none", true))
+                .executeQuery()
+                .listResult(BassinDeVie2022.class)
+                .toResponseEntity();
+
+    }
+
+}