[MODCON - 65] - Implement endpoint to save shared setting uuid in all tenants

pom.xml

@@ -42,7 +42,7 @@
     <user_events.yaml.file>${project.basedir}/src/main/resources/swagger.api/kafka_message_schemas.yaml</user_events.yaml.file>
     <consortia_configuration.yaml.file>${project.basedir}/src/main/resources/swagger.api/consortia_configuration.yaml</consortia_configuration.yaml.file>
     <publish_coordinator.yaml.file>${project.basedir}/src/main/resources/swagger.api/publications.yaml</publish_coordinator.yaml.file>
-    <sharing_instances.yaml.file>${project.basedir}/src/main/resources/swagger.api/sharing_instance.yaml</sharing_instances.yaml.file>
+    <sharing.yaml.file>${project.basedir}/src/main/resources/swagger.api/sharing.yaml</sharing.yaml.file>
     <!-- runtime dependencies -->
     <folio-spring-base.version>7.1.2</folio-spring-base.version>
     <openapi-generator.version>6.2.1</openapi-generator.version>
@@ -444,12 +444,12 @@
             </configuration>
           </execution>
           <execution>
-            <id>sharing instance</id>
+            <id>sharing</id>
             <goals>
               <goal>generate</goal>
             </goals>
             <configuration>
-              <inputSpec>${sharing_instances.yaml.file}</inputSpec>
+              <inputSpec>${sharing.yaml.file}</inputSpec>
               <output>${project.build.directory}/generated-sources</output>
               <generatorName>spring</generatorName>
               <modelPackage>${project.groupId}.consortia.domain.dto</modelPackage>

src/main/java/org/folio/consortia/controller/SharingInstanceController.java

@@ -26,7 +26,7 @@ public class SharingInstanceController implements SharingApi {
   private final SharingInstanceService sharingInstanceService;
 
   @Override
-  public ResponseEntity<SharingInstance> start(UUID consortiumId, @Validated SharingInstance sharingInstance) {
+  public ResponseEntity<SharingInstance> startSharingInstance(UUID consortiumId, @Validated SharingInstance sharingInstance) {
     return ResponseEntity.status(CREATED).body(sharingInstanceService.start(consortiumId, sharingInstance));
   }
 

src/main/java/org/folio/consortia/controller/SharingSettingController.java

@@ -0,0 +1,30 @@
+package org.folio.consortia.controller;
+
+import static org.springframework.http.HttpStatus.CREATED;
+
+import java.util.UUID;
+
+import org.folio.consortia.domain.dto.SharingSetting;
+import org.folio.consortia.domain.dto.SharingSettingResponse;
+import org.folio.consortia.rest.resource.SharingApi;
+import org.folio.consortia.service.SharingSettingService;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.log4j.Log4j2;
+
+@RestController
+@RequestMapping("/consortia/{consortiumId}")
+@Log4j2
+@RequiredArgsConstructor
+public class SharingSettingController implements SharingApi {
+
+  private final SharingSettingService sharingsettingService;
+
+  @Override
+  public ResponseEntity<SharingSettingResponse> startSharingSetting(UUID consortiumId, SharingSetting sharingSetting) {
+    return ResponseEntity.status(CREATED).body(sharingsettingService.start(consortiumId, sharingSetting));
+  }
+}

src/main/java/org/folio/consortia/domain/entity/SharingSettingEntity.java

@@ -0,0 +1,38 @@
+package org.folio.consortia.domain.entity;
+
+import java.util.Objects;
+import java.util.UUID;
+
+import jakarta.persistence.Entity;
+import jakarta.persistence.Id;
+import jakarta.persistence.Table;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.Setter;
+import lombok.ToString;
+
+@Getter
+@Setter
+@ToString
+@RequiredArgsConstructor
+@Entity
+@Table(name = "sharing_setting")
+public class SharingSettingEntity {
+  @Id
+  private UUID id;
+  private String tenantId;
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o)
+      return true;
+    if (!(o instanceof SharingSettingEntity that))
+      return false;
+    return Objects.equals(id, that.id) && Objects.equals(tenantId, that.tenantId);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(id, tenantId);
+  }
+}

src/main/java/org/folio/consortia/repository/SharingSettingRepository.java

@@ -0,0 +1,11 @@
+package org.folio.consortia.repository;
+
+import java.util.UUID;
+
+import org.folio.consortia.domain.entity.SharingSettingEntity;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface SharingSettingRepository  extends JpaRepository<SharingSettingEntity, UUID>{
+}

src/main/java/org/folio/consortia/service/SharingSettingService.java

@@ -0,0 +1,18 @@
+package org.folio.consortia.service;
+
+import java.util.UUID;
+
+import org.folio.consortia.domain.dto.SharingSetting;
+import org.folio.consortia.domain.dto.SharingSettingResponse;
+
+public interface SharingSettingService {
+
+  /**
+   * Start sharing setting
+   * @param consortiumId UUID of consortium entity
+   * @param sharingSetting the sharingSettingDTO (data transfer object)
+   * @return SharingInstanceDto
+   */
+  SharingSettingResponse start(UUID consortiumId, SharingSetting sharingSetting);
+
+}

