removing apache httpclient dependency, introducing SchemaClient interface with a default implementation using java.net.URL

Author: erosb

core/pom.xml

@@ -95,10 +95,5 @@
       <version>4.12</version>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>org.apache.httpcomponents</groupId>
-      <artifactId>httpclient</artifactId>
-      <version>4.5.1</version>
-    </dependency>
   </dependencies>
 </project>

core/src/main/java/org/everit/expression/json/schema/loader/DefaultSchemaClient.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2011 Everit Kft. (http://www.everit.org)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.everit.expression.json.schema.loader;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.UncheckedIOException;
+import java.net.URL;
+
+/**
+ * A {@link SchemaClient} implementation which uses {@link URL} for reading the remote content.
+ */
+public class DefaultSchemaClient implements SchemaClient {
+
+  @Override
+  public InputStream get(final String url) {
+    try {
+      return (InputStream) new URL(url).getContent();
+    } catch (IOException e) {
+      throw new UncheckedIOException(e);
+    }
+  }
+
+}

core/src/main/java/org/everit/expression/json/schema/loader/JSONPointer.java

@@ -24,9 +24,6 @@
 import java.util.Objects;
 import java.util.function.Supplier;
 
-import org.apache.http.HttpResponse;
-import org.apache.http.client.HttpClient;
-import org.apache.http.client.methods.HttpGet;
 import org.everit.expression.json.schema.SchemaException;
 import org.json.JSONArray;
 import org.json.JSONException;
@@ -72,18 +69,16 @@ public JSONObject getQueryResult() {
 
   }
 
-  private static JSONObject executeWith(final HttpClient client, final String url) {
+  private static JSONObject executeWith(final SchemaClient client, final String url) {
     String resp = null;
     BufferedReader buffReader = null;
     InputStreamReader reader = null;
     try {
-      HttpResponse response = client.execute(new HttpGet(url));
-      InputStream content = response.getEntity().getContent();
-      int capacity = (int) response.getEntity().getContentLength();
-      reader = new InputStreamReader(content, Charset.defaultCharset());
+      InputStream responseStream = client.get(url);
+      reader = new InputStreamReader(responseStream, Charset.defaultCharset());
       buffReader = new BufferedReader(reader);
       String line;
-      StringBuilder strBuilder = new StringBuilder(capacity);
+      StringBuilder strBuilder = new StringBuilder();
       while ((line = buffReader.readLine()) != null) {
         strBuilder.append(line);
       }
@@ -114,7 +109,7 @@ public static final JSONPointer forDocument(final JSONObject document, final Str
   /**
    * Static factory method.
    */
-  public static final JSONPointer forURL(final HttpClient httpClient, final String url) {
+  public static final JSONPointer forURL(final SchemaClient httpClient, final String url) {
     int poundIdx = url.indexOf('#');
     String fragment;
     String toBeQueried;

core/src/main/java/org/everit/expression/json/schema/loader/SchemaClient.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright (C) 2011 Everit Kft. (http://www.everit.org)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.everit.expression.json.schema.loader;
+
+import java.io.InputStream;
+import java.util.function.Function;
+
+/**
+ * This interface is used by {@link SchemaLoader} and {@link JSONPointer} to fetch the contents
+ * denoted by remote JSON pointer.
+ *
+ * <p>
+ * Implementations are expected to support the HTTP/1.1 protocol, the support of other protocols is
+ * optional.
+ * </p>
+ *
+ * @see DefaultSchemaClient
+ */
+@FunctionalInterface
+public interface SchemaClient extends Function<String, InputStream> {
+
+  @Override
+  default InputStream apply(final String url) {
+    return get(url);
+  }
+
+  /**
+   * Returns a stream to be used for reading the remote content (response body) of the URL. In the
+   * case of a HTTP URL, implementations are expected send HTTP GET requests and the response is
+   * expected to be represented in UTF-8 character set.
+   *
+   * @param url
+   *          the URL of the remote resource
+   * @return the input stream of the response
+   * @throws java.io.UncheckedIOException
+   *           if an IO error occurs.
+   */
+  InputStream get(String url);
+
+}

core/src/main/java/org/everit/expression/json/schema/loader/SchemaLoader.java

@@ -30,8 +30,6 @@
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
 
-import org.apache.http.client.HttpClient;
-import org.apache.http.impl.client.HttpClients;
 import org.everit.expression.json.schema.ArraySchema;
 import org.everit.expression.json.schema.BooleanSchema;
 import org.everit.expression.json.schema.CombinedSchema;
@@ -41,11 +39,11 @@
 import org.everit.expression.json.schema.NullSchema;
 import org.everit.expression.json.schema.NumberSchema;
 import org.everit.expression.json.schema.ObjectSchema;
+import org.everit.expression.json.schema.ObjectSchema.Builder;
 import org.everit.expression.json.schema.ReferenceSchema;
 import org.everit.expression.json.schema.Schema;
 import org.everit.expression.json.schema.SchemaException;
 import org.everit.expression.json.schema.StringSchema;
-import org.everit.expression.json.schema.ObjectSchema.Builder;
 import org.everit.expression.json.schema.loader.JSONPointer.QueryResult;
 import org.json.JSONArray;
 import org.json.JSONObject;
@@ -83,15 +81,15 @@ public class SchemaLoader {
   }
 
   /**
-   * Loads a JSON schema to a schema validator using a {@link HttpClients#createDefault() default
-   * HTTP client}.
+   * Loads a JSON schema to a schema validator using a {@link DefaultSchemaClient default HTTP
+   * client}.
    *
    * @param schemaJson
    *          the JSON representation of the schema.
    * @return the schema validator object
    */
   public static Schema load(final JSONObject schemaJson) {
-    return load(schemaJson, HttpClients.createDefault());
+    return load(schemaJson, new DefaultSchemaClient());
   }
 
   /**
@@ -102,7 +100,7 @@ public static Schema load(final JSONObject schemaJson) {
    * @param httpClient
    *          the HTTP client to be used for resolving remote JSON references.
    */
-  public static Schema load(final JSONObject schemaJson, final HttpClient httpClient) {
+  public static Schema load(final JSONObject schemaJson, final SchemaClient httpClient) {
     String schemaId = schemaJson.optString("id");
     return new SchemaLoader(schemaId, schemaJson, schemaJson, new HashMap<>(), httpClient)
         .load().build();
@@ -289,7 +287,7 @@ TypeBasedMultiplexer typeMultiplexer(final String keyOfObj, final Object obj) {
 
   private final JSONObject rootSchemaJson;
 
-  private final HttpClient httpClient;
+  private final SchemaClient httpClient;
 
   private final Map<String, ReferenceSchema.Builder> pointerSchemas;
 
@@ -298,7 +296,7 @@ TypeBasedMultiplexer typeMultiplexer(final String keyOfObj, final Object obj) {
    */
   SchemaLoader(final String id, final JSONObject schemaJson,
       final JSONObject rootSchemaJson, final Map<String, ReferenceSchema.Builder> pointerSchemas,
-      final HttpClient httpClient) {
+      final SchemaClient httpClient) {
     this.schemaJson = Objects.requireNonNull(schemaJson, "schemaJson cannot be null");
     this.rootSchemaJson = Objects.requireNonNull(rootSchemaJson, "rootSchemaJson cannot be null");
     this.id = id;

core/src/test/java/org/everit/expression/json/schema/loader/SchemaLoaderTest.java

@@ -19,8 +19,6 @@
 import java.util.HashMap;
 import java.util.Map;
 
-import org.apache.http.client.HttpClient;
-import org.apache.http.impl.client.HttpClients;
 import org.everit.expression.json.schema.ArraySchema;
 import org.everit.expression.json.schema.BooleanSchema;
 import org.everit.expression.json.schema.CombinedSchema;
@@ -34,7 +32,6 @@
 import org.everit.expression.json.schema.Schema;
 import org.everit.expression.json.schema.SchemaException;
 import org.everit.expression.json.schema.StringSchema;
-import org.everit.expression.json.schema.loader.SchemaLoader;
 import org.json.JSONArray;
 import org.json.JSONObject;
 import org.json.JSONTokener;
@@ -46,27 +43,27 @@ public class SchemaLoaderTest {
 
   private static JSONObject ALL_SCHEMAS;
 
-  private final HttpClient httpClient = HttpClients.createDefault();
+  private final SchemaClient httpClient = new DefaultSchemaClient();
 
   @Test
   public void typeBasedMultiplexerTest() {
     SchemaLoader loader = new SchemaLoader(null, new JSONObject(), new JSONObject(),
         new HashMap<>(),
         httpClient);
     loader.typeMultiplexer(new JSONObject())
-    .ifObject().then(jsonObj -> {
-    })
-    .ifIs(JSONArray.class).then(jsonArr -> {
-    })
-    .orElse(obj -> {
-    });
+        .ifObject().then(jsonObj -> {
+        })
+        .ifIs(JSONArray.class).then(jsonArr -> {
+        })
+        .orElse(obj -> {
+        });
 
     loader.typeMultiplexer(new JSONObject())
-    .ifObject().then(jsonObj -> {
-    })
-    .ifIs(JSONArray.class).then(jsonArr -> {
-    })
-    .requireAny();
+        .ifObject().then(jsonObj -> {
+        })
+        .ifIs(JSONArray.class).then(jsonArr -> {
+        })
+        .requireAny();
   }
 
   @Test(expected = SchemaException.class)
@@ -75,11 +72,11 @@ public void typeBasedMultiplexerFailure() {
         new HashMap<>(),
         httpClient);
     loader.typeMultiplexer("foo")
-    .ifObject().then(o -> {
-    })
-    .ifIs(JSONArray.class).then(o -> {
-    })
-    .requireAny();
+        .ifObject().then(o -> {
+        })
+        .ifIs(JSONArray.class).then(o -> {
+        })
+        .requireAny();
   }
 
   @BeforeClass

tests/pom.xml

@@ -45,8 +45,8 @@
 
 	<dependencies>
 		<dependency>
-			<groupId>org.everit</groupId>
-			<artifactId>org.everit.jsonvalidator</artifactId>
+			<groupId>org.everit.expression</groupId>
+			<artifactId>org.everit.expression.json.schema</artifactId>
 			<version>${project.version}</version>
 		</dependency>
 		<dependency>

tests/src/test/java/org/everit/expression/json/schema/IntegrationTest.java

@@ -23,10 +23,7 @@
 
 import org.eclipse.jetty.server.Server;
 import org.eclipse.jetty.servlet.ServletHandler;
-import org.everit.jsonvalidator.Schema;
-import org.everit.jsonvalidator.SchemaException;
-import org.everit.jsonvalidator.ValidationException;
-import org.everit.jsonvalidator.loader.SchemaLoader;
+import org.everit.expression.json.schema.loader.SchemaLoader;
 import org.json.JSONArray;
 import org.json.JSONException;
 import org.json.JSONObject;

tests/src/test/java/org/everit/expression/json/schema/TestServlet.java

@@ -37,6 +37,7 @@ protected void doGet(final HttpServletRequest req, final HttpServletResponse res
       resp.getWriter().println("resource " + req.getPathInfo() + " not found");
       return;
     }
+    resp.setContentType("application/json");
     int b;
     ServletOutputStream out = resp.getOutputStream();
     while ((b = in.read()) != -1) { // cannot believe i wrote this crap