Publish JPMS/OSGi services, and update documentation

Author: io7m

README.md

@@ -11,8 +11,17 @@ A Java client for the [AdoptOpenJDK REST API](https://api.adoptopenjdk.net/).
 
 ![adoptopenjdk](./src/site/resources/adoptopenjdk.jpg?raw=true)
 
-Usage
-===
+## Features
+
+* Efficient, type-safe access to the AdoptOpenJDK API
+* Clean API/implementation separation for easy API mocking in applications
+* [JPMS](https://openjdk.java.net/projects/jigsaw/spec/)-ready
+* [OSGi](https://www.osgi.org)-ready
+* High coverage automated test suite
+* Apache 2.0 license
+* Fully documented (JavaDOC)
+
+## Usage
 
 Use the following Maven dependencies:
 
@@ -44,3 +53,20 @@ try (var client = clients.createClient()) {
 
 The API operates entirely synchronously and raises checked exceptions on
 failures.
+
+The `net.adoptopenjdk.v3.api.AOV3ClientProviderType` interface is published
+both as a JPMS service and an [OSGi service](https://www.osgi.org) in order to 
+allow for decoupling consumers from the `vanilla` implementation package:
+
+```
+var clients =
+  ServiceLoader.load(AOV3ClientProviderType.class)
+    .findFirst()
+    .orElseThrow(() -> new IllegalStateException(
+      String.format("No implementations of %s are available", AOV3ClientProviderType.class)));
+
+try (var client = clients.createClient()) {
+  var request = client.availableReleases(...);
+  var releases = request.execute();
+}
+```

net.adoptopenjdk.v3.tests/src/test/java/net/adoptopenjdk/v3/tests/AOV3ClientsTest.java

@@ -14,6 +14,7 @@
 
 package net.adoptopenjdk.v3.tests;
 
+import net.adoptopenjdk.v3.api.AOV3ClientProviderType;
 import net.adoptopenjdk.v3.api.AOV3Error;
 import net.adoptopenjdk.v3.api.AOV3ExceptionHTTPRequestFailed;
 import net.adoptopenjdk.v3.api.AOV3ReleaseKind;
@@ -38,6 +39,7 @@
 import java.util.ArrayList;
 import java.util.Map;
 import java.util.Optional;
+import java.util.ServiceLoader;
 
 public final class AOV3ClientsTest
 {
@@ -124,4 +126,15 @@ public void testRequestFailure0()
       );
     }
   }
+
+  @Test
+  public void testService()
+    throws Exception
+  {
+    final var clients =
+      ServiceLoader.load(AOV3ClientProviderType.class)
+        .findFirst()
+        .orElseThrow(() -> new IllegalStateException(
+          String.format("No implementations of %s are available", AOV3ClientProviderType.class)));
+  }
 }

net.adoptopenjdk.v3.vanilla/pom.xml

@@ -42,6 +42,11 @@
       <artifactId>slf4j-api</artifactId>
     </dependency>
 
+    <dependency>
+      <groupId>org.osgi</groupId>
+      <artifactId>org.osgi.service.component.annotations</artifactId>
+      <scope>provided</scope>
+    </dependency>
     <dependency>
       <groupId>org.osgi</groupId>
       <artifactId>org.osgi.annotation.bundle</artifactId>

net.adoptopenjdk.v3.vanilla/src/main/java/module-info.java

@@ -17,9 +17,10 @@
 
 module net.adoptopenjdk.v3.vanilla
 {
+  requires static com.fasterxml.jackson.annotation;
   requires static org.osgi.annotation.bundle;
   requires static org.osgi.annotation.versioning;
-  requires static com.fasterxml.jackson.annotation;
+  requires static org.osgi.service.component.annotations;
 
   requires transitive net.adoptopenjdk.v3.api;
 

net.adoptopenjdk.v3.vanilla/src/main/java/net/adoptopenjdk/v3/vanilla/AOV3Clients.java

@@ -16,6 +16,7 @@
 
 import net.adoptopenjdk.v3.api.AOV3ClientProviderType;
 import net.adoptopenjdk.v3.api.AOV3ClientType;
+import org.osgi.service.component.annotations.Component;
 
 import java.net.http.HttpClient;
 import java.util.Objects;
@@ -25,6 +26,7 @@
  * The default provider of v3 clients.
  */
 
+@Component(service = AOV3ClientProviderType.class)
 public final class AOV3Clients implements AOV3ClientProviderType
 {
   private final Supplier<HttpClient> clients;

net.adoptopenjdk.v3.vanilla/src/main/resources/META-INF/services/net.adoptopenjdk.v3.api.AOV3ClientProviderType

@@ -0,0 +1 @@
+net.adoptopenjdk.v3.vanilla.AOV3Clients

pom.xml

@@ -117,6 +117,11 @@
         <artifactId>org.osgi.annotation.versioning</artifactId>
         <version>1.1.0</version>
       </dependency>
+      <dependency>
+        <groupId>org.osgi</groupId>
+        <artifactId>org.osgi.service.component.annotations</artifactId>
+        <version>1.4.0</version>
+      </dependency>
       <dependency>
         <groupId>org.immutables</groupId>
         <artifactId>value</artifactId>