src/main/java/org/folio/consortia/service/impl/SharingSettingServiceImpl.java

@@ -0,0 +1,24 @@
+package org.folio.consortia.service.impl;
+
+import java.util.UUID;
+
+import org.folio.consortia.domain.dto.SharingSetting;
+import org.folio.consortia.domain.dto.SharingSettingResponse;
+import org.folio.consortia.repository.SharingSettingRepository;
+import org.folio.consortia.service.SharingSettingService;
+import org.springframework.stereotype.Service;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.log4j.Log4j2;
+
+@Service
+@Log4j2
+@RequiredArgsConstructor
+public class SharingSettingServiceImpl implements SharingSettingService {
+  private final SharingSettingRepository sharingSettingRepository;
+
+  @Override
+  public SharingSettingResponse start(UUID consortiumId, SharingSetting sharingSetting) {
+    return null;
+  }
+}

src/main/resources/db/changelog/changelog-master.xml

@@ -10,4 +10,5 @@
   <include file="changes/create-consortia-configuration-table.xml" relativeToChangelogFile="true"/>
   <include file="changes/create-publish-coordinator-tables.xml" relativeToChangelogFile="true"/>
   <include file="changes/create-sharing-instance-action-table.xml" relativeToChangelogFile="true"/>
+  <include file="changes/create-sharing-setting-table.xml" relativeToChangelogFile="true"/>
 </databaseChangeLog>

src/main/resources/db/changelog/changes/create-sharing-setting-table.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                   xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+                   https://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+
+  <changeSet id="MODCON-65@@Implement endpoint to save shared setting uuid in all tenants" author="azizbekxm">
+
+    <createTable tableName="sharing_instance">
+      <column name="id" type="uuid">
+        <constraints primaryKey="true" primaryKeyName="pk_shared_setting_id"/>
+      </column>
+      <column name="tenant_id" type="text"/>
+      <column name="created_by" type="uuid"/>
+      <column name="created_date" type="timestamp without time zone" defaultValueComputed="now()">
+        <constraints nullable="false"/>
+      </column>
+      <column name="updated_by" type="uuid"/>
+      <column name="updated_date" type="timestamp without time zone"/>
+    </createTable>
+
+  </changeSet>
+</databaseChangeLog>

src/main/resources/swagger.api/schemas/sharingSetting.yaml

@@ -0,0 +1,30 @@
+SharingSetting:
+  description: "A JSON schema for the Sharing settings object"
+  type: object
+  properties:
+    id:
+      type: string
+      format: uuid
+    url:
+      type: string
+    payload:
+      type: string
+  additionalProperties: false
+  required:
+    - id
+    - url
+
+SharingSettingResponse:
+  description: "A JSON schema for the Sharing settings object response for post request"
+  type: object
+  properties:
+    createSettingsPCId:
+      type: string
+      format: uuid
+    updateSettingsPCId:
+      type: string
+      format: uuid
+  additionalProperties: false
+  required:
+    - createSettingsPCId
+    - updateSettingsPCId

src/main/resources/swagger.api/sharing_instance.yaml → src/main/resources/swagger.api/sharing.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
-  title: Sharing instance integration API
-  description: "Sharing instance integration API"
+  title: Sharing instance and setting integration API
+  description: "Sharing instance and setting integration API"
   version: 0.0.1
 servers:
   - url: /consortia/{consortiumId}/
@@ -30,7 +30,7 @@ paths:
           $ref: "#/components/responses/InternalServerError"
     post:
       summary: start instance sharing
-      operationId: start
+      operationId: startSharingInstance
       parameters:
         - $ref: "#/components/parameters/consortiumId"
       requestBody:
@@ -64,6 +64,27 @@ paths:
           $ref: "#/components/responses/NotFound"
         "500":
           $ref: "#/components/responses/InternalServerError"
+  /sharing/settings:
+    post:
+      summary: start setting sharing
+      operationId: startSharingSetting
+      parameters:
+        - $ref: "#/components/parameters/consortiumId"
+      requestBody:
+        $ref: "#/components/requestBodies/SharingSettingBody"
+      responses:
+        "201":
+          $ref: "#/components/responses/SharingSettingResponse"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "404":
+          $ref: "#/components/responses/NotFound"
+        "409":
+          $ref: "#/components/responses/Conflict"
+        "422":
+          $ref: "#/components/responses/Conflict"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
 components:
   requestBodies:
     SharingInstanceBody:
@@ -73,6 +94,13 @@ components:
         application/json:
           schema:
             $ref: "schemas/sharingInstance.yaml#/SharingInstance"
+    SharingSettingBody:
+      description: Sharing settings object
+      required: true
+      content:
+        application/json:
+          schema:
+            $ref: "schemas/sharingSetting.yaml#/SharingSetting"
   responses:
     SharingInstance:
       description: Returns a sharing instance object object
@@ -86,6 +114,12 @@ components:
         application/json:
           schema:
             $ref: "schemas/sharingInstance.yaml#/SharingInstanceCollection"
+    SharingSettingResponse:
+      description: Returns a sharing instance object object
+      content:
+        application/json:
+          schema:
+            $ref: "schemas/sharingSetting.yaml#/SharingSettingResponse"
     NoContent:
       description: No content
     Conflict: