Upgrade to Vert.x 5

Author: tsegismont

README.adoc

@@ -59,10 +59,10 @@ include::src/main/java/howto/oauth_oidc/MainVerticle.java[]
 
 <1> We will read the secrets as environment variables
 <2> In order to use a handlebars we first need to create an engine
-<3> To simplify the development of the web components we use a Router to route all HTTP requests to organize our code in a reusable way.
+<3> To simplify the development of the web components we use a `Router` to route all HTTP requests to organize our code in a reusable way.
 <4> Entry point to the application, this will render a custom template.
 <5> The protected resource (not really protected yet)
-<6> We now configure the oauth2 handler, it will setup the callback handler (as defined in GitHub Application panel)
+<6> We now configure the OAuth2 handler, it will set up the callback handler (as defined in GitHub Application panel)
 <7> For this resource we require that users have the authority to retrieve the user emails
 <8> Start up the server
 
@@ -95,7 +95,7 @@ All this is taken care for you by the handler.
 Before the `User` object is handled to you, if your handler was configured with `authorities` they will be first checked.
 If they are not present then the whole process is aborted with an `Authorization (403)` error.
 
-However you might want to assert for other granted authorities, in this case you would add a intermediate handler such as:
+However, you might want to assert for other granted authorities, in this case you would add an intermediate handler such as:
 
 [source,java]
 ----
@@ -157,7 +157,7 @@ This can be achieved with the stock handlers, so our server file would be:
 include::src/main/java/howto/oauth_oidc/MainPersistentVerticle.java[tags=persistent]
 ----
 
-<1> A session handler using in memory storage will now be able to keep track of active users and you will not need to re-login on each request.
+<1> A session handler using in memory storage will now be able to keep track of active users, and you will not need to re-login on each request.
 
 
 === Why persistence is important?

pom.xml

@@ -10,9 +10,9 @@
 
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    <vertx.version>4.1.0</vertx.version>
+    <vertx.version>5.0.0.CR2</vertx.version>
     <main.verticle>howto.oauth_oidc.MainVerticle</main.verticle>
-    <launcher.class>io.vertx.core.Launcher</launcher.class>
+    <launcher.class>io.vertx.launcher.application.VertxApplication</launcher.class>
   </properties>
 
   <dependencyManagement>
@@ -28,6 +28,10 @@
   </dependencyManagement>
 
   <dependencies>
+    <dependency>
+      <groupId>io.vertx</groupId>
+      <artifactId>vertx-launcher-application</artifactId>
+    </dependency>
     <dependency>
       <groupId>io.vertx</groupId>
       <artifactId>vertx-web-client</artifactId>
@@ -89,9 +93,8 @@
         <artifactId>exec-maven-plugin</artifactId>
         <version>3.5.0</version>
         <configuration>
-          <mainClass>io.vertx.core.Launcher</mainClass>
+          <mainClass>${launcher.class}</mainClass>
           <arguments>
-            <argument>run</argument>
             <argument>${main.verticle}</argument>
           </arguments>
         </configuration>

src/main/java/howto/oauth_oidc/KeycloakDiscoverVerticle.java

@@ -15,7 +15,7 @@ public class KeycloakDiscoverVerticle extends AbstractVerticle {
   @Override
   public void start(Promise<Void> startPromise) {
     OAuth2Options options = new OAuth2Options()
-      .setClientID(CLIENT_ID)
+      .setClientId(CLIENT_ID)
       .setClientSecret(CLIENT_SECRET)
       .setTenant("vertx-test")          // <1>
       .setSite("https://your.keycloak.instance/auth/realms/{tenant}"); // <2>

src/main/java/howto/oauth_oidc/MainPersistentVerticle.java

@@ -1,7 +1,7 @@
 package howto.oauth_oidc;
 
-import io.vertx.core.AbstractVerticle;
-import io.vertx.core.Promise;
+import io.vertx.core.Future;
+import io.vertx.core.VerticleBase;
 import io.vertx.ext.auth.authentication.TokenCredentials;
 import io.vertx.ext.auth.oauth2.OAuth2Auth;
 import io.vertx.ext.auth.oauth2.providers.GithubAuth;
@@ -13,7 +13,7 @@
 import io.vertx.ext.web.sstore.LocalSessionStore;
 import io.vertx.ext.web.templ.handlebars.HandlebarsTemplateEngine;
 
-public class MainPersistentVerticle extends AbstractVerticle {
+public class MainPersistentVerticle extends VerticleBase {
 
   private static final String CLIENT_ID =
     System.getenv("GITHUB_CLIENT_ID");
@@ -22,7 +22,7 @@ public class MainPersistentVerticle extends AbstractVerticle {
 
   // tag::persistent[]
   @Override
-  public void start(Promise<Void> startPromise) {
+  public Future<?> start() {
 
     HandlebarsTemplateEngine engine =
       HandlebarsTemplateEngine.create(vertx);
@@ -59,7 +59,7 @@ public void start(Promise<Void> startPromise) {
           .withScope("user:email"))
       .handler(ctx -> {
         authProvider
-          .userInfo(ctx.user())
+          .userInfo(ctx.user().get())
           .onFailure(err -> {
             ctx.session().destroy();
             ctx.fail(err);
@@ -68,7 +68,7 @@ public void start(Promise<Void> startPromise) {
             // fetch the user emails from the github API
             WebClient.create(ctx.vertx())
               .getAbs("https://api.github.com/user/emails")
-              .authentication(new TokenCredentials(ctx.user().<String>get("access_token"))) // <2>
+              .authentication(new TokenCredentials(ctx.user().get().<String>get("access_token"))) // <2>
               .as(BodyCodec.jsonArray())
               .send()
               .onFailure(err -> {
@@ -91,13 +91,9 @@ public void start(Promise<Void> startPromise) {
           });
       });
 
-    vertx.createHttpServer()
+    return vertx.createHttpServer()
       .requestHandler(router)
       .listen(Integer.getInteger("port", 8080))
-      .onSuccess(server -> {
-        System.out.println(
-          "HTTP server started on port: " + server.actualPort());
-        startPromise.complete();
-      }).onFailure(startPromise::fail);
+      .onSuccess(server -> System.out.println("HTTP server started on port: " + server.actualPort()));
   }
 }

src/main/java/howto/oauth_oidc/MainVerticle.java

@@ -1,22 +1,22 @@
 package howto.oauth_oidc;
 
-import io.vertx.core.AbstractVerticle;
-import io.vertx.core.Promise;
+import io.vertx.core.Future;
+import io.vertx.core.VerticleBase;
 import io.vertx.ext.auth.oauth2.OAuth2Auth;
 import io.vertx.ext.auth.oauth2.providers.GithubAuth;
 import io.vertx.ext.web.Router;
 import io.vertx.ext.web.handler.OAuth2AuthHandler;
 import io.vertx.ext.web.templ.handlebars.HandlebarsTemplateEngine;
 
-public class MainVerticle extends AbstractVerticle {
+public class MainVerticle extends VerticleBase {
 
   private static final String CLIENT_ID =
     System.getenv("GITHUB_CLIENT_ID");
   private static final String CLIENT_SECRET =
     System.getenv("GITHUB_CLIENT_SECRET");  // <1>
 
   @Override
-  public void start(Promise<Void> startPromise) {
+  public Future<?> start() {
 
     HandlebarsTemplateEngine engine =
       HandlebarsTemplateEngine.create(vertx);     // <2>
@@ -49,13 +49,9 @@ public void start(Promise<Void> startPromise) {
           .end("Hello protected!");
       });
 
-    vertx.createHttpServer()                      // <8>
+    return vertx.createHttpServer()                      // <8>
       .requestHandler(router)
       .listen(Integer.getInteger("port", 8080))
-      .onSuccess(server -> {
-        System.out.println(
-          "HTTP server started on port: " + server.actualPort());
-        startPromise.complete();
-      }).onFailure(startPromise::fail);
+      .onSuccess(server -> System.out.println("HTTP server started on port: " + server.actualPort()));
   }
 }

src/main/java/howto/oauth_oidc/ProtectedProfileHandler.java

@@ -21,7 +21,7 @@ class ProtectedProfileHandler implements Handler<RoutingContext> {
   @Override
   public void handle(RoutingContext ctx) {
     authProvider
-      .userInfo(ctx.user())       // <1>
+      .userInfo(ctx.user().get())       // <1>
       .onFailure(err -> {
         ctx.session().destroy();
         ctx.fail(err);
@@ -30,7 +30,7 @@ public void handle(RoutingContext ctx) {
         // fetch the user emails from the github API
         WebClient.create(ctx.vertx())
           .getAbs("https://api.github.com/user/emails")
-          .authentication(new TokenCredentials(ctx.user().<String>get("access_token"))) // <2>
+          .authentication(new TokenCredentials(ctx.user().get().<String>get("access_token"))) // <2>
           .as(BodyCodec.jsonArray())
           .send()
           .onFailure(err -> {