extendable clients

Author: SentryMan

http-api/src/main/java/io/avaje/http/api/Client.java

@@ -11,40 +11,54 @@
  * Marker annotation for client.
  *
  * <pre>{@code
+ * @Client
+ * interface CustomerApi {
+ *   ...
+ *   @Get("/{id}")
+ *   Customer getById(long id);
  *
- *   @Client
- *   interface CustomerApi {
- *     ...
- *     @Get("/{id}")
- *     Customer getById(long id);
- *
- *     @Post
- *     long save(Customer customer);
- *   }
+ *   @Post
+ *   long save(Customer customer);
+ * }
  *
  * }</pre>
  *
  * <h3>Client.Import</h3>
- * <p>
- * When the client interface already exists in another module we
- * use <code>Client.Import</code> to generate the client.
- * <p>
- * Specify the <code>@Client.Import</code> on the package or class
- * to refer to the client interface we want to generate.
  *
- * <pre>{@code
+ * <p>When the client interface already exists in another module we use <code>Client.Import</code>
+ * to generate the client.
  *
- *   @Client.Import(types = OtherApi.class)
- *   package org.example;
+ * <p>Specify the <code>@Client.Import</code> on the package or class to refer to the client
+ * interface we want to generate.
+ *
+ * <pre>{@code
+ * @Client.Import(types = OtherApi.class)
+ * package org.example;
  *
  * }</pre>
  */
 @Target(value = TYPE)
 @Retention(value = RUNTIME)
 public @interface Client {
 
+  /**
+   * Flag to set whether to generate a Client Implementation. Set false if the interface exists merely to be extended by
+   * other client interfaces
+   */
+  boolean generate() default true;
+
+  /**
+   * Specify <code>@Client.Import</code> on a package or class to refer to the client interface we
+   * want to generate.
+   *
+   * <pre>{@code
+   * @Client.Import(types = OtherApi.class)
+   * package org.example;
+   *
+   * }</pre>
+   */
   @Target(value = {TYPE, PACKAGE})
-  @Retention(value = RUNTIME)
+  @Retention(RUNTIME)
   @interface Import {
 
     /**

http-generator-client/src/main/java/io/avaje/http/generator/client/ClientProcessor.java

@@ -65,7 +65,9 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment
     readModule();
     for (final Element controller :
         round.getElementsAnnotatedWith(typeElement(ClientPrism.PRISM_TYPE))) {
-      writeClient(controller);
+      if (ClientPrism.getInstanceOn(controller).generate()) {
+        writeClient(controller);
+      }
     }
     for (final var importedElement : round.getElementsAnnotatedWith(typeElement(ImportPrism.PRISM_TYPE))) {
       writeForImported(importedElement);

http-generator-client/src/test/java/io/avaje/http/generator/client/clients/ExampleClient.java

@@ -0,0 +1,6 @@
+package io.avaje.http.generator.client.clients;
+
+import io.avaje.http.api.Client;
+
+@Client
+public interface ExampleClient extends UserClient {}

http-generator-client/src/test/java/io/avaje/http/generator/client/clients/UserClient.java

@@ -0,0 +1,16 @@
+package io.avaje.http.generator.client.clients;
+
+import io.avaje.http.api.BodyString;
+import io.avaje.http.api.Client;
+import io.avaje.http.api.Get;
+import io.avaje.http.api.Post;
+
+@Client(generate = false)
+public interface UserClient {
+
+  @Post("/users")
+  String createUser(@BodyString String body);
+
+  @Get("/users/{userId}")
+  String getUserById(String userId);
+}

http-generator-core/src/main/java/io/avaje/http/generator/core/ControllerReader.java

@@ -31,7 +31,7 @@
 public final class ControllerReader {
 
   private final TypeElement beanType;
-  private final List<Element> interfaces;
+  private final List<TypeElement> interfaces;
   private final List<ExecutableElement> interfaceMethods;
   private final List<String> roles;
   private final List<MethodReader> methods = new ArrayList<>();
@@ -115,17 +115,18 @@ void addImports(boolean withSingleton) {
     }
   }
 
-  private List<Element> initInterfaces() {
-    final List<Element> interfaces = new ArrayList<>();
+  private List<TypeElement> initInterfaces() {
+    final List<TypeElement> superInterfaces = new ArrayList<>();
     for (final TypeMirror anInterface : beanType.getInterfaces()) {
-      final Element ifaceElement = asElement(anInterface);
+      final var ifaceElement = asElement(anInterface);
       final var controller = ControllerPrism.getInstanceOn(ifaceElement);
       if (controller != null && !controller.value().isBlank()
-          || PathPrism.isPresent(ifaceElement)) {
-        interfaces.add(ifaceElement);
+          || PathPrism.isPresent(ifaceElement)
+          || ClientPrism.isPresent(ifaceElement)) {
+        superInterfaces.add(ifaceElement);
       }
     }
-    return interfaces;
+    return superInterfaces;
   }
 
   private List<ExecutableElement> initInterfaceMethods() {
@@ -221,6 +222,10 @@ public void read(boolean withSingleton) {
       }
     }
     readSuper(beanType);
+
+    if (platform().getClass().getSimpleName().contains("Client")) {
+      readInterfaces();
+    }
     deriveIncludeValidation();
     addImports(withSingleton);
   }
@@ -268,6 +273,15 @@ private void readSuper(TypeElement beanType) {
     }
   }
 
+  /** Read methods from interfaces taking into account generics. */
+  private void readInterfaces() {
+    for (final var superInterfaces : interfaces) {
+      for (final var element : ElementFilter.methodsIn(superInterfaces.getEnclosedElements())) {
+        readMethod(element, (DeclaredType) superInterfaces.asType());
+      }
+    }
+  }
+
   private void readMethod(ExecutableElement element) {
     readMethod(element, null);
   }