Merge pull request #63 from SourceLabOrg/spp/guavaRemove

Remove Guava

Author: Crim

CHANGELOG.md

@@ -2,6 +2,21 @@
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 4.0.0 (12/10/2021)
+
+**Note:** Major release version updated purely out of abundance of caution.
+
+Internal dependency on Google Guava was removed.  Functionally nothing about this library's
+API has changed as a result of removing this dependency.  However, if you were making use of Google Guava via a transitive 
+dependency previously provided by this library, you will need to update your project to include this dependency directly.
+
+### New Features
+- Update [/connector/\<connector name\>/restart](https://docs.confluent.io/platform/current/connect/references/restapi.html#post--connectors-(string-name)-restart) requests to support the `includeTasks` and `onlyFailed` parameters added in Kafka-Connect version 3.0.0. 
+
+#### Internal Dependency Updates
+- Removed Google Guava as a dependency.
+- com.fasterxml.jackson.core from 2.12.2 -> 2.13.0.
+
 ## 3.1.3 (08/11/2021)
 - [Issue-55](https://github.com/SourceLabOrg/kafka-connect-client/issues/55) Create new HttpContext for every request.
 - [PR-59](https://github.com/SourceLabOrg/kafka-connect-client/pull/59) Adds supported method to modify the underlying configuration of HttpClient via HttpClientConfigHooks interface.

README.md

@@ -12,7 +12,7 @@ This client library is released on Maven Central.  Add a new dependency to your
 <dependency>
     <groupId>org.sourcelab</groupId>
     <artifactId>kafka-connect-client</artifactId>
-    <version>3.1.3</version>
+    <version>4.0.0</version>
 </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>org.sourcelab</groupId>
     <artifactId>kafka-connect-client</artifactId>
-    <version>3.1.3</version>
+    <version>4.0.0</version>
     <packaging>jar</packaging>
 
     <!-- Require Maven 3.3.9 -->
@@ -46,14 +46,11 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 
-        <!-- guava version -->
-        <guava.version>30.1.1-jre</guava.version>
-
         <!-- Http Components version -->
         <http-components.version>4.5.13</http-components.version>
 
         <!-- Jackson version -->
-        <jackson.version>2.12.2</jackson.version>
+        <jackson.version>2.13.0</jackson.version>
 
         <!-- Define which version of junit you'll be running -->
         <junit.version>4.13.1</junit.version>
@@ -64,7 +61,7 @@
         <checkstyle.version>8.32</checkstyle.version>
 
         <!-- Log4J Version -->
-        <log4j2.version>2.14.1</log4j2.version>
+        <log4j2.version>2.15.0</log4j2.version>
         <slf4j.version>1.7.32</slf4j.version>
 
         <!-- test toggling -->
@@ -85,13 +82,6 @@
             <version>${http-components.version}</version>
         </dependency>
 
-        <!-- Guava for Preconditions and URI Escaping -->
-        <dependency>
-            <groupId>com.google.guava</groupId>
-            <artifactId>guava</artifactId>
-            <version>${guava.version}</version>
-        </dependency>
-
         <!-- For parsing XML responses to POJOs -->
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>

src/main/java/org/sourcelab/kafka/connect/apiclient/request/delete/DeleteConnector.java

@@ -17,11 +17,11 @@
 
 package org.sourcelab.kafka.connect.apiclient.request.delete;
 
+import org.sourcelab.kafka.connect.apiclient.util.UrlEscapingUtil;
+
 import java.io.IOException;
 import java.util.Objects;
 
-import static com.google.common.net.UrlEscapers.urlPathSegmentEscaper;
-
 /**
  * Defines a request to delete a connector.
  */
@@ -39,7 +39,7 @@ public DeleteConnector(final String connectorName) {
 
     @Override
     public String getApiEndpoint() {
-        return "/connectors/" + urlPathSegmentEscaper().escape(connectorName);
+        return "/connectors/" + UrlEscapingUtil.escapePath(connectorName);
     }
 
     @Override

src/main/java/org/sourcelab/kafka/connect/apiclient/request/get/GetConnector.java

@@ -19,12 +19,11 @@
 
 import org.sourcelab.kafka.connect.apiclient.request.JacksonFactory;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorDefinition;
+import org.sourcelab.kafka.connect.apiclient.util.UrlEscapingUtil;
 
 import java.io.IOException;
 import java.util.Objects;
 
-import static com.google.common.net.UrlEscapers.urlPathSegmentEscaper;
-
 /**
  * Defines request to get details about a deployed connector.
  */
@@ -43,7 +42,7 @@ public GetConnector(final String connectorName) {
 
     @Override
     public String getApiEndpoint() {
-        return "/connectors/" + urlPathSegmentEscaper().escape(connectorName);
+        return "/connectors/" + UrlEscapingUtil.escapePath(connectorName);
     }
 
     @Override

src/main/java/org/sourcelab/kafka/connect/apiclient/request/get/GetConnectorConfig.java

@@ -18,13 +18,12 @@
 package org.sourcelab.kafka.connect.apiclient.request.get;
 
 import org.sourcelab.kafka.connect.apiclient.request.JacksonFactory;
+import org.sourcelab.kafka.connect.apiclient.util.UrlEscapingUtil;
 
 import java.io.IOException;
 import java.util.Map;
 import java.util.Objects;
 
-import static com.google.common.net.UrlEscapers.urlPathSegmentEscaper;
-
 /**
  * Defines a request for getting the configuration for a connector.
  */
@@ -43,7 +42,7 @@ public GetConnectorConfig(final String connectorName) {
 
     @Override
     public String getApiEndpoint() {
-        return "/connectors/" + urlPathSegmentEscaper().escape(connectorName) + "/config";
+        return "/connectors/" + UrlEscapingUtil.escapePath(connectorName) + "/config";
     }
 
     @Override

src/main/java/org/sourcelab/kafka/connect/apiclient/request/get/GetConnectorStatus.java

@@ -19,12 +19,11 @@
 
 import org.sourcelab.kafka.connect.apiclient.request.JacksonFactory;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorStatus;
+import org.sourcelab.kafka.connect.apiclient.util.UrlEscapingUtil;
 
 import java.io.IOException;
 import java.util.Objects;
 
-import static com.google.common.net.UrlEscapers.urlPathSegmentEscaper;
-
 /**
  * Defines request to get the status of a connector.
  */
@@ -43,7 +42,7 @@ public GetConnectorStatus(final String connectorName) {
 
     @Override
     public String getApiEndpoint() {
-        return "/connectors/" + urlPathSegmentEscaper().escape(connectorName) + "/status";
+        return "/connectors/" + UrlEscapingUtil.escapePath(connectorName) + "/status";
     }
 
     @Override

src/main/java/org/sourcelab/kafka/connect/apiclient/request/get/GetConnectorTaskStatus.java

@@ -19,12 +19,11 @@
 
 import org.sourcelab.kafka.connect.apiclient.request.JacksonFactory;
 import org.sourcelab.kafka.connect.apiclient.request.dto.TaskStatus;
+import org.sourcelab.kafka.connect.apiclient.util.UrlEscapingUtil;
 
 import java.io.IOException;
 import java.util.Objects;
 
-import static com.google.common.net.UrlEscapers.urlPathSegmentEscaper;
-
 /**
  * Defines a request to get the status of a connector's task.
  */
@@ -46,7 +45,7 @@ public GetConnectorTaskStatus(final String connectorName, final int taskId) {
 
     @Override
     public String getApiEndpoint() {
-        return "/connectors/" + urlPathSegmentEscaper().escape(connectorName) + "/tasks/" + taskId + "/status";
+        return "/connectors/" + UrlEscapingUtil.escapePath(connectorName) + "/tasks/" + taskId + "/status";
     }
 
     @Override

src/main/java/org/sourcelab/kafka/connect/apiclient/request/get/GetConnectorTasks.java

@@ -19,14 +19,13 @@
 
 import org.sourcelab.kafka.connect.apiclient.request.JacksonFactory;
 import org.sourcelab.kafka.connect.apiclient.request.dto.Task;
+import org.sourcelab.kafka.connect.apiclient.util.UrlEscapingUtil;
 
 import java.io.IOException;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Objects;
 
-import static com.google.common.net.UrlEscapers.urlPathSegmentEscaper;
-
 /**
  * Defines request to get tasks for a connector.
  */
@@ -45,7 +44,7 @@ public GetConnectorTasks(final String connectorName) {
 
     @Override
     public String getApiEndpoint() {
-        return "/connectors/" + urlPathSegmentEscaper().escape(connectorName) + "/tasks";
+        return "/connectors/" + UrlEscapingUtil.escapePath(connectorName) + "/tasks";
     }
 
     @Override

src/main/java/org/sourcelab/kafka/connect/apiclient/request/get/GetConnectorTopics.java

@@ -19,12 +19,11 @@
 
 import org.sourcelab.kafka.connect.apiclient.request.JacksonFactory;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorTopics;
+import org.sourcelab.kafka.connect.apiclient.util.UrlEscapingUtil;
 
 import java.io.IOException;
 import java.util.Objects;
 
-import static com.google.common.net.UrlEscapers.urlPathSegmentEscaper;
-
 /**
  * Returns a list of connector topic names.
  * There is no defined order in which the topics are returned and consecutive calls may return the same topic names
@@ -47,7 +46,7 @@ public GetConnectorTopics(final String connectorName) {
 
     @Override
     public String getApiEndpoint() {
-        return "/connectors/" + urlPathSegmentEscaper().escape(connectorName) + "/topics";
+        return "/connectors/" + UrlEscapingUtil.escapePath(connectorName) + "/topics";
     }
 
     @Override

src/main/java/org/sourcelab/kafka/connect/apiclient/request/post/PostConnectorRestart.java

@@ -17,17 +17,23 @@
 
 package org.sourcelab.kafka.connect.apiclient.request.post;
 
+import org.sourcelab.kafka.connect.apiclient.util.UrlEscapingUtil;
+
 import java.io.IOException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 import java.util.Objects;
 
-import static com.google.common.net.UrlEscapers.urlPathSegmentEscaper;
-
 /**
  * Defines a request to restart a connector.
  */
 public final class PostConnectorRestart implements PostRequest<Boolean> {
     private final String connectorName;
 
+    private Map<String, Boolean> options = new HashMap<>();
+
     /**
      * Constructor.
      * @param connectorName Name of connector to restart
@@ -37,9 +43,48 @@ public PostConnectorRestart(final String connectorName) {
         this.connectorName = connectorName;
     }
 
+    /**
+     * Only available from Kafka Connect version 3.0.0 and up.
+     * @param includeTasks Specifies whether to restart the connector instance and task instances (includeTasks=true`) or
+     *                     just the connector instance (includeTasks=false).
+     * @return self reference for method chaining.
+     */
+    public PostConnectorRestart withIncludeTasks(final boolean includeTasks)
+    {
+        options.put("includeTasks", includeTasks);
+        return this;
+    }
+
+    /**
+     * Only available from Kafka Connect version 3.0.0 and up.
+     * @param onlyFailed specifies whether to restart just the instances with a FAILED status (onlyFailed=true)
+     *                   or all instances (onlyFailed=false).
+     * @return self reference for method chaining.
+     */
+    public PostConnectorRestart withOnlyFailed(final boolean onlyFailed)
+    {
+        options.put("onlyFailed", onlyFailed);
+        return this;
+    }
+
     @Override
     public String getApiEndpoint() {
-        return "/connectors/" + urlPathSegmentEscaper().escape(connectorName) + "/restart";
+        // Define base URL
+        String url = "/connectors/" + UrlEscapingUtil.escapePath(connectorName) + "/restart";
+
+        // Optionally add additional request parameters if explicitly defined.
+        final List<String> params = new ArrayList<>();
+        for (final Map.Entry<String, Boolean> option : options.entrySet()) {
+            // skip null
+            if (option.getValue() == null) {
+                continue;
+            }
+            params.add(option.getKey() + "=" + (option.getValue() ? "true" : "false"));
+        }
+        if (params.size() > 0) {
+            url = url + "?" + String.join("&", params);
+        }
+        return url;
     }
 
     @Override
@@ -49,6 +94,7 @@ public Object getRequestBody() {
 
     @Override
     public Boolean parseResponse(final String responseStr) throws IOException {
+        // Note: this doesn't currently support 202 responses which would normally contain a response body :/
         return true;
     }
 }

src/main/java/org/sourcelab/kafka/connect/apiclient/request/post/PostConnectorTaskRestart.java

@@ -18,11 +18,11 @@
 package org.sourcelab.kafka.connect.apiclient.request.post;
 
 
+import org.sourcelab.kafka.connect.apiclient.util.UrlEscapingUtil;
+
 import java.io.IOException;
 import java.util.Objects;
 
-import static com.google.common.net.UrlEscapers.urlPathSegmentEscaper;
-
 /**
  * Defines request to restart a connector's task.
  */
@@ -43,7 +43,7 @@ public PostConnectorTaskRestart(final String connectorName, final int taskId) {
 
     @Override
     public String getApiEndpoint() {
-        return "/connectors/" + urlPathSegmentEscaper().escape(connectorName) + "/tasks/" + taskId + "/restart";
+        return "/connectors/" + UrlEscapingUtil.escapePath(connectorName) + "/tasks/" + taskId + "/restart";
     }
 
     @Override

src/main/java/org/sourcelab/kafka/connect/apiclient/request/put/PutConnectorConfig.java

@@ -19,15 +19,14 @@
 
 import org.sourcelab.kafka.connect.apiclient.request.JacksonFactory;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorDefinition;
+import org.sourcelab.kafka.connect.apiclient.util.UrlEscapingUtil;
 
 import java.io.IOException;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Objects;
 
-import static com.google.common.net.UrlEscapers.urlPathSegmentEscaper;
-
 /**
  * Defines request to update a connectors configuration.
  */
@@ -49,7 +48,7 @@ public PutConnectorConfig(final String connectorName, final Map<String, String>
 
     @Override
     public String getApiEndpoint() {
-        return "/connectors/" + urlPathSegmentEscaper().escape(connectorName) + "/config";
+        return "/connectors/" + UrlEscapingUtil.escapePath(connectorName) + "/config";
     }
 
     @Override

src/main/java/org/sourcelab/kafka/connect/apiclient/request/put/PutConnectorPause.java

@@ -17,11 +17,11 @@
 
 package org.sourcelab.kafka.connect.apiclient.request.put;
 
+import org.sourcelab.kafka.connect.apiclient.util.UrlEscapingUtil;
+
 import java.io.IOException;
 import java.util.Objects;
 
-import static com.google.common.net.UrlEscapers.urlPathSegmentEscaper;
-
 /**
  * Defines request to pause a connector.
  */
@@ -39,7 +39,7 @@ public PutConnectorPause(final String connectorName) {
 
     @Override
     public String getApiEndpoint() {
-        return "/connectors/" + urlPathSegmentEscaper().escape(connectorName) + "/pause";
+        return "/connectors/" + UrlEscapingUtil.escapePath(connectorName) + "/pause";
     }
 
     @Override