Re-Introduce Vert.x Web specific HttpException to reduce API changes

vert-x3 · Oct 20, 2023 · a73b457 · a73b457
1 parent 2342a00
commit a73b457
Show file tree

Hide file tree

Showing 14 changed files with 65 additions and 16 deletions.
diff --git a/vertx-web-api-service/src/main/java/examples/ApiCodegenExamples.java b/vertx-web-api-service/src/main/java/examples/ApiCodegenExamples.java
@@ -12,7 +12,7 @@
 import io.vertx.ext.web.api.service.RouteToEBServiceHandler;
 import io.vertx.ext.web.api.service.ServiceRequest;
 import io.vertx.ext.web.api.service.ServiceResponse;
-import io.vertx.ext.web.common.HttpException;
+import io.vertx.ext.web.handler.HttpException;
 import io.vertx.ext.web.validation.ValidationHandler;
 import io.vertx.ext.web.validation.builder.ValidationHandlerBuilder;
 import io.vertx.json.schema.SchemaRepository;

diff --git a/vertx-web-auth-common/src/main/java/io/vertx/ext/web/common/HttpException.java b/vertx-web-auth-common/src/main/java/io/vertx/ext/web/common/HttpException.java
@@ -28,12 +28,12 @@
  *
  * @author <a href="mailto:plopes@redhat.com">Paulo Lopes</a>
  */
-public final class HttpException extends RuntimeException {
+public class HttpException extends RuntimeException {
 
   public static final HttpException UNAUTHORIZED = new HttpException(401);
   public static final HttpException BAD_REQUEST = new HttpException(400);
   public static final HttpException BAD_METHOD = new HttpException(405);
-  
+
   private final int statusCode;
   private final String payload;
 

diff --git a/vertx-web/pom.xml b/vertx-web/pom.xml
@@ -39,6 +39,12 @@
       <groupId>io.vertx</groupId>
       <artifactId>vertx-auth-common</artifactId>
     </dependency>
+    <!-- Remove this dependency once code got moved to vertx-auth-common -->
+    <dependency>
+      <groupId>io.vertx</groupId>
+      <artifactId>vertx-web-auth-common</artifactId>
+      <version>${project.version}</version>
+    </dependency>
     <dependency>
       <groupId>io.vertx</groupId>
       <artifactId>vertx-web-auth-common</artifactId>

diff --git a/vertx-web/src/main/java/io/vertx/ext/web/handler/HttpException.java b/vertx-web/src/main/java/io/vertx/ext/web/handler/HttpException.java
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2014 Red Hat, Inc.
+ *
+ *  All rights reserved. This program and the accompanying materials
+ *  are made available under the terms of the Eclipse Public License v1.0
+ *  and Apache License v2.0 which accompanies this distribution.
+ *
+ *  The Eclipse Public License is available at
+ *  http://www.eclipse.org/legal/epl-v10.html
+ *
+ *  The Apache License v2.0 is available at
+ *  http://www.opensource.org/licenses/apache2.0.php
+ *
+ *  You may elect to redistribute this code under either of these licenses.
+ */
+package io.vertx.ext.web.handler;
+
+/**
+ * @see io.vertx.ext.web.common.HttpException2
+ */
+public final class HttpException extends io.vertx.ext.web.common.HttpException {
+
+  public HttpException() {
+    super();
+  }
+
+  public HttpException(int statusCode) {
+    super(statusCode);
+  }
+
+  public HttpException(int statusCode, Throwable cause) {
+    super(statusCode, cause);
+  }
+
+  public HttpException(int statusCode, String payload) {
+    super(statusCode, payload);
+  }
+
+  public HttpException(int statusCode, String payload, Throwable cause) {
+    super(statusCode, payload, cause);
+  }
+
+}
diff --git a/vertx-web/src/main/java/io/vertx/ext/web/handler/impl/APIKeyHandlerImpl.java b/vertx-web/src/main/java/io/vertx/ext/web/handler/impl/APIKeyHandlerImpl.java
@@ -25,12 +25,12 @@
 import io.vertx.ext.auth.authentication.TokenCredentials;
 import io.vertx.ext.web.RoutingContext;
 import io.vertx.ext.web.handler.APIKeyHandler;
-import io.vertx.ext.web.common.HttpException;
+import io.vertx.ext.web.handler.HttpException;
 import io.vertx.ext.web.impl.RoutingContextInternal;
 
 import java.util.function.Function;
 
-import static io.vertx.ext.web.common.HttpException.UNAUTHORIZED;
+import static io.vertx.ext.web.handler.HttpException.UNAUTHORIZED;
 
 /**
  * @author <a href="mailto:pmlopes@gmail.com">Paulo Lopes</a>

diff --git a/vertx-web/src/main/java/io/vertx/ext/web/handler/impl/ChainAuthHandlerImpl.java b/vertx-web/src/main/java/io/vertx/ext/web/handler/impl/ChainAuthHandlerImpl.java
@@ -10,7 +10,7 @@
 import io.vertx.ext.auth.authentication.AuthenticationProvider;
 import io.vertx.ext.auth.common.handler.AuthenticationHandlerInternal;
 import io.vertx.ext.web.RoutingContext;
-import io.vertx.ext.web.common.HttpException;
+import io.vertx.ext.web.handler.HttpException;
 import io.vertx.ext.web.handler.*;
 
 import java.util.ArrayList;

diff --git a/vertx-web/src/main/java/io/vertx/ext/web/handler/impl/DigestAuthHandlerImpl.java b/vertx-web/src/main/java/io/vertx/ext/web/handler/impl/DigestAuthHandlerImpl.java
@@ -43,7 +43,7 @@
 import java.util.regex.Pattern;
 
 import static io.vertx.ext.auth.impl.Codec.base16Encode;
-import static io.vertx.ext.web.common.HttpException.UNAUTHORIZED;
+import static io.vertx.ext.web.handler.HttpException.UNAUTHORIZED;
 
 /**
  * @author <a href="mailto:plopes@redhat.com">Paulo Lopes</a>

diff --git a/vertx-web/src/main/java/io/vertx/ext/web/handler/impl/FormLoginHandlerImpl.java b/vertx-web/src/main/java/io/vertx/ext/web/handler/impl/FormLoginHandlerImpl.java
@@ -32,8 +32,8 @@
 import io.vertx.ext.web.common.HttpException;
 import io.vertx.ext.web.impl.RoutingContextInternal;
 
-import static io.vertx.ext.web.common.HttpException.BAD_METHOD;
-import static io.vertx.ext.web.common.HttpException.BAD_REQUEST;
+import static io.vertx.ext.web.handler.HttpException.BAD_METHOD;
+import static io.vertx.ext.web.handler.HttpException.BAD_REQUEST;
 
 /**
  * @author <a href="http://tfox.org">Tim Fox</a>

diff --git a/vertx-web/src/main/java/io/vertx/ext/web/handler/impl/JWTAuthHandlerImpl.java b/vertx-web/src/main/java/io/vertx/ext/web/handler/impl/JWTAuthHandlerImpl.java
@@ -26,7 +26,7 @@
 import io.vertx.ext.auth.jwt.JWTAuth;
 import io.vertx.ext.web.RoutingContext;
 import io.vertx.ext.web.Session;
-import io.vertx.ext.web.common.HttpException;
+import io.vertx.ext.web.handler.HttpException;
 import io.vertx.ext.web.handler.JWTAuthHandler;
 import io.vertx.ext.web.impl.RoutingContextInternal;
 

diff --git a/vertx-web/src/main/java/io/vertx/ext/web/handler/impl/TotpAuthHandlerImpl.java b/vertx-web/src/main/java/io/vertx/ext/web/handler/impl/TotpAuthHandlerImpl.java
@@ -28,12 +28,12 @@
 import io.vertx.ext.web.Route;
 import io.vertx.ext.web.RoutingContext;
 import io.vertx.ext.web.Session;
-import io.vertx.ext.web.common.HttpException;
+import io.vertx.ext.web.handler.HttpException;
 import io.vertx.ext.web.handler.OtpAuthHandler;
 import io.vertx.ext.web.impl.OrderListener;
 import io.vertx.ext.web.impl.RoutingContextInternal;
 
-import static io.vertx.ext.web.common.HttpException.UNAUTHORIZED;
+import static io.vertx.ext.web.handler.HttpException.UNAUTHORIZED;
 
 /**
  * @author <a href="mailto:pmlopes@gmail.com">Paulo Lopes</a>

diff --git a/vertx-web/src/main/java/io/vertx/ext/web/impl/UserContextImpl.java b/vertx-web/src/main/java/io/vertx/ext/web/impl/UserContextImpl.java
@@ -10,7 +10,7 @@
 import io.vertx.ext.web.RoutingContext;
 import io.vertx.ext.web.Session;
 import io.vertx.ext.auth.common.UserContext;
-import io.vertx.ext.web.common.HttpException;
+import io.vertx.ext.web.handler.HttpException;
 
 public class UserContextImpl extends AbstractUserContext {
 

diff --git a/vertx-web/src/test/java/io/vertx/ext/web/handler/BasicAuthImpersonationTest.java b/vertx-web/src/test/java/io/vertx/ext/web/handler/BasicAuthImpersonationTest.java
@@ -9,7 +9,7 @@
 import io.vertx.ext.auth.properties.PropertyFileAuthentication;
 import io.vertx.ext.auth.properties.PropertyFileAuthorization;
 import io.vertx.ext.web.WebTestBase;
-import io.vertx.ext.web.common.HttpException;
+import io.vertx.ext.web.handler.HttpException;
 import io.vertx.ext.web.sstore.SessionStore;
 import org.junit.Test;
 

diff --git a/vertx-web/src/test/java/io/vertx/ext/web/handler/ChainAuthMixHandlerTest.java b/vertx-web/src/test/java/io/vertx/ext/web/handler/ChainAuthMixHandlerTest.java
@@ -8,7 +8,7 @@
 import io.vertx.ext.auth.jwt.JWTAuth;
 import io.vertx.ext.auth.jwt.JWTAuthOptions;
 import io.vertx.ext.web.WebTestBase;
-import io.vertx.ext.web.common.HttpException;
+import io.vertx.ext.web.handler.HttpException;
 import io.vertx.ext.web.sstore.LocalSessionStore;
 import org.junit.Test;
 

diff --git a/vertx-web/src/test/java/io/vertx/ext/web/handler/CustomAuthHandlerTest.java b/vertx-web/src/test/java/io/vertx/ext/web/handler/CustomAuthHandlerTest.java
@@ -24,7 +24,7 @@
 import io.vertx.ext.auth.authentication.Credentials;
 import io.vertx.ext.auth.authentication.UsernamePasswordCredentials;
 import io.vertx.ext.web.RoutingContext;
-import io.vertx.ext.web.common.HttpException;
+import io.vertx.ext.web.handler.HttpException;
 import org.junit.Test;
 
 import static org.mockito.ArgumentMatchers.any;