#279 async service client (#280)

Author: hohwille

.travis.yml

@@ -1,7 +1,6 @@
 language: java
 dist: trusty
 jdk:
-  - openjdk8
   - openjdk11
 cache:
   directories:
@@ -19,6 +18,7 @@ env:
     - secure: kJD4+ZMSvJT8W041hR90kxkrkdk/b5A1AkG/7M1W+2OlWz/IBO+lil9yyzVG0Uy7pEa6u7RHRoApy+N2kgnqOOS7Rgc8MRObPyK9SoBXmYH9WNTQIDjYGlfsJcyaCAb1NV0SxWrCKFdEdoVmca8a+qJjhM8Dix92REB7txmvJvq3t0pHIYT3YU2W8pvn4yCORjThipdIRn7cMkr5lhpwSfUyQ/Dal+1bAIsAg3GSAt2k5PeQ/pdlmcLYfSCgdsd7+vXllLXsIP+xSY0A2Sz5QTMQyxTYS8te+o6xJQERyt4HlBiLsjDznPVIMrmiDPciteDtgwJlDzKJ7hJHQxmrIZbZNyXbKqB3rdukspK276/k3YVya6rCwQd9GAUwLMXl1/c2ebFXBvMCjaMaHgf/EVbHQCHrAwy2J/IvtRlKNT4sQfovLmi7NYtKZ0+VStxxDkth/+dSN1lXm+KVmffjinAe9pIDhVFLPFBPR21igigSM+BU2lH6x3TYEJJQNZW8WRHk7qslP6tBmW6RGx41R+05J1qsqrFR4gNfKTMQ6Rg/ooXdo3nwQRM2jrvIGgJLJ8t1CD5WpV5js9QI2yNeQzyIKpDXeaZspKMkh/EUsK/ntfpBsNLfH6+WfKJOi1d/BLro9A9XEjvfkCIS6FyagCJxnewKmei+reEknULQmdo=
     - secure: Sog4Iy1swDx4rYGgOBPM8iDxcRbCWdqE7ngUxbxUgr5fzDki4yI2JGjecIK7BO6TFbCcWuhu3IGsvdY8k2W1DfScEo2tUlWRqPlw/nU89XEUqe8E4zghPyUhFHPAlGt4/TVnkQIxdotcSgJLrmqLQ638/KZHbXJ/HLjnoQfb0BWNWoqRIeduyqivhRJXw2Zd4HhEGaSfm6UN4FBGCmpEkRJOR8kjB4CqWx72G3VXXIjIII9i+l4032ERyJkUdFx7nyABID5/kS9VmFfChirFnzurbPHGYtYwqV4QFm5ZjNnsIh0OIO9Xt4inoIDQy/uELo4gRAJ9S+J8GkSh6UIMGLu6tuUXxxJJKDJuTz4hJ5eBQeO8GGpTkRknrdwRAr/KD0uFjdyUs8yhQ4KAtEhmXzM971zagAdFb2S8yruPOvO6dTWIIvQxvTDWhX5srDr+VZBb3DIPoXbl1oiUjMzo/V8AhK83qmfaqjFTesIEKGTRhAWHpeFEgE3rwT1e2STYNE0m+M7fjcY5/eAbuLMpOpgiBiMAhexgs67yZJanLgmuAscEnGVLgcYP8CJXLJK5sKYAV5Y4peobmnFLcvyeIQDyh+/h/ElOkiq5hmsRtWi+UO73CbTnK6ysTAibS8hGI8KlKB+LcxTOrGcxv/PqdmDGthe36PJttq0LKhWHuUY=
     - secure: HH/mp+PT7xtiLC0JJS73BLPPEt154oeXYMP+N9SqT+q6L6warGGzejhee/yi/WNMrRqt9cFUdEEmWDuNxrakGizJ0YHc4ty430FBcYBGguemJzI/Vl31rLKFI1JnkqsiWskPilrWyClzWyUDp233FQXO0ZXPyhDGPHfSGeDgCtdFqBXz7KUSPQfHiPwRPt6TO/z7JPQe5+b0apSuNWiHjKnCelgjb7QJjC4+9dlYCBe6qJfhHptqZs4yLvSexCzWqfHumhkx1APazjLHQvojukbD01PMWGBCyTWaDrF1CJO4J36nWHnHpvAibnAqVYNHuASQY77BGT6Pt6yx8mXjTbeV/D58JPDqHnGEoZq3Sp8OVkPmwaF1CIOmkBrROk3N2JJ5SLfpOvXmBDz7bhf9WiTVUxQpQABOfIMZkJvjnPP09WXRw5/iow/VwGezkM0z8qR+93/5EooJ7JBqvecOqrxoHnkv76fV54aY0wwwK7VEw4JzldIH7gF6mAMjWA2LYUS+ceU2dG21ok/fffc8bmroLItac8WnT5lu1tU6te6tev9tI7Q6Jm3ZRc+3HFNQUKLApJMcbDc9pt04JHXn3YvENL7hBXBuGYh1ajCc9PPdm8qKf+Xuh4fpMcm/G2FlUpDCwnVOLEBk9qc1QjyIk8y2Ssry4sxBmNVe23xPqsM=
+install: skip
 stages:
   - name: Build
   - name: Documentation

boms/minimal/pom.xml

@@ -130,6 +130,16 @@
         <artifactId>devon4j-cxf-server-ws</artifactId>
         <version>${project.version}</version>
       </dependency>
+      <dependency>
+        <groupId>com.devonfw.java.modules</groupId>
+        <artifactId>devon4j-http-client</artifactId>
+        <version>${project.version}</version>
+      </dependency>
+      <dependency>
+        <groupId>com.devonfw.java.modules</groupId>
+        <artifactId>devon4j-http-client-rest</artifactId>
+        <version>${project.version}</version>
+      </dependency>
       <dependency>
         <groupId>com.devonfw.java.modules</groupId>
         <artifactId>devon4j-jpa-basic</artifactId>
@@ -221,6 +231,11 @@
         <artifactId>devon4j-starter-security-jwt</artifactId>
         <version>${project.version}</version>
       </dependency>
+      <dependency>
+        <groupId>com.devonfw.java.starters</groupId>
+        <artifactId>devon4j-starter-http-client-rest-async</artifactId>
+        <version>${project.version}</version>
+      </dependency>
     </dependencies>
   </dependencyManagement>
 

documentation/guide-service-client.asciidoc

@@ -3,7 +3,7 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
-import com.devonfw.module.service.common.api.sync.SyncServiceClientFactory;
+import com.devonfw.module.service.common.api.client.sync.SyncServiceClientFactory;
 
 /**
  * {@link Configuration} for REST (JAX-RS) clients using Apache CXF.
@@ -14,7 +14,7 @@
 public class CxfRestClientAutoConfiguration {
 
   /**
-   * @return an implemenation of {@link SyncServiceClientFactory} based on CXF for REST (JAX-RS).
+   * @return an implementation of {@link SyncServiceClientFactory} based on CXF for REST (JAX-RS).
    */
   @Bean
   public SyncServiceClientFactory syncServiceClientFactoryCxfRest() {

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

@@ -1,105 +1,57 @@
 package com.devonfw.module.cxf.common.impl.client.rest;
 
-import java.io.IOException;
-import java.util.Map;
-import java.util.UUID;
+import java.net.URI;
 
+import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
 import javax.ws.rs.ext.Provider;
 
-import net.sf.mmm.util.exception.api.ServiceInvocationFailedException;
-
 import org.apache.cxf.jaxrs.client.ResponseExceptionMapper;
 
-import com.devonfw.module.service.common.api.constants.ServiceConstants;
-import com.fasterxml.jackson.databind.ObjectMapper;
+import com.devonfw.module.service.common.api.client.ServiceClientErrorFactory;
+import com.devonfw.module.service.common.api.client.context.ServiceContext;
 
 /**
- * An Implementation of {@link ResponseExceptionMapper} that converts a REST failure {@link Response} compliant with
- * <a href="https://github.com/devonfw/devon4j/blob/develop/documentation/guide-rest.asciidoc#error-results">devonfw REST error specification</a>
- * to a {@link ServiceInvocationFailedException}.
+ * An Implementation of {@link ResponseExceptionMapper} that converts a failure response back to a {@link Throwable}
+ * using {@link ServiceClientErrorFactory}.
  *
  * @since 3.0.0
  */
 @Provider
 public class RestServiceExceptionMapper implements ResponseExceptionMapper<Throwable> {
 
-  private String serviceName;
+  private final ServiceClientErrorFactory errorUnmarshaller;
+
+  private final ServiceContext<?> context;
 
   /**
    * The constructor.
    *
-   * @param service the name (e.g. {@link Class#getName() qualified name}) of the
-   *        {@link com.devonfw.module.service.common.api.Service} that failed.
+   * @param errorUnmarshaller the {@link ServiceClientErrorFactory}.
+   * @param context the {@link ServiceContext}.
    */
-  public RestServiceExceptionMapper(String service) {
+  public RestServiceExceptionMapper(ServiceClientErrorFactory errorUnmarshaller, ServiceContext<?> context) {
 
     super();
-    this.serviceName = service;
+    this.errorUnmarshaller = errorUnmarshaller;
+    this.context = context;
   }
 
   @Override
   public Throwable fromResponse(Response response) {
 
     response.bufferEntity();
     if (response.hasEntity()) {
-      String json = response.readEntity(String.class);
-      if ((json != null) && !json.isEmpty()) {
-        try {
-          ObjectMapper objectMapper = new ObjectMapper();
-          Map<String, Object> jsonMap = objectMapper.readValue(json, Map.class);
-          return createException(jsonMap);
-        } catch (IOException e) {
-          return new ServiceInvocationFailedTechnicalException(e, e.getMessage(), e.getClass().getSimpleName(), null,
-              this.serviceName);
-        }
+      String data = response.readEntity(String.class);
+      if ((data != null) && !data.isEmpty()) {
+        MediaType mediaType = response.getMediaType();
+        URI url = response.getLocation();
+        String operation = null;
+        String serviceDetails = this.context.getServiceDescription(operation, url.toString());
+        return this.errorUnmarshaller.unmarshall(data, mediaType.toString(), response.getStatus(), serviceDetails);
       }
     }
     return null;
   }
 
-  private Throwable createException(Map<String, Object> jsonMap) {
-
-    String code = (String) jsonMap.get(ServiceConstants.KEY_CODE);
-    String message = (String) jsonMap.get(ServiceConstants.KEY_MESSAGE);
-    String uuidStr = (String) jsonMap.get(ServiceConstants.KEY_UUID);
-    UUID uuid = uuidStr != null ? UUID.fromString(uuidStr) : null;
-
-    return createException(code, message, uuid);
-  }
-
-  private Throwable createException(String code, String message, UUID uuid) {
-
-    return new ServiceInvocationFailedException(message, code, uuid, this.serviceName);
-  }
-
-  /**
-   * Extends {@link ServiceInvocationFailedException} as {@link #isTechnical() technical} exception.
-   */
-  private static final class ServiceInvocationFailedTechnicalException extends ServiceInvocationFailedException {
-
-    private static final long serialVersionUID = 1L;
-
-    /**
-     * The constructor.
-     *
-     * @param cause the {@link #getCause() cause} of this exception.
-     * @param message the {@link #getMessage() message}.
-     * @param code the {@link #getCode() code}.
-     * @param uuid {@link UUID} the {@link #getUuid() UUID}.
-     * @param service the name (e.g. {@link Class#getName() qualified name}) of the service that failed.
-     */
-    private ServiceInvocationFailedTechnicalException(Throwable cause, String message, String code, UUID uuid,
-        String service) {
-
-      super(cause, message, code, uuid, service);
-    }
-
-    @Override
-    public boolean isForUser() {
-
-      return false;
-    }
-  }
-
 }

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

@@ -14,8 +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.api.sync.SyncServiceClientFactory;
 import com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider;
 
 /**
@@ -31,6 +31,7 @@ public class SyncServiceClientFactoryCxfRest extends SyncServiceClientFactoryCxf
    * The constructor.
    */
   public SyncServiceClientFactoryCxfRest() {
+
     super();
   }
 
@@ -44,18 +45,18 @@ public void setJsonProvider(JacksonJsonProvider jsonProvider) {
   }
 
   @Override
-  protected <S> void applyAspects(ServiceContext<S> context, S serviceClient, String serviceName) {
+  protected <S> void applyAspects(ServiceContext<S> context, S serviceClient) {
 
     ClientConfiguration clientConfig = WebClient.getConfig(serviceClient);
-    applyInterceptors(context, clientConfig, serviceName);
+    applyInterceptors(context, clientConfig);
     applyClientPolicy(context, clientConfig.getHttpConduit());
     applyHeaders(context, serviceClient);
   }
 
   @Override
-  protected <S> S createService(ServiceContext<S> context, String url, String serviceName) {
+  protected <S> S createService(ServiceContext<S> context, String url) {
 
-    List<Object> providers = createProviderList(context, serviceName);
+    List<Object> providers = createProviderList(context);
     return JAXRSClientFactory.create(url, context.getApi(), providers);
   }
 
@@ -85,16 +86,15 @@ protected boolean isResponsibleForService(ServiceContext<?> context) {
 
   /**
    * @param context the {@link ServiceContext}.
-   * @param serviceName the {@link #createServiceName(ServiceContext) service name}.
    * @return the {@link List} of {@link javax.ws.rs.ext.Provider}s.
    */
-  protected List<Object> createProviderList(ServiceContext<?> context, String serviceName) {
+  protected List<Object> createProviderList(ServiceContext<?> context) {
 
     List<Object> providers = new ArrayList<>();
     if (this.jsonProvider != null) {
       providers.add(this.jsonProvider);
     }
-    providers.add(new RestServiceExceptionMapper(serviceName));
+    providers.add(new RestServiceExceptionMapper(getErrorFactory(), context));
     return providers;
   }
 

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

@@ -3,7 +3,7 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
-import com.devonfw.module.service.common.api.sync.SyncServiceClientFactory;
+import com.devonfw.module.service.common.api.client.sync.SyncServiceClientFactory;
 
 /**
  * {@link Configuration} for SOAP (JAX-WS) clients using Apache CXF.

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

@@ -21,9 +21,9 @@
 
 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.config.ServiceConfig;
 import com.devonfw.module.service.common.api.constants.ServiceConstants;
-import com.devonfw.module.service.common.api.sync.SyncServiceClientFactory;
 
 /**
  * Implementation of {@link SyncServiceClientFactory} for JAX-WS SOAP service clients using Apache CXF.
@@ -35,7 +35,7 @@ public class SyncServiceClientFactoryCxfWs extends SyncServiceClientFactoryCxf {
   private static final String WSDL_SUFFIX = "?wsdl";
 
   @Override
-  protected <S> S createService(ServiceContext<S> context, String url, String serviceName) {
+  protected <S> S createService(ServiceContext<S> context, String url) {
 
     Class<S> api = context.getApi();
     WebService webService = api.getAnnotation(WebService.class);
@@ -59,10 +59,10 @@ protected <S> S createService(ServiceContext<S> context, String url, String serv
   }
 
   @Override
-  protected <S> void applyAspects(ServiceContext<S> context, S serviceClient, String serviceName) {
+  protected <S> void applyAspects(ServiceContext<S> context, S serviceClient) {
 
     Client cxfClient = ClientProxy.getClient(serviceClient);
-    applyInterceptors(context, cxfClient, serviceName);
+    applyInterceptors(context, cxfClient);
     Conduit conduit = cxfClient.getConduit();
     if (conduit instanceof HTTPConduit) {
       HTTPConduit httpConduit = (HTTPConduit) conduit;

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

@@ -1,89 +1,17 @@
 package com.devonfw.module.cxf.common.impl.client;
 
-import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
 
-import com.devonfw.module.service.common.api.client.ServiceClientFactory;
-import com.devonfw.module.service.common.api.client.discovery.ServiceDiscoverer;
-import com.devonfw.module.service.common.api.config.ServiceConfig;
-import com.devonfw.module.service.common.api.header.ServiceHeaderCustomizer;
-import com.devonfw.module.service.common.base.config.ServiceConfigProperties;
-import com.devonfw.module.service.common.impl.ServiceClientFactoryImpl;
-import com.devonfw.module.service.common.impl.discovery.ServiceDiscovererImplConfig;
-import com.devonfw.module.service.common.impl.header.ServiceHeaderCustomizerAuthForward;
-import com.devonfw.module.service.common.impl.header.ServiceHeaderCustomizerBasicAuth;
-import com.devonfw.module.service.common.impl.header.ServiceHeaderCustomizerCorrelationId;
-import com.devonfw.module.service.common.impl.header.ServiceHeaderCustomizerOAuth;
+import com.devonfw.module.service.common.impl.client.ServiceClientAutoConfiguration;
 
 /**
  * {@link Configuration} for REST (JAX-RS) clients using Apache CXF.
  *
  * @since 3.0.0
  */
 @Configuration
-// @Import(ServiceClientSpringFactory.class)
+@Import(ServiceClientAutoConfiguration.class)
 public class CxfClientAutoConfiguration {
 
-  /**
-   * @return the implementation of {@link ServiceClientFactory}.
-   */
-  @Bean
-  public ServiceClientFactory serviceClientFactory() {
-
-    return new ServiceClientFactoryImpl();
-  }
-
-  /**
-   * @return the implementation of {@link ServiceConfig}.
-   */
-  @Bean
-  public ServiceConfig serviceClientConfig() {
-
-    return new ServiceConfigProperties();
-  }
-
-  /**
-   * @return an implementation of {@link ServiceDiscoverer} based on {@link #serviceClientConfig()}.
-   */
-  @Bean
-  public ServiceDiscoverer serviceDiscovererConfig() {
-
-    return new ServiceDiscovererImplConfig();
-  }
-
-  /**
-   * @return an implementation of {@link ServiceHeaderCustomizer} passing correlation ID.
-   */
-  @Bean
-  public ServiceHeaderCustomizer serviceHeaderCustomizerCorrelationId() {
-
-    return new ServiceHeaderCustomizerCorrelationId();
-  }
-
-  /**
-   * @return an implementation of {@link ServiceHeaderCustomizer} for basic authentication support.
-   */
-  @Bean
-  public ServiceHeaderCustomizer serviceHeaderCustomizerBasicAuth() {
-
-    return new ServiceHeaderCustomizerBasicAuth();
-  }
-
-  /**
-   * @return an implementation of {@link ServiceHeaderCustomizer} for OAuth support.
-   */
-  @Bean
-  public ServiceHeaderCustomizer serviceHeaderCustomizerOAuth() {
-
-    return new ServiceHeaderCustomizerOAuth();
-  }
-
-  /**
-   * @return an implementation of {@link ServiceHeaderCustomizer} for JWT support.
-   */
-  @Bean
-  public ServiceHeaderCustomizer serviceHeaderCustomizerAuthForward() {
-
-    return new ServiceHeaderCustomizerAuthForward();
-  }
 }