Dev/mapper service addition (#56)

yashyashm · web-flow · commit b51e45362ccd · 2025-07-18T12:47:59.000+01:00
* addition of case urn mapper service

* addition of case urn mapper service

* refactor the case mapper urn service
diff --git a/src/integrationTest/java/uk/gov/hmcts/cp/controllers/CourtScheduleControllerIT.java b/src/integrationTest/java/uk/gov/hmcts/cp/controllers/CourtScheduleControllerIT.java
@@ -15,7 +15,9 @@
 
 import java.util.UUID;
 
-import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
diff --git a/src/main/java/uk/gov/hmcts/cp/config/OpenAPIConfiguration.java b/src/main/java/uk/gov/hmcts/cp/config/OpenAPIConfiguration.java
@@ -3,6 +3,7 @@
 import io.swagger.v3.oas.models.OpenAPI;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.web.client.RestTemplate;
 
 @Configuration
 public class OpenAPIConfiguration {
@@ -13,4 +14,9 @@ public class OpenAPIConfiguration {
     public OpenAPI openAPI() {
         return openAPIConfigLoader.openAPI();
     }
+
+    @Bean
+    public RestTemplate restTemplate() {
+        return new RestTemplate();
+    }
 }
diff --git a/src/main/java/uk/gov/hmcts/cp/controllers/CourtScheduleController.java b/src/main/java/uk/gov/hmcts/cp/controllers/CourtScheduleController.java
@@ -1,33 +1,38 @@
 package uk.gov.hmcts.cp.controllers;
 
-import org.apache.commons.text.StringEscapeUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.server.ResponseStatusException;
 import uk.gov.hmcts.cp.openapi.api.CourtScheduleApi;
 import uk.gov.hmcts.cp.openapi.model.CourtScheduleResponse;
+import uk.gov.hmcts.cp.services.CaseUrnMapperService;
 import uk.gov.hmcts.cp.services.CourtScheduleService;
 
+import static uk.gov.hmcts.cp.utils.Utils.sanitizeString;
+
 @RestController
 public class CourtScheduleController implements CourtScheduleApi {
     private static final Logger LOG = LoggerFactory.getLogger(CourtScheduleController.class);
     private final CourtScheduleService courtScheduleService;
+    private final CaseUrnMapperService caseUrnMapperService;
 
-    public CourtScheduleController(final CourtScheduleService courtScheduleService) {
+    public CourtScheduleController(final CourtScheduleService courtScheduleService,
+                                   final CaseUrnMapperService caseUrnMapperService) {
         this.courtScheduleService = courtScheduleService;
+        this.caseUrnMapperService = caseUrnMapperService;
     }
 
     @Override
     public ResponseEntity<CourtScheduleResponse> getCourtScheduleByCaseUrn(final String caseUrn) {
         final String sanitizedCaseUrn;
         final CourtScheduleResponse courtScheduleResponse;
         try {
-            sanitizedCaseUrn = sanitizeCaseUrn(caseUrn);
-            courtScheduleResponse = courtScheduleService.getCourtScheduleByCaseUrn(sanitizedCaseUrn);
+            sanitizedCaseUrn = sanitizeString(caseUrn);
+            courtScheduleResponse = courtScheduleService.getCourtScheduleByCaseId(
+                    caseUrnMapperService.getCaseId(sanitizedCaseUrn));
         } catch (ResponseStatusException e) {
             LOG.atError().log(e.getMessage());
             throw e;
@@ -37,11 +42,4 @@ public ResponseEntity<CourtScheduleResponse> getCourtScheduleByCaseUrn(final Str
                 .contentType(MediaType.APPLICATION_JSON)
                 .body(courtScheduleResponse);
     }
-
-    private String sanitizeCaseUrn(final String urn) {
-        if (urn == null) {
-            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "caseUrn is required");
-        }
-        return StringEscapeUtils.escapeHtml4(urn);
-    }
 }
diff --git a/src/main/java/uk/gov/hmcts/cp/repositories/CourtScheduleRepository.java b/src/main/java/uk/gov/hmcts/cp/repositories/CourtScheduleRepository.java
@@ -6,7 +6,7 @@
 @Repository
 public interface CourtScheduleRepository  {
 
-    CourtScheduleResponse getCourtScheduleByCaseUrn(String caseUrn);
+    CourtScheduleResponse getCourtScheduleByCaseId(String caseUrn);
     void saveCourtSchedule(String caseUrn, CourtScheduleResponse courtScheduleResponse);
     void clearAll();
 
diff --git a/src/main/java/uk/gov/hmcts/cp/repositories/InMemoryCourtScheduleRepositoryImpl.java b/src/main/java/uk/gov/hmcts/cp/repositories/InMemoryCourtScheduleRepositoryImpl.java
@@ -23,7 +23,7 @@ public void saveCourtSchedule(final String caseUrn, final CourtScheduleResponse
         courtScheduleResponseMap.put(caseUrn, courtScheduleResponse);
     }
 
-    public CourtScheduleResponse getCourtScheduleByCaseUrn(final String caseUrn) {
+    public CourtScheduleResponse getCourtScheduleByCaseId(final String caseUrn) {
         if (!courtScheduleResponseMap.containsKey(caseUrn)) {
             saveCourtSchedule(caseUrn, createCourtScheduleResponse());
         }
diff --git a/src/main/java/uk/gov/hmcts/cp/services/CaseUrnMapperService.java b/src/main/java/uk/gov/hmcts/cp/services/CaseUrnMapperService.java
@@ -0,0 +1,68 @@
+package uk.gov.hmcts.cp.services;
+
+import lombok.RequiredArgsConstructor;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.http.HttpEntity;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.MediaType;
+import org.springframework.stereotype.Service;
+import org.springframework.web.client.RestTemplate;
+import org.springframework.web.util.UriComponentsBuilder;
+
+import java.net.URI;
+import java.util.List;
+import java.util.Map;
+import java.util.UUID;
+import java.util.concurrent.ConcurrentHashMap;
+
+@Service
+@RequiredArgsConstructor
+public class CaseUrnMapperService {
+
+    private static final Logger LOG = LoggerFactory.getLogger(CaseUrnMapperService.class);
+
+    private final RestTemplate restTemplate;
+
+    @Value("${service.case-mapper-service.url}")
+    private String caseMapperServiceUrl;
+
+    private static final String CASEURN_ID = "caseurn/{caseurn}";
+
+    private final Map<String, String> caseUrnToCaseIdMap = new ConcurrentHashMap<>();
+
+
+
+    public String getCaseId(final String caseUrn) {
+        return UUID.randomUUID().toString();
+        // This below code is commented out as it is will be used when the case mapper service is available.
+
+/*        try {
+            ResponseEntity<String> responseEntity = restTemplate.exchange(
+                    getCaseIdUrl(caseUrn),
+                    HttpMethod.GET,
+                    getRequestEntity(),
+                    String.class
+            );
+            return responseEntity.hasBody() ? responseEntity.getBody(): Strings.EMPTY;
+        } catch (Exception e) {
+            LOG.atError().log("Error while getting case id from case urn", e);
+        }
+        return null;*/
+    }
+
+    private String getCaseIdUrl(String caseUrn) {
+        return UriComponentsBuilder
+                .fromUri(URI.create(caseMapperServiceUrl))
+                .pathSegment(caseUrn)
+                .buildAndExpand(caseUrn)
+                .toUriString();
+    }
+
+    private HttpEntity<String> getRequestEntity() {
+        HttpHeaders headers = new HttpHeaders();
+        headers.setAccept(List.of(MediaType.APPLICATION_JSON));
+        return new HttpEntity<>(headers);
+    }
+}
diff --git a/src/main/java/uk/gov/hmcts/cp/services/CourtScheduleService.java b/src/main/java/uk/gov/hmcts/cp/services/CourtScheduleService.java
@@ -10,6 +10,8 @@
 import uk.gov.hmcts.cp.openapi.model.CourtScheduleResponse;
 import uk.gov.hmcts.cp.repositories.CourtScheduleRepository;
 
+import static uk.gov.hmcts.cp.utils.Utils.sanitizeString;
+
 @Service
 @RequiredArgsConstructor
 public class CourtScheduleService {
@@ -18,13 +20,13 @@ public class CourtScheduleService {
 
     private final CourtScheduleRepository courtScheduleRepository;
 
-    public CourtScheduleResponse getCourtScheduleByCaseUrn(final String caseUrn) throws ResponseStatusException {
-        if (StringUtils.isEmpty(caseUrn)) {
-            LOG.atWarn().log("No case urn provided");
-            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "caseUrn is required");
+    public CourtScheduleResponse getCourtScheduleByCaseId(final String caseId) throws ResponseStatusException {
+        if (StringUtils.isEmpty(caseId)) {
+            LOG.atWarn().log("No case Id provided");
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "caseId is required");
         }
-        LOG.atWarn().log("NOTE: System configured to return stubbed Court Schedule details. Ignoring provided caseUrn : {}", caseUrn);
-        final CourtScheduleResponse stubbedCourtScheduleResponse = courtScheduleRepository.getCourtScheduleByCaseUrn(caseUrn);
+        LOG.atWarn().log("NOTE: System configured to return stubbed Court Schedule details. Ignoring provided caseId : {}", sanitizeString(caseId));
+        final CourtScheduleResponse stubbedCourtScheduleResponse = courtScheduleRepository.getCourtScheduleByCaseId(caseId);
         LOG.atDebug().log("Court Schedule response: {}", stubbedCourtScheduleResponse);
         return stubbedCourtScheduleResponse;
     }
diff --git a/src/main/java/uk/gov/hmcts/cp/utils/Utils.java b/src/main/java/uk/gov/hmcts/cp/utils/Utils.java
@@ -0,0 +1,16 @@
+package uk.gov.hmcts.cp.utils;
+
+import org.apache.commons.text.StringEscapeUtils;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.server.ResponseStatusException;
+
+public class Utils {
+
+    public static String sanitizeString(final String urn) {
+        if (urn == null) {
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "caseUrn is required");
+        }
+        return StringEscapeUtils.escapeHtml4(urn);
+    }
+
+}
diff --git a/src/main/resources/application.yaml b/src/main/resources/application.yaml
@@ -30,6 +30,10 @@ spring:
 #      key: ${COSMOSDB_KEY}
 #      database: ${COSMOSDB_DATABASE}
 
+service:
+  case-mapper-service:
+    url: https://virtserver.swaggerhub.com/HMCTS-DTS/api-cp-refdata-case-mapper
+
 azure:
   application-insights:
     instrumentation-key: ${rpe.AppInsightsInstrumentationKey:00000000-0000-0000-0000-000000000000}
diff --git a/src/test/java/uk/gov/hmcts/cp/controllers/CourtScheduleControllerTest.java b/src/test/java/uk/gov/hmcts/cp/controllers/CourtScheduleControllerTest.java
@@ -6,14 +6,15 @@
 import org.slf4j.LoggerFactory;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
+import org.springframework.web.client.RestTemplate;
 import org.springframework.web.server.ResponseStatusException;
 import uk.gov.hmcts.cp.openapi.model.CourtSchedule;
 import uk.gov.hmcts.cp.openapi.model.CourtScheduleResponse;
 
 import uk.gov.hmcts.cp.openapi.model.CourtSitting;
 import uk.gov.hmcts.cp.openapi.model.Hearing;
-import uk.gov.hmcts.cp.repositories.CourtScheduleRepository;
 import uk.gov.hmcts.cp.repositories.InMemoryCourtScheduleRepositoryImpl;
+import uk.gov.hmcts.cp.services.CaseUrnMapperService;
 import uk.gov.hmcts.cp.services.CourtScheduleService;
 
 import java.util.UUID;
@@ -33,7 +34,8 @@ class CourtScheduleControllerTest {
     @BeforeEach
     void setUp() {
         CourtScheduleService courtScheduleService = new CourtScheduleService(new InMemoryCourtScheduleRepositoryImpl());
-        courtScheduleController = new CourtScheduleController(courtScheduleService);
+        CaseUrnMapperService caseUrnMapperService  = new CaseUrnMapperService(new RestTemplate());
+        courtScheduleController = new CourtScheduleController(courtScheduleService, caseUrnMapperService);
     }
 
     @Test
diff --git a/src/test/java/uk/gov/hmcts/cp/repositories/CourtScheduleRepositoryTest.java b/src/test/java/uk/gov/hmcts/cp/repositories/CourtScheduleRepositoryTest.java
@@ -25,7 +25,7 @@ void setUp() {
     @Test
     void getCourtScheduleByCaseUrn_shouldReturnCourtScheduleResponse() {
         UUID caseUrn = UUID.randomUUID();
-        CourtScheduleResponse response = courtScheduleRepository.getCourtScheduleByCaseUrn(caseUrn.toString());
+        CourtScheduleResponse response = courtScheduleRepository.getCourtScheduleByCaseId(caseUrn.toString());
 
         assertNotNull(response.getCourtSchedule());
         assertEquals(1, response.getCourtSchedule().size());
diff --git a/src/test/java/uk/gov/hmcts/cp/services/CourtScheduleServiceTest.java b/src/test/java/uk/gov/hmcts/cp/services/CourtScheduleServiceTest.java
@@ -20,7 +20,7 @@ void shouldReturnStubbedCourtScheduleResponse_whenValidCaseUrnProvided() {
         String validCaseUrn = "123-ABC-456";
 
         // Act
-        CourtScheduleResponse response = courtScheduleService.getCourtScheduleByCaseUrn(validCaseUrn);
+        CourtScheduleResponse response = courtScheduleService.getCourtScheduleByCaseId(validCaseUrn);
 
         // Assert
         assertThat(response).isNotNull();
@@ -37,10 +37,10 @@ void shouldThrowBadRequestException_whenCaseUrnIsNull() {
         String nullCaseUrn = null;
 
         // Act & Assert
-        assertThatThrownBy(() -> courtScheduleService.getCourtScheduleByCaseUrn(nullCaseUrn))
+        assertThatThrownBy(() -> courtScheduleService.getCourtScheduleByCaseId(nullCaseUrn))
                 .isInstanceOf(ResponseStatusException.class)
                 .hasMessageContaining("400 BAD_REQUEST")
-                .hasMessageContaining("caseUrn is required");
+                .hasMessageContaining("caseId is required");
     }
 
     @Test
@@ -49,9 +49,9 @@ void shouldThrowBadRequestException_whenCaseUrnIsEmpty() {
         String emptyCaseUrn = "";
 
         // Act & Assert
-        assertThatThrownBy(() -> courtScheduleService.getCourtScheduleByCaseUrn(emptyCaseUrn))
+        assertThatThrownBy(() -> courtScheduleService.getCourtScheduleByCaseId(emptyCaseUrn))
                 .isInstanceOf(ResponseStatusException.class)
                 .hasMessageContaining("400 BAD_REQUEST")
-                .hasMessageContaining("caseUrn is required");
+                .hasMessageContaining("caseId is required");
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public void saveCourtSchedule(final String caseUrn, final CourtScheduleResponse`
`23`	`23`	`courtScheduleResponseMap.put(caseUrn, courtScheduleResponse);`
`24`	`24`	`}`
`25`	`25`
`26`		`- public CourtScheduleResponse getCourtScheduleByCaseUrn(final String caseUrn) {`
	`26`	`+ public CourtScheduleResponse getCourtScheduleByCaseId(final String caseUrn) {`
`27`	`27`	`if (!courtScheduleResponseMap.containsKey(caseUrn)) {`
`28`	`28`	`saveCourtSchedule(caseUrn, createCourtScheduleResponse());`
`29`	`29`	`}`