#284: support for synchronous rest client using http client (#410)

Author: hohwille

boms/minimal/pom.xml

@@ -261,6 +261,11 @@
         <artifactId>devon4j-starter-http-client-rest-async</artifactId>
         <version>${project.version}</version>
       </dependency>
+      <dependency>
+        <groupId>com.devonfw.java.starters</groupId>
+        <artifactId>devon4j-starter-http-client-rest-sync</artifactId>
+        <version>${project.version}</version>
+      </dependency>
     </dependencies>
   </dependencyManagement>
 

documentation/guide-service-client.asciidoc

@@ -18,11 +18,20 @@ You need to add (at least one of) these dependencies to your application:
   <groupId>com.devonfw.java.starters</groupId>
   <artifactId>devon4j-starter-http-client-rest-async</artifactId>
 </dependency>
-<!-- Starter for synchronous consuming REST services via Apache CXF (Java8+) -->
+<!-- Starter for synchronous consuming REST services via Jaca HTTP Client (Java11+) -->
+<dependency>
+  <groupId>com.devonfw.java.starters</groupId>
+  <artifactId>devon4j-starter-http-client-rest-sync</artifactId>
+</dependency>
+<!-- Starter for synchronous consuming REST services via Apache CXF (Java8+) 
+  NOTE: This is an alternative to devon4j-starter-http-client-rest-sync
+  -->
+<!--
 <dependency>
   <groupId>com.devonfw.java.starters</groupId>
   <artifactId>devon4j-starter-cxf-client-rest</artifactId>
 </dependency>
+-->
 <!-- Starter for synchronous consuming SOAP services via Apache CXF (Java8+) -->
 <dependency>
   <groupId>com.devonfw.java.starters</groupId>

modules/cxf-client-rest/src/main/java/com/devonfw/module/cxf/common/impl/client/rest/SyncServiceClientFactoryCxfRest.java

@@ -5,7 +5,6 @@
 import java.util.List;
 
 import javax.inject.Inject;
-import javax.ws.rs.Path;
 
 import org.apache.cxf.jaxrs.client.Client;
 import org.apache.cxf.jaxrs.client.ClientConfiguration;
@@ -15,7 +14,8 @@
 import com.devonfw.module.cxf.common.impl.client.SyncServiceClientFactoryCxf;
 import com.devonfw.module.service.common.api.client.context.ServiceContext;
 import com.devonfw.module.service.common.api.client.sync.SyncServiceClientFactory;
-import com.devonfw.module.service.common.api.constants.ServiceConstants;
+import com.devonfw.module.service.common.base.client.ServiceClientTypeHandler;
+import com.devonfw.module.service.common.base.client.ServiceClientTypeHandlerRest;
 import com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider;
 
 /**
@@ -35,6 +35,12 @@ public SyncServiceClientFactoryCxfRest() {
     super();
   }
 
+  @Override
+  protected ServiceClientTypeHandler getTypeHandler() {
+
+    return ServiceClientTypeHandlerRest.get();
+  }
+
   /**
    * @param jsonProvider the {@link JacksonJsonProvider} to {@link Inject}.
    */
@@ -57,13 +63,9 @@ protected <S> void applyAspects(ServiceContext<S> context, S serviceClient) {
   protected <S> S createService(ServiceContext<S> context, String url) {
 
     List<Object> providers = createProviderList(context);
-    return JAXRSClientFactory.create(url, context.getApi(), providers);
-  }
-
-  @Override
-  protected String getServiceTypeFolderName() {
-
-    return ServiceConstants.URL_FOLDER_REST;
+    S service = JAXRSClientFactory.create(url, context.getApi(), providers);
+    applyAspects(context, service);
+    return service;
   }
 
   @Override
@@ -78,12 +80,6 @@ protected void applyHeaders(ServiceContext<?> context, Object serviceClient) {
     }
   }
 
