Merge pull request #61 from rmcdouga/20260228_AF_Cookie_Support

Add cookie support into Adaptive Forms rendering client code

Author: rmcdouga

rest-services/client/src/main/java/com/_4point/aem/docservices/rest_services/client/RestClient.java

@@ -159,6 +159,7 @@ default Builder addStringVersion(String fieldName, List<?> fieldData) {
 			}
 			Builder queryParam(String name, String value);
 			Builder addHeader(String name, String value);
+			Builder addCookies(Cookies cookies);
 			MultipartPayload build();
 		}
 	}
@@ -190,6 +191,7 @@ public interface GetRequest {
 		public interface Builder {
 			Builder queryParam(String name, String value);
 			Builder addHeader(String name, String value);
+			Builder addCookies(Cookies cookies);
 			GetRequest build();
 		}
 	}
@@ -209,6 +211,11 @@ public interface Builder {
 	 */
 	public GetRequest.Builder getRequestBuilder(String additionalPath);
 
+	public interface Cookies {
+		public boolean isEmpty();
+		public boolean isPresent();
+	};
+
 	/**
 	 * A response from the AEM Rest Service
 	 */
@@ -235,9 +242,44 @@ public interface Response {
 		 * @return
 		 */
 		public Optional<String> retrieveHeader(String header);
-		
+
+		public HttpHeaders headers();
+
+		public Cookies getCookies();
 	}
 
+	/**
+	 * Represents an HTTP header as a name / value pair.  
+	 * 
+	 * Note that there may be multiple headers with the same name, so HttpHeaders.getHeaders() returns a 
+	 * List<HttpHeader> rather than a single HttpHeader.
+	 */
+	public record HttpHeader(String name, String value) {};
+	
+	public interface HttpHeaders {
+		public enum CaseHandling {
+			PRESERVES_CASE, DOWNSHIFTS, UPSHIFTS;
+		}
+		
+		/**
+		 * 
+		 * Indicates how this implementation handles the case of HTTP header names.  
+		 * This is important to know when calling getHeaders() since HTTP header names are case-insensitive, 
+		 * but the actual case used may vary based on the implementation.
+	 	 * 
+		 * PRESERVES_CASE means that the header names are returned in the same case as they were sent by the server.
+		 * DOWNSHIFTS means that the header names are returned in all lower case.
+		 * UPSHIFTS means that the header names are returned in all upper case.
+		 *
+		 * @return How this implementation handles the case of HTTP header names.  
+		 * 
+		 */
+		public CaseHandling caseHandling();
+		
+		
+		public List<HttpHeader> getHeaders(String headerName);
+	}
+	
     @SuppressWarnings("serial")
 	public static class RestClientException extends Exception {
 

rest-services/client/src/main/java/com/_4point/aem/docservices/rest_services/client/af/AdaptiveFormsService.java

@@ -11,6 +11,7 @@
 
 import com._4point.aem.docservices.rest_services.client.RestClient;
 import com._4point.aem.docservices.rest_services.client.RestClient.ContentType;
+import com._4point.aem.docservices.rest_services.client.RestClient.Cookies;
 import com._4point.aem.docservices.rest_services.client.RestClient.GetRequest;
 import com._4point.aem.docservices.rest_services.client.RestClient.MultipartPayload;
 import com._4point.aem.docservices.rest_services.client.RestClient.Response;
@@ -106,7 +107,9 @@ public Document renderAdaptiveForm(PathOrUrl template, Document data) throws Ada
 		builder = builder.queryParam("wcmmode", "disabled");
 
 		if (!data.isEmpty()) {
-			builder = builder.queryParam(DATA_REF_PARAM, generateDataRefParam(postDataToDataCacheService(data)));
+			DataCacheResponse response = postDataToDataCacheService(data);
+			builder = builder.queryParam(DATA_REF_PARAM, generateDataRefParam(response.uuid()))
+							 .addCookies(response.cookies());
 		}
 
 		GetRequest getRequest = builder.build();
@@ -128,12 +131,14 @@ private String generateDataRefParam(String uuid) {
 		return "service://FFPrefillService/" + uuid;
 	}
 
-	private String postDataToDataCacheService(Document data) throws AdaptiveFormsServiceException {
+	private record DataCacheResponse(String uuid, Cookies cookies) {}
+	
+	private DataCacheResponse postDataToDataCacheService(Document data) throws AdaptiveFormsServiceException {
         try (MultipartPayload payload = dataCacheRestClient.multipartPayloadBuilder()
         												   .add(DATA_SERVICE_DATA_PARAM, data, getContentType(data))
         												   .build()) {
 			return payload.postToServer(ContentType.TEXT_PLAIN)
-						  .map(uncheck(AdaptiveFormsService::responseToString))
+						  .map(uncheck(AdaptiveFormsService::mapResponse))
 						  .orElseThrow();
 
         } catch (IOException e) {
@@ -152,8 +157,8 @@ private static ContentType getContentType(Document data) {
 		}
 	}
 
-	private static String responseToString(Response result) throws IOException {
-		return new String(result.data().readAllBytes());
+	private static DataCacheResponse mapResponse(Response result) throws IOException {
+		return new DataCacheResponse(new String(result.data().readAllBytes()), result.getCookies());
 	}
 
 	/**

rest-services/client/src/test/java/com/_4point/aem/docservices/rest_services/client/RestClientTest.java

@@ -14,6 +14,7 @@
 import org.junit.jupiter.params.provider.EnumSource;
 
 import com._4point.aem.docservices.rest_services.client.RestClient.ContentType;
+import com._4point.aem.docservices.rest_services.client.RestClient.Cookies;
 import com._4point.aem.docservices.rest_services.client.RestClient.MultipartPayload;
 import com._4point.aem.docservices.rest_services.client.RestClient.MultipartPayload.Builder;
 import com._4point.aem.fluentforms.api.Document;
@@ -69,6 +70,11 @@ public Builder addHeader(String name, String value) {
 		public MultipartPayload build() {
 			throw new UnsupportedOperationException("Not implemented");
 		}
+
+		@Override
+		public Builder addCookies(Cookies cookies) {
+			throw new UnsupportedOperationException("Not implemented");
+		}
 	};
 
 	private final MockBuilder underTest = new MockBuilder();

rest-services/client/src/test/java/com/_4point/aem/docservices/rest_services/client/af/AdaptiveFormsServiceTest.java

@@ -28,6 +28,7 @@
 
 import com._4point.aem.docservices.rest_services.client.RestClient;
 import com._4point.aem.docservices.rest_services.client.RestClient.ContentType;
+import com._4point.aem.docservices.rest_services.client.RestClient.Cookies;
 import com._4point.aem.docservices.rest_services.client.RestClient.GetRequest;
 import com._4point.aem.docservices.rest_services.client.RestClient.MultipartPayload;
 import com._4point.aem.docservices.rest_services.client.RestClient.Response;
@@ -62,6 +63,7 @@ class AdaptiveFormsServiceTest {
 	@Mock(stubOnly = true) GetRequest.Builder mockGetRequestBuilder;
 	@Mock(stubOnly = true) Response mockPostResponse;
 	@Mock(stubOnly = true) Response mockGetResponse;
+	@Mock(stubOnly = true) Cookies mockCookies;
 
 	@Captor ArgumentCaptor<AemConfig> aemConfig;
 	@Captor ArgumentCaptor<String> servicePath;
@@ -172,6 +174,7 @@ void testRenderAdaptiveForm(HappyPath scenario) throws Exception {
 			setupDataServiceMocks(setupMockPostResponse(DUMMY_GUID.getBytes(), ContentType.TEXT_PLAIN));
 			when(mockPayloadBuilder.add(eq("Data"), Mockito.any(Document.class), eq(scenario.contentType))).thenReturn(mockPayloadBuilder);
 			when(mockGetRequestBuilder.queryParam(eq("dataRef"), eq("service://FFPrefillService/" + DUMMY_GUID))).thenReturn(mockGetRequestBuilder);
+			when(mockGetRequestBuilder.addCookies(Mockito.any(Cookies.class))).thenReturn(mockGetRequestBuilder);
 		}
 
 		AdaptiveFormsService underTest = createAdapter(mockClientFactory);
@@ -210,6 +213,7 @@ private void setupFilterMocks(byte[] responseData) throws RestClientException {
 		setupDataServiceMocks(setupMockPostResponse(DUMMY_GUID.getBytes(), ContentType.TEXT_PLAIN));
 		when(mockPayloadBuilder.add(eq("Data"), Mockito.any(Document.class), Mockito.any(ContentType.class))).thenReturn(mockPayloadBuilder);
 		when(mockGetRequestBuilder.queryParam(eq("dataRef"), eq("service://FFPrefillService/" + DUMMY_GUID))).thenReturn(mockGetRequestBuilder);
+		when(mockGetRequestBuilder.addCookies(Mockito.any(Cookies.class))).thenReturn(mockGetRequestBuilder);
 	}
 
 	@Test
@@ -258,6 +262,7 @@ private void setupAfServiceMocks(String form, Optional<Response> mockedResponse)
 	private Optional<Response> setupMockPostResponse(byte[] responseData, ContentType expectedContentType) {
 //		when(mockPostResponse.contentType()).thenReturn(expectedContentType);	// ContentType is not queries.
 		when(mockPostResponse.data()).thenReturn(new ByteArrayInputStream(responseData));
+		when(mockPostResponse.getCookies()).thenReturn(mockCookies);
 		return Optional.of(mockPostResponse);
 	}
 

rest-services/client/src/test/java/com/_4point/aem/docservices/rest_services/client/docassurance/RestServicesDocAssuranceServiceAdapterTest.java

@@ -225,6 +225,11 @@ public MultipartPayload.Builder add(String fieldName, byte[] fieldData, ContentT
 					public MultipartPayload.Builder add(String fieldName, String fieldData) {
 						throw new UnsupportedOperationException("This version of add() should never be called.");
 					}
+
+					@Override
+					public MultipartPayload.Builder addCookies(Cookies cookies) {
+						throw new UnsupportedOperationException("This version of add() should never be called.");
+					}
 				};
 			}