✨ Updated AdaptiveFormsService to use RestClient

Author: rmcdouga

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

@@ -27,6 +27,7 @@ public record ContentType(String contentType) {
 		public static final ContentType APPLICATION_PDF = ContentType.of("application/pdf");
 		public static final ContentType APPLICATION_XDP = ContentType.of("application/vnd.adobe.xdp+xml");
 		public static final ContentType APPLICATION_XML = ContentType.of("application/xml");
+		public static final ContentType APPLICATION_JSON = ContentType.of("application/json");
 		public static final ContentType TEXT_PLAIN = ContentType.of("text/plain");
 		public static final ContentType TEXT_HTML = ContentType.of("text/html");
 		public static final ContentType APPLICATION_OCTET_STREAM = ContentType.of("application/octet-stream");
@@ -193,6 +194,13 @@ public interface Builder {
 	 */
 	public GetRequest.Builder getRequestBuilder();
 
+	/**
+	 * Returns a builder that is used to construct a GET request.
+	 * 
+	 * @param additionalPath - additional path segments
+	 * @return
+	 */
+	public GetRequest.Builder getRequestBuilder(String additionalPath);
 
 	/**
 	 * A response from the AEM Rest Service

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

@@ -1,39 +1,36 @@
 package com._4point.aem.docservices.rest_services.client.af;
 
-import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStream;
-import java.io.InputStreamReader;
+import java.io.UncheckedIOException;
 import java.nio.file.Path;
 import java.util.List;
 import java.util.Objects;
 import java.util.function.Function;
 import java.util.function.Supplier;
 
-import org.glassfish.jersey.media.multipart.FormDataMultiPart;
-
+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.GetRequest;
+import com._4point.aem.docservices.rest_services.client.RestClient.MultipartPayload;
+import com._4point.aem.docservices.rest_services.client.RestClient.Response;
+import com._4point.aem.docservices.rest_services.client.RestClient.RestClientException;
+import com._4point.aem.docservices.rest_services.client.helpers.AemConfig;
 import com._4point.aem.docservices.rest_services.client.helpers.AemServerType;
 import com._4point.aem.docservices.rest_services.client.helpers.Builder;
 import com._4point.aem.docservices.rest_services.client.helpers.BuilderImpl;
 import com._4point.aem.docservices.rest_services.client.helpers.RestServicesServiceAdapter;
+import com._4point.aem.docservices.rest_services.client.helpers.BuilderImpl.TriFunction;
 import com._4point.aem.fluentforms.api.Document;
 import com._4point.aem.fluentforms.api.PathOrUrl;
 import com._4point.aem.fluentforms.impl.SimpleDocumentFactoryImpl;
 
-import jakarta.ws.rs.client.Client;
-import jakarta.ws.rs.client.Invocation;
-import jakarta.ws.rs.client.WebTarget;
-import jakarta.ws.rs.core.HttpHeaders;
-import jakarta.ws.rs.core.MediaType;
-import jakarta.ws.rs.core.Response;
-import jakarta.ws.rs.core.Response.Status.Family;
-import jakarta.ws.rs.core.Response.StatusType;
-
 /**
  * Adaptive Forms Service for rendering Adaptive Forms.  The forms can be pre-populated with data by passing in an XML data file.
  *
  */
 public class AdaptiveFormsService extends RestServicesServiceAdapter {
+	private static final String AF_FORMS_PATH = "/content/forms/af";
 	// private static final String RENDER_ADAPTIVE_FORM_PATH = "/services/AdaptiveForms/RenderAdaptiveForm";  // Not currently being used.
 	// private static final String TEMPLATE_PARAM = "template";
 	private static final String DATA_CACHE_SERVICE_NAME = "DataServices";
@@ -42,9 +39,13 @@ public class AdaptiveFormsService extends RestServicesServiceAdapter {
 	private static final String DATA_SERVICE_DATA_PARAM = "Data";
 
 	private final Function<InputStream, InputStream> responseFilter; 
+	private final RestClient dataCacheRestClient;
+	private final RestClient afRestClient;
 
-	public AdaptiveFormsService(WebTarget baseTarget, Supplier<String> correlationIdFn, AemServerType aemServerType, Function<InputStream, InputStream> responseFilter) {
-		super(baseTarget, correlationIdFn, aemServerType);
+	AdaptiveFormsService(BuilderImpl builder, Supplier<String> correlationIdFn, Function<InputStream, InputStream> responseFilter) {
+        super(correlationIdFn);
+		this.dataCacheRestClient = builder.createClient(DATA_CACHE_SERVICE_NAME, DATA_CACHE_METHOD_NAME);
+		this.afRestClient = builder.createClient(AF_FORMS_PATH);
 		this.responseFilter = responseFilter;
 	}
 
@@ -101,78 +102,60 @@ public Document renderAdaptiveForm(PathOrUrl template, Document data) throws Ada
 			throw new AdaptiveFormsServiceException("Only relative paths are supported");
 		}
 
-		WebTarget target = baseTarget.path(constructAfPath(template.convertRelativePathToRelativeUrl()))
-									 .queryParam("wcmmode", "disabled");
+		String afPath = constructAfPath(template.convertRelativePathToRelativeUrl());
+		GetRequest.Builder builder = afRestClient.getRequestBuilder(afPath);
+		builder = builder.queryParam("wcmmode", "disabled");
 
 		if (!data.isEmpty()) {
-			target = target.queryParam(DATA_REF_PARAM, generateDataRefParam(postDataToDataCacheService(data)));
+			builder = builder.queryParam(DATA_REF_PARAM, generateDataRefParam(postDataToDataCacheService(data)));
 		}
 
-		Invocation.Builder invokeBuilder = target.request()
-								.accept(MediaType.TEXT_HTML_TYPE);
+		GetRequest getRequest = builder.build();
 
-		if (this.correlationIdFn != null) {
-			invokeBuilder.header(CORRELATION_ID_HTTP_HDR, this.correlationIdFn.get());
-		}
-
-		Response result = invokeBuilder.get();
-
 		try {
-			return responseFilter == null ? responseToDoc(result, MediaType.TEXT_HTML_TYPE, msg->new AdaptiveFormsServiceException(msg))
-										  : responseToDoc(result, MediaType.TEXT_HTML_TYPE, msg->new AdaptiveFormsServiceException(msg), responseFilter);			
-		} catch (IOException e) {
-			String msg = e.getMessage();
-			throw new AdaptiveFormsServiceException("Error while reading Adaptive Form (" + (msg == null ? e.getClass().getName() : msg) + ").", e );
+		return getRequest.getFromServer(ContentType.TEXT_HTML)
+						 .map(responseFilter == null ? d->responseToDoc(d) : d->responseToDoc(d, responseFilter))
+						 .orElseThrow();
+		} catch (RestClientException e) {
+            throw new AdaptiveFormsServiceException("Error while performing GET to server (" + afRestClient.target() + ").", e);
 		}
 	}
 
 	private String constructAfPath(String formName) {
-		return this.aemServerType.pathPrefix() + "/content/forms/af/" + formName + ".html";
+		return "/" + formName + ".html";
 	}
 
 	private String generateDataRefParam(String uuid) {
 		return "service://FFPrefillService/" + uuid;
 	}
 
 	private String postDataToDataCacheService(Document data) throws AdaptiveFormsServiceException {
-
-		WebTarget dataCacheServiceTarget = baseTarget.path(constructStandardPath(DATA_CACHE_SERVICE_NAME, DATA_CACHE_METHOD_NAME));
-
-		try (final FormDataMultiPart multipart = new FormDataMultiPart()) {
-			String contentType = data.getContentType();
-			multipart.field(DATA_SERVICE_DATA_PARAM, data.getInputStream(), contentType != null ? MediaType.valueOf(contentType) : MediaType.APPLICATION_XML_TYPE);
+        try (MultipartPayload payload = dataCacheRestClient.multipartPayloadBuilder()
+        												   .add(DATA_SERVICE_DATA_PARAM, data, getContentType(data))
+        												   .build()) {
+			return payload.postToServer(ContentType.TEXT_PLAIN)
+						  .map(uncheck(AdaptiveFormsService::responseToString))
+						  .orElseThrow();
+
+        } catch (IOException e) {
+            throw new AdaptiveFormsServiceException("I/O Error while generating Adaptive Form. (" + dataCacheRestClient.target() + ").", e);
+        } catch (RestClientException e) {
+            throw new AdaptiveFormsServiceException("Error while POSTing to server (" + dataCacheRestClient.target() + ").", e);
+		}
+	}
 
-			Response result = postToServer(dataCacheServiceTarget, multipart, MediaType.TEXT_PLAIN_TYPE);
-			
-			StatusType resultStatus = result.getStatusInfo();
-			if (!Family.SUCCESSFUL.equals(resultStatus.getFamily())) {
-				String message = "Call to server failed while posting data to dataCache, statusCode='" + resultStatus.getStatusCode() + "', reason='" + resultStatus.getReasonPhrase() + "'.";
-				if (result.hasEntity()) {
-					InputStream entityStream = (InputStream) result.getEntity();
-					message += "\n" + inputStreamtoString(entityStream);
-				}
-				throw new AdaptiveFormsServiceException(message);
-			}
-			
-			if (!result.hasEntity()) {
-				throw new AdaptiveFormsServiceException("Call to dataCache on the server succeeded but server failed to return document with dataKey in it.  This should never happen.");
-			}
-
-			String responseContentType = result.getHeaderString(HttpHeaders.CONTENT_TYPE);
-			if ( responseContentType == null || !MediaType.TEXT_PLAIN_TYPE.isCompatible(MediaType.valueOf(responseContentType))) {
-				String msg = "DataCache response from AEM server was not plain text.  " + (responseContentType != null ? "content-type='" + responseContentType + "'" : "content-type was null") + ".";
-				InputStream entityStream = (InputStream) result.getEntity();
-				msg += "\n" + inputStreamtoString(entityStream);
-				throw new AdaptiveFormsServiceException(msg);
-			}
-
-			return (new BufferedReader(new InputStreamReader(((InputStream)result.getEntity())))).readLine();
-			
-		} catch (IOException | RestServicesServiceException e) {
-			String msg = e.getMessage();
-			throw new AdaptiveFormsServiceException("Error while posting data to dataCache (" + (msg == null ? e.getClass().getName() : msg) + ").", e );
+	private static ContentType getContentType(Document data) {
+		try {
+			String contentType = data.getContentType();
+			return contentType != null ? ContentType.of(contentType) : ContentType.APPLICATION_XML;
+		} catch (IOException e) {
+			throw new UncheckedIOException(e);
 		}
 	}
+
+	private static String responseToString(Response result) throws IOException {
+		return new String(result.data().readAllBytes());
+	}
 
 	/**
 	 * See renderAdaptiveForm(PathOrUrl template, Document data).
@@ -203,17 +186,17 @@ public Document renderAdaptiveForm(Path template, Document data) throws Adaptive
 	 * 
 	 * @return
 	 */
-	public static AdaptiveFormsServiceBuilder builder() {
-		return new AdaptiveFormsServiceBuilder();
+	public static AdaptiveFormsServiceBuilder builder(TriFunction<AemConfig, String, Supplier<String>, RestClient> clientFactory) {
+		return new AdaptiveFormsServiceBuilder(clientFactory);
 	}
 
 	public static class AdaptiveFormsServiceBuilder implements Builder {
-		private final BuilderImpl builder = new BuilderImpl();
+		private final BuilderImpl builder;
 		private Function<InputStream, InputStream> renderResultFilter; 
 
 		// Prevent it from being instantiated outside of this class
-		private AdaptiveFormsServiceBuilder() {
-			super();
+		private AdaptiveFormsServiceBuilder(TriFunction<AemConfig, String, Supplier<String>, RestClient> clientFactory) {
+			this.builder = new BuilderImpl(clientFactory);
 		}
 
 		@Override
@@ -234,12 +217,6 @@ public AdaptiveFormsServiceBuilder useSsl(boolean useSsl) {
 			return this;
 		}
 
-		@Override
-		public AdaptiveFormsServiceBuilder clientFactory(Supplier<Client> clientFactory) {
-			builder.clientFactory(clientFactory);
-			return this;
-		}
-
 		@Override
 		public AdaptiveFormsServiceBuilder basicAuthentication(String username, String password) {
 			builder.basicAuthentication(username, password);
@@ -257,11 +234,6 @@ public Supplier<String> getCorrelationIdFn() {
 			return builder.getCorrelationIdFn();
 		}
 
-		@Override
-		public WebTarget createLocalTarget() {
-			return builder.createLocalTarget();
-		}
-
 		public AdaptiveFormsServiceBuilder addRenderResultFilter(Function<InputStream, InputStream> filter) {
 			this.renderResultFilter = this.renderResultFilter != null 
 															? this.renderResultFilter.andThen(filter)
@@ -290,7 +262,7 @@ public AemServerType getAemServerType() {
 		}
 
 		public AdaptiveFormsService build() {
-			return new AdaptiveFormsService(this.createLocalTarget(), this.getCorrelationIdFn(), this.getAemServerType(), this.getRenderResultFilter());
+			return new AdaptiveFormsService(this.builder, this.getCorrelationIdFn(), this.getRenderResultFilter());
 		}
 	}
 

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

@@ -78,7 +78,7 @@ public AemServerType getAemServerType() {
 		return this.aemServerType;
 	}
 
-	private RestClient createClient(String endpoint) {
+	private RestClient createClientImplementation(String endpoint) {
 		return Objects.requireNonNull(clientFactory, "Client Factory was not provided.").apply(aemConfigBuilder.build(), endpoint, correlationIdFn);
 	}
 
@@ -87,7 +87,11 @@ private String constructStandardPath(String serviceName, String methodName) {
 	}
 
 	public RestClient createClient(String serviceName, String methodName) {
-		return createClient(constructStandardPath(serviceName, methodName));
+		return createClientImplementation(constructStandardPath(serviceName, methodName));
+	}
+	
+	public RestClient createClient(String endpoint) {
+		return createClientImplementation(this.aemServerType.pathPrefix() + endpoint);
 	}
 
 	@FunctionalInterface