MODTLR-69 Merge ecs-tlr-feature branch into master

README.md

@@ -9,6 +9,24 @@ Version 2.0. See the file "[LICENSE](LICENSE)" for more information.
 
 FOLIO compatible title level requests functionality.
 
+### Environment variables
+
+| Name                  | Default value             | Description                                                                                                                                                                           |
+|:----------------------|:--------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| JAVA_OPTIONS          | -XX:MaxRAMPercentage=66.0 | Java options                                                                                                                                                                          |
+| DB_HOST               | postgres                  | Postgres hostname                                                                                                                                                                     |
+| DB_PORT               | 5432                      | Postgres port                                                                                                                                                                         |
+| DB_USERNAME           | postgres                  | Postgres username                                                                                                                                                                     |
+| DB_PASSWORD           | postgres                  | Postgres username password                                                                                                                                                            |
+| DB_DATABASE           | okapi_modules             | Postgres database name                                                                                                                                                                |
+| KAFKA_HOST            | kafka                     | Kafka broker hostname                                                                                                                                                                 |
+| KAFKA_PORT            | 9092                      | Kafka broker port                                                                                                                                                                     |
+| SYSTEM_USER_USERNAME  | mod-tlr                   | Username for `mod-tlr` system user                                                                                                                                                    |
+| SYSTEM_USER_PASSWORD  | -                         | Password for `mod-tlr` system user (not required for dev envs)                                                                                                                        |
+| SYSTEM_USER_ENABLED   | true                      | Defines if system user must be created at service tenant initialization                                                                                                               |
+| OKAPI_URL             | -                         | OKAPI URL used to login system user, required                                                                                                                                         |
+| ENV                   | folio                     | The logical name of the deployment, must be unique across all environments using the same shared Kafka/Elasticsearch clusters, `a-z (any case)`, `0-9`, `-`, `_` symbols only allowed |
+
 ## Further information
 
 ### Issue tracker

descriptors/ModuleDescriptor-template.json

@@ -19,10 +19,17 @@
           "modulePermissions": [
             "circulation.requests.instances.item.post",
             "circulation.requests.item.post",
+            "circulation-item.item.get",
+            "circulation-item.collection.get",
+            "circulation-item.item.post",
+            "circulation-item.item.put",
             "search.instances.collection.get",
             "users.item.get",
             "users.collection.get",
-            "users.item.post"
+            "users.item.post",
+            "inventory-storage.service-points.item.get",
+            "inventory-storage.service-points.collection.get",
+            "inventory-storage.service-points.item.post"
           ]
         },
         {
@@ -39,6 +46,29 @@
         }
       ]
     },
+    {
+      "id": "ecs-tlr-allowed-service-points",
+      "version": "1.0",
+      "handlers": [
+        {
+          "methods": ["GET"],
+          "pathPattern": "/tlr/allowed-service-points",
+          "permissionsRequired": [
+            "tlr.ecs-tlr-allowed-service-points.get"
+          ],
+          "modulePermissions": [
+            "circulation.requests.allowed-service-points.get",
+            "users.item.get",
+            "users.collection.get",
+            "search.instances.collection.get",
+            "circulation-storage.requests.item.get",
+            "circulation-storage.requests.collection.get",
+            "consortium-search.items.item.get",
+            "consortium-search.items.collection.get"
+          ]
+        }
+      ]
+    },
     {
       "id": "tlr-settings",
       "version": "1.0",
@@ -151,20 +181,45 @@
         "mod-settings.entries.item.post"
       ],
       "visible": true
+    },
+    {
+      "permissionName": "tlr.ecs-tlr-allowed-service-points.get",
+      "displayName": "ecs-tlr - allowed service points",
+      "description": "Get ECS TLR allowed service points"
     }
   ],
   "requires": [
     {
       "id": "users",
-      "version": "16.0"
+      "version": "16.3"
     },
     {
       "id": "login",
       "version": "7.3"
     },
     {
       "id": "permissions",
-      "version": "5.6"
+      "version": "5.8"
+    },
+    {
+      "id": "circulation",
+      "version": "14.4"
+    },
+    {
+      "id": "transactions",
+      "version": "1.0"
+    },
+    {
+      "id": "ecs-request-transactions",
+      "version": "1.0"
+    },
+    {
+      "id": "search",
+      "version": "1.3"
+    },
+    {
+      "id": "allowed-service-points",
+      "version": "1.0"
     }
   ],
   "launchDescriptor": {
@@ -198,9 +253,6 @@
       { "name": "DB_USERNAME", "value": "folio_admin" },
       { "name": "DB_PASSWORD", "value": "folio_admin" },
       { "name": "DB_DATABASE", "value": "okapi_modules" },
-      { "name": "DB_QUERYTIMEOUT", "value": "60000" },
-      { "name": "DB_CHARSET", "value": "UTF-8" },
-      { "name": "DB_MAXPOOLSIZE", "value": "5" },
       { "name": "SYSTEM_USER_USERNAME", "value": "mod-tlr" },
       { "name": "SYSTEM_USER_PASSWORD", "value": "mod-tlr" },
       { "name": "SYSTEM_USER_ENABLED", "value": "true" }

pom.xml

@@ -4,8 +4,8 @@
   <parent>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-parent</artifactId>
-    <version>3.2.6</version>
-    <relativePath />
+    <version>3.3.0</version>
+    <relativePath/>
   </parent>
   <groupId>org.folio</groupId>
   <artifactId>mod-tlr</artifactId>
@@ -32,8 +32,8 @@
     <argLine />
 
     <!-- runtime dependencies -->
-    <folio-spring-support.version>8.1.2</folio-spring-support.version>
-    <openapi-generator.version>6.2.1</openapi-generator.version>
+    <folio-spring-support.version>8.2.0</folio-spring-support.version>
+    <openapi-generator.version>7.1.0</openapi-generator.version>
     <mapstruct.version>1.5.3.Final</mapstruct.version>
 
     <!-- test dependencies -->
@@ -89,6 +89,10 @@
       <groupId>org.springframework.kafka</groupId>
       <artifactId>spring-kafka</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-cache</artifactId>
+    </dependency>
 
     <dependency>
       <groupId>com.fasterxml.jackson.module</groupId>
@@ -347,6 +351,33 @@
               </configOptions>
             </configuration>
           </execution>
+          <execution>
+            <id>allowed-service-points</id>
+            <goals>
+              <goal>generate</goal>
+            </goals>
+            <configuration>
+              <inputSpec>${project.basedir}/src/main/resources/swagger.api/allowed-service-points.yaml</inputSpec>
+              <output>${project.build.directory}/generated-sources</output>
+              <generatorName>spring</generatorName>
+              <modelPackage>${project.groupId}.domain.dto</modelPackage>
+              <apiPackage>${project.groupId}.rest.resource</apiPackage>
+              <generateApis>true</generateApis>
+              <generateApiTests>true</generateApiTests>
+              <generateApiDocumentation>true</generateApiDocumentation>
+              <generateModels>true</generateModels>
+              <generateModelTests>false</generateModelTests>
+              <generateSupportingFiles>true</generateSupportingFiles>
+              <supportingFilesToGenerate>ApiUtil.java</supportingFilesToGenerate>
+              <generateModelDocumentation>true</generateModelDocumentation>
+              <configOptions>
+                <dateLibrary>java</dateLibrary>
+                <interfaceOnly>true</interfaceOnly>
+                <useSpringBoot3>true</useSpringBoot3>
+                <useTags>true</useTags>
+              </configOptions>
+            </configuration>
+          </execution>
         </executions>
       </plugin>
       <plugin>

src/main/java/org/folio/client/feign/CirculationClient.java

@@ -1,9 +1,12 @@
 package org.folio.client.feign;
 
+import org.folio.domain.dto.AllowedServicePointsResponse;
 import org.folio.domain.dto.Request;
 import org.folio.spring.config.FeignClientConfiguration;
 import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestParam;
 
 @FeignClient(name = "circulation", url = "circulation", configuration = FeignClientConfiguration.class)
 public interface CirculationClient {
@@ -13,4 +16,32 @@ public interface CirculationClient {
 
   @PostMapping("/requests")
   Request createRequest(Request request);
+
+  @GetMapping("/requests/allowed-service-points")
+  AllowedServicePointsResponse allowedServicePointsWithStubItem(
+    @RequestParam("patronGroupId") String patronGroupId, @RequestParam("instanceId") String instanceId,
+    @RequestParam("operation") String operation, @RequestParam("useStubItem") boolean useStubItem);
+
+  @GetMapping("/requests/allowed-service-points")
+  AllowedServicePointsResponse allowedServicePointsWithStubItem(
+    @RequestParam("operation") String operation, @RequestParam("requestId") String requestId,
+    @RequestParam("useStubItem") boolean useStubItem);
+
+  @GetMapping("/requests/allowed-service-points")
+  AllowedServicePointsResponse allowedRoutingServicePoints(
+    @RequestParam("patronGroupId") String patronGroupId, @RequestParam("instanceId") String instanceId,
+    @RequestParam("operation") String operation,
+    @RequestParam("ecsRequestRouting") boolean ecsRequestRouting);
+
+  @GetMapping("/requests/allowed-service-points")
+  AllowedServicePointsResponse allowedRoutingServicePoints(
+    @RequestParam("operation") String operation, @RequestParam("requestId") String requestId,
+    @RequestParam("ecsRequestRouting") boolean ecsRequestRouting);
+
+  @GetMapping("/requests/allowed-service-points")
+  AllowedServicePointsResponse allowedRoutingServicePoints(
+    @RequestParam("patronGroupId") String patronGroupId,
+    @RequestParam("operation") String operation,
+    @RequestParam("ecsRequestRouting") boolean ecsRequestRouting,
+    @RequestParam("itemId") String itemId);
 }

src/main/java/org/folio/client/feign/CirculationItemClient.java

@@ -0,0 +1,27 @@
+package org.folio.client.feign;
+
+import org.folio.domain.dto.CirculationItem;
+import org.folio.spring.config.FeignClientConfiguration;
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+
+@FeignClient(name = "circulation-item", url = "circulation-item",
+  configuration = FeignClientConfiguration.class, dismiss404 = true)
+public interface CirculationItemClient {
+
+  @GetMapping(value = "/{circulationItemId}")
+  CirculationItem getCirculationItem(@PathVariable String circulationItemId);
+
+  @PostMapping(value = "/{circulationItemId}")
+  CirculationItem createCirculationItem(@PathVariable String circulationItemId,
+    @RequestBody CirculationItem circulationItem);
+
+  @PutMapping(value = "/{circulationItemId}")
+  CirculationItem updateCirculationItem(@PathVariable String circulationItemId,
+    @RequestBody CirculationItem circulationItem);
+
+}

src/main/java/org/folio/client/feign/ConsortiaClient.java

@@ -0,0 +1,23 @@
+package org.folio.client.feign;
+
+import org.folio.domain.dto.PublicationRequest;
+import org.folio.domain.dto.PublicationResponse;
+import org.folio.domain.dto.TenantCollection;
+import org.folio.spring.config.FeignClientConfiguration;
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.http.MediaType;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+
+@FeignClient(name = "consortia", url = "consortia", configuration = FeignClientConfiguration.class)
+public interface ConsortiaClient {
+
+  @GetMapping(value = "/{consortiumId}/tenants", produces = MediaType.APPLICATION_JSON_VALUE)
+  TenantCollection getConsortiaTenants(@PathVariable String consortiumId);
+
+  @PostMapping(value = "/{consortiumId}/publications", consumes = MediaType.APPLICATION_JSON_VALUE)
+  PublicationResponse postPublications(@PathVariable String consortiumId,
+    @RequestBody PublicationRequest publicationRequest);
+}

src/main/java/org/folio/client/feign/DcbEcsTransactionClient.java

@@ -0,0 +1,20 @@
+package org.folio.client.feign;
+
+import org.folio.domain.dto.DcbTransaction;
+import org.folio.domain.dto.TransactionStatusResponse;
+import org.folio.spring.config.FeignClientConfiguration;
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+
+@FeignClient(name = "dcb-ecs-transactions", url = "ecs-request-transactions",
+  configuration = FeignClientConfiguration.class)
+
+public interface DcbEcsTransactionClient {
+
+  @PostMapping("/{dcbTransactionId}")
+  TransactionStatusResponse createTransaction(@PathVariable String dcbTransactionId,
+    @RequestBody DcbTransaction dcbTransaction);
+
+}

src/main/java/org/folio/client/feign/DcbClient.java → src/main/java/org/folio/client/feign/DcbTransactionClient.java

@@ -1,27 +1,21 @@
 package org.folio.client.feign;
 
-import org.folio.domain.dto.DcbTransaction;
 import org.folio.domain.dto.TransactionStatus;
 import org.folio.domain.dto.TransactionStatusResponse;
 import org.folio.spring.config.FeignClientConfiguration;
 import org.springframework.cloud.openfeign.FeignClient;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 
-@FeignClient(name = "dcb", url = "${folio.okapi-url}", configuration = FeignClientConfiguration.class)
-public interface DcbClient {
+@FeignClient(name = "dcb-transactions", url = "transactions", configuration = FeignClientConfiguration.class)
+public interface DcbTransactionClient {
 
-  @PostMapping("/ecs-tlr-transactions/{dcbTransactionId}")
-  TransactionStatusResponse createDcbTransaction(@PathVariable String dcbTransactionId,
-    @RequestBody DcbTransaction dcbTransaction);
-
-  @GetMapping("/transactions/{dcbTransactionId}/status")
+  @GetMapping("/{dcbTransactionId}/status")
   TransactionStatusResponse getDcbTransactionStatus(@PathVariable String dcbTransactionId);
 
-  @PutMapping("/transactions/{dcbTransactionId}/status")
+  @PutMapping("/{dcbTransactionId}/status")
   TransactionStatusResponse changeDcbTransactionStatus(@PathVariable String dcbTransactionId,
     @RequestBody TransactionStatus newStatus);
 

src/main/java/org/folio/client/feign/InstanceClient.java

@@ -0,0 +1,15 @@
+package org.folio.client.feign;
+
+import org.folio.domain.dto.InventoryInstance;
+import org.folio.spring.config.FeignClientConfiguration;
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+
+@FeignClient(name = "instances", url = "instance-storage/instances", configuration = FeignClientConfiguration.class)
+public interface InstanceClient {
+
+  @GetMapping("/{id}")
+  InventoryInstance get(@PathVariable String id);
+
+}

src/main/java/org/folio/client/feign/ItemClient.java

@@ -0,0 +1,14 @@
+package org.folio.client.feign;
+
+import org.folio.domain.dto.InventoryItem;
+import org.folio.spring.config.FeignClientConfiguration;
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+
+@FeignClient(name = "items", url = "item-storage/items", configuration = FeignClientConfiguration.class)
+public interface ItemClient {
+
+  @GetMapping("/{id}")
+  InventoryItem get(@PathVariable String id);
+}