-  @Override
-  protected boolean isResponsibleForService(ServiceContext<?> context) {
-
-    return context.getApi().isAnnotationPresent(Path.class);
-  }
-
   /**
    * @param context the {@link ServiceContext}.
    * @return the {@link List} of {@link javax.ws.rs.ext.Provider}s.

modules/cxf-client-ws/src/main/java/com/devonfw/module/cxf/common/impl/client/ws/SyncServiceClientFactoryCxfWs.java

@@ -23,7 +23,8 @@
 import com.devonfw.module.service.common.api.client.context.ServiceContext;
 import com.devonfw.module.service.common.api.client.sync.SyncServiceClientFactory;
 import com.devonfw.module.service.common.api.config.ServiceConfig;
-import com.devonfw.module.service.common.api.constants.ServiceConstants;
+import com.devonfw.module.service.common.base.client.ServiceClientTypeHandler;
+import com.devonfw.module.service.common.base.client.ServiceClientTypeHandlerWs;
 
 /**
  * Implementation of {@link SyncServiceClientFactory} for JAX-WS SOAP service clients using Apache CXF.
@@ -32,7 +33,11 @@
  */
 public class SyncServiceClientFactoryCxfWs extends SyncServiceClientFactoryCxf {
 
-  private static final String WSDL_SUFFIX = "?wsdl";
+  @Override
+  protected ServiceClientTypeHandler getTypeHandler() {
+
+    return ServiceClientTypeHandlerWs.get();
+  }
 
   @Override
   protected <S> S createService(ServiceContext<S> context, String url) {
@@ -55,6 +60,7 @@ protected <S> S createService(ServiceContext<S> context, String url) {
       BindingProvider bindingProvider = (BindingProvider) serviceClient;
       bindingProvider.getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, url);
     }
+    applyAspects(context, serviceClient);
     return serviceClient;
   }
 
@@ -71,29 +77,6 @@ protected <S> void applyAspects(ServiceContext<S> context, S serviceClient) {
     applyHeaders(context, cxfClient);
   }
 
-  @Override
-  protected String getServiceTypeFolderName() {
-
-    return ServiceConstants.URL_FOLDER_WEB_SERVICE;
-  }
-
-  @Override
-  protected String getUrl(ServiceContext<?> context) {
-
-    String url = super.getUrl(context);
-    if (!url.endsWith(WSDL_SUFFIX)) {
-      String serviceName = context.getApi().getSimpleName();
-      if (!url.endsWith(serviceName)) {
-        if (!url.endsWith("/")) {
-          url = url + "/";
-        }
-        url = url + serviceName;
-      }
-      url = url + WSDL_SUFFIX;
-    }
-    return url;
-  }
-
   private String getLocalName(Class<?> api, WebService webService) {
 
     String portName = webService.portName();
@@ -125,15 +108,4 @@ protected void applyHeaders(ServiceContext<?> context, Object client) {
     }
   }
 
-  /**
-   * @param context the {@link ServiceContext}.
-   * @return {@code true} if this implementation is responsibe for creating a service client corresponding to the given
-   *         {@link ServiceContext}, {@code false} otherwise.
-   */
-  @Override
-  protected boolean isResponsibleForService(ServiceContext<?> context) {
-
-    return context.getApi().isAnnotationPresent(WebService.class);
-  }
-
 }

modules/cxf-client/src/main/java/com/devonfw/module/cxf/common/impl/client/PartialServiceClientFactoryCxf.java

@@ -1,40 +1,97 @@
 package com.devonfw.module.cxf.common.impl.client;
 
+import javax.inject.Inject;
+
 import org.apache.cxf.interceptor.InterceptorProvider;
 import org.apache.cxf.transport.http.HTTPConduit;
+import org.apache.cxf.transports.http.configuration.HTTPClientPolicy;
 
+import com.devonfw.module.basic.common.api.config.ConfigProperties;
+import com.devonfw.module.cxf.common.impl.client.interceptor.PerformanceStartInterceptor;
+import com.devonfw.module.cxf.common.impl.client.interceptor.PerformanceStopInterceptor;
+import com.devonfw.module.cxf.common.impl.client.interceptor.TechnicalExceptionInterceptor;
+import com.devonfw.module.service.common.api.client.ServiceClientErrorFactory;
 import com.devonfw.module.service.common.api.client.context.ServiceContext;
-import com.devonfw.module.service.common.api.client.sync.SyncServiceClientFactory;
+import com.devonfw.module.service.common.api.config.ServiceConfig;
+import com.devonfw.module.service.common.base.client.AbstractSyncServiceClientFactory;
 
 /**
- * Abstract base implementation of {@link SyncServiceClientFactory} for service clients using Apache CXF.
+ * Abstract base implementation of {@link AbstractSyncServiceClientFactory} for service clients using Apache CXF.
  *
  * @since 3.0.0
  */
-public abstract class SyncServiceClientFactoryCxf extends PartialServiceClientFactoryCxf
-    implements SyncServiceClientFactory {
+public abstract class SyncServiceClientFactoryCxf extends AbstractSyncServiceClientFactory {
+
+  private ServiceClientErrorFactory errorFactory;
+
+  /**
+   * @return the {@link ServiceClientErrorFactory}.
+   */
+  public ServiceClientErrorFactory getErrorFactory() {
+
+    return this.errorFactory;
+  }
 
-  @Override
-  public <S> S create(ServiceContext<S> context) {
+  /**
+   * @param errorFactory new value of {@link #getErrorFactory() errorFactory} to {@link Inject}.
+   */
+  @Inject
+  public void setErrorFactory(ServiceClientErrorFactory errorFactory) {
+
+    this.errorFactory = errorFactory;
+  }
+
+  /**
+   * @param context the {@link ServiceContext}.
+   * @return the {@link HTTPClientPolicy} for the {@link ServiceContext#getConfig() configuration} or {@code null} to
+   *         use defaults.
+   */
+  protected HTTPClientPolicy createClientPolicy(ServiceContext<?> context) {
 
-    boolean responsible = isResponsibleForService(context);
-    if (!responsible) {
-      return null;
+    ConfigProperties timeoutConfig = context.getConfig().getChild(ServiceConfig.KEY_SEGMENT_TIMEOUT);
+    if (!timeoutConfig.isEmpty()) {
+      HTTPClientPolicy policy = new HTTPClientPolicy();
+      Long connectionTimeout = timeoutConfig.getChild(ServiceConfig.KEY_SEGMENT_TIMEOUT_CONNECTION)
+          .getValue(Long.class);
+      if (connectionTimeout != null) {
+        policy.setConnectionTimeout(connectionTimeout.longValue());
+      }
+      Long responseTimeout = timeoutConfig.getChild(ServiceConfig.KEY_SEGMENT_TIMEOUT_RESPONSE).getValue(Long.class);
+      if (responseTimeout != null) {
+        policy.setReceiveTimeout(responseTimeout.longValue());
+      }
+      return policy;
     }
-    String url = getUrl(context);
-    S serviceClient = createService(context, url);
+    return null;
+  }
 
-    applyAspects(context, serviceClient);
-    return serviceClient;
+  /**
+   * Applies CXF interceptors to the given {@code serviceClient}.
+   *
+   * @param context the {@link ServiceContext}.
+   * @param client the {@link InterceptorProvider}.
+   */
+  protected void applyInterceptors(ServiceContext<?> context, InterceptorProvider client) {
+
+    client.getOutInterceptors().add(new PerformanceStartInterceptor());
+    client.getInInterceptors().add(new PerformanceStopInterceptor());
+    client.getInFaultInterceptors().add(new TechnicalExceptionInterceptor(getErrorFactory(), context));
   }
 
   /**
-   * @param <S> the generic type of the {@link ServiceContext#getApi() service API}.
    * @param context the {@link ServiceContext}.
-   * @param url the resolved end-point URL of the service to invoke.
-   * @return a new client stub for the service. See {@link #create(ServiceContext)} for further details.
+   * @param conduit the {@link HTTPConduit} where to apply the {@link HTTPClientPolicy} to.
    */
-  protected abstract <S> S createService(ServiceContext<S> context, String url);
+  protected void applyClientPolicy(ServiceContext<?> context, HTTPConduit conduit) {
+
+    if (conduit == null) {
+      return;
+    }
+    HTTPClientPolicy clientPolicy = createClientPolicy(context);
+    if (clientPolicy != null) {
+      conduit.setClient(clientPolicy);
+    }
+  }
 
   /**
    * Implementations should call the following methods: