Merge pull request #77 from SourceLabOrg/spp/improvements

First pass improvements and javadoc fixes

Author: Crim

CHANGELOG.md

@@ -2,6 +2,12 @@
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 4.0.2 (10/12/2022)
+- Adds `KafkaConnectClient::restartConnector(final PostConnectorRestart connectorRestartRequest)` [Issue-78](https://github.com/SourceLabOrg/kafka-connect-client/issues/78).
+- Fix Javadoc on KafkaConnectClient::deleteConnector(). [issue-76](https://github.com/SourceLabOrg/kafka-connect-client/issues/76).
+- Add Constructors to various internal "DTO" classes, this allows for easier testing/mocking of responses. 
+- com.fasterxml.jackson.core from 2.13.3 -> 2.13.4
+- 
 ## 4.0.1 (08/20/2022)
 #### Internal Dependency Updates
 - com.fasterxml.jackson.core from 2.13.0 -> 2.13.3

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>org.sourcelab</groupId>
     <artifactId>kafka-connect-client</artifactId>
-    <version>4.0.1</version>
+    <version>4.0.2</version>
     <packaging>jar</packaging>
 
     <!-- Require Maven 3.3.9 -->
@@ -50,7 +50,7 @@
         <http-components.version>4.5.13</http-components.version>
 
         <!-- Jackson version -->
-        <jackson.version>2.13.3</jackson.version>
+        <jackson.version>2.13.4</jackson.version>
 
         <!-- Define which version of junit you'll be running -->
         <junit.version>4.13.2</junit.version>

src/main/java/org/sourcelab/kafka/connect/apiclient/KafkaConnectClient.java

@@ -258,7 +258,19 @@ public ConnectorDefinition updateConnectorConfig(final String connectorName, fin
      * @return Boolean true if success.
      */
     public Boolean restartConnector(final String connectorName) {
-        return submitRequest(new PostConnectorRestart(connectorName));
+        return restartConnector(new PostConnectorRestart(connectorName));
+    }
+
+    /**
+     * Restart a connector.
+     * https://docs.confluent.io/current/connect/references/restapi.html#post--connectors-(string-name)-restart
+     *
+     * @param connectorRestartRequest Defines the connector restart request.
+     * @return Boolean true if success.
+     */
+    public Boolean restartConnector(final PostConnectorRestart connectorRestartRequest)
+    {
+        return submitRequest(connectorRestartRequest);
     }
 
     /**
@@ -284,8 +296,8 @@ public Boolean resumeConnector(final String connectorName) {
     }
 
     /**
-     * Resume a connector.
-     * https://docs.confluent.io/current/connect/references/restapi.html#put--connectors-(string-name)-resume
+     * Delete a connector.
+     * https://docs.confluent.io/platform/current/connect/references/restapi.html#delete--connectors-(string-name)-
      *
      * @param connectorName Name of connector to resume.
      * @return Boolean true if success.

src/main/java/org/sourcelab/kafka/connect/apiclient/request/dto/ConnectServerVersion.java

@@ -25,6 +25,22 @@ public class ConnectServerVersion {
     private String commit;
     private String kafkaClusterId;
 
+    /**
+     * Default Constructor.
+     */
+    public ConnectServerVersion()
+    {
+    }
+
+    /**
+     * Constructor.
+     */
+    public ConnectServerVersion(final String version, final String commit, final String kafkaClusterId) {
+        this.version = version;
+        this.commit = commit;
+        this.kafkaClusterId = kafkaClusterId;
+    }
+
     /**
      * Version of running Kafka-Connect server.
      * @return Version of running Kafka-Connect server.

src/main/java/org/sourcelab/kafka/connect/apiclient/request/dto/ConnectorDefinition.java

@@ -17,6 +17,8 @@
 
 package org.sourcelab.kafka.connect.apiclient.request.dto;
 
+import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
@@ -29,6 +31,23 @@ public final class ConnectorDefinition {
     private Map<String, String> config;
     private List<TaskDefinition> tasks;
 
+    /**
+     * Default constructor.
+     */
+    public ConnectorDefinition()
+    {
+    }
+
+    /**
+     * Constructor.
+     */
+    public ConnectorDefinition(final String name, final String type, final Map<String, String> config, final List<TaskDefinition> tasks) {
+        this.name = name;
+        this.type = type;
+        this.config = new HashMap<>(config);
+        this.tasks = new ArrayList<>(tasks);
+    }
+
     public String getName() {
         return name;
     }
@@ -62,6 +81,20 @@ public static final class TaskDefinition {
         private String connector;
         private int task;
 
+        /**
+         * Default Constructor.
+         */
+        public TaskDefinition() {
+        }
+
+        /**
+         * Constructor.
+         */
+        public TaskDefinition(final String connector, final int task) {
+            this.connector = connector;
+            this.task = task;
+        }
+
         public String getConnector() {
             return connector;
         }

src/main/java/org/sourcelab/kafka/connect/apiclient/request/dto/ConnectorPlugin.java

@@ -28,6 +28,21 @@ public final class ConnectorPlugin {
     private String type;
     private String version;
 
+    /**
+     * Default constructor.
+     */
+    public ConnectorPlugin() {
+    }
+
+    /**
+     * Constructor.
+     */
+    public ConnectorPlugin(final String className, final String type, final String version) {
+        this.className = className;
+        this.type = type;
+        this.version = version;
+    }
+
     public String getClassName() {
         return className;
     }
@@ -44,6 +59,8 @@ public String getVersion() {
     public String toString() {
         return "ConnectorPlugin{"
             + "className='" + className + '\''
+            + ", type='" + type + '\''
+            + ", version='" + version + '\''
             + '}';
     }
 }

src/main/java/org/sourcelab/kafka/connect/apiclient/request/dto/ConnectorPluginConfigDefinition.java

@@ -28,6 +28,14 @@ public final class ConnectorPluginConfigDefinition {
     private final String name;
     private final Map<String, String> config;
 
+    /**
+     * Create new Builder instance for ConnectorPluginConfigDefinition.
+     * @return Builder instance for ConnectorPluginConfigDefinition.
+     */
+    public static ConnectorPluginConfigDefinition.Builder newBuilder() {
+        return new ConnectorPluginConfigDefinition.Builder();
+    }
+
     /**
      * Constructor.
      * @param connectorPluginName Name of Connector Plugin.
@@ -46,10 +54,6 @@ public Map<String, String> getConfig() {
         return config;
     }
 
-    public static ConnectorPluginConfigDefinition.Builder newBuilder() {
-        return new ConnectorPluginConfigDefinition.Builder();
-    }
-
     @Override
     public String toString() {
         return "ConnectorPluginConfigDefinition{"

src/main/java/org/sourcelab/kafka/connect/apiclient/request/dto/ConnectorPluginConfigValidationResults.java

@@ -29,6 +29,27 @@ public final class ConnectorPluginConfigValidationResults {
     private Collection<String> groups = new ArrayList<>();
     private Collection<Config> configs = new ArrayList<>();
 
+    /**
+     * Default constructor.
+     */
+    public ConnectorPluginConfigValidationResults() {
+    }
+
+    /**
+     * Constructor.
+     */
+    public ConnectorPluginConfigValidationResults(
+        final String name,
+        final int errorCount,
+        final Collection<String> groups,
+        final Collection<Config> configs
+    ) {
+        this.name = name;
+        this.errorCount = errorCount;
+        this.groups = new ArrayList<>(groups);
+        this.configs = new ArrayList<>(configs);
+    }
+
     public String getName() {
         return name;
     }
@@ -62,6 +83,20 @@ public static final class Config {
         private Definition definition;
         private Value value;
 
+        /**
+         * Default constructor.
+         */
+        public Config() {
+        }
+
+        /**
+         * Constructor.
+         */
+        public Config(final Definition definition, final Value value) {
+            this.definition = definition;
+            this.value = value;
+        }
+
         public Definition getDefinition() {
             return definition;
         }
@@ -94,6 +129,41 @@ public static final class Definition {
             private Collection<String> dependents = new ArrayList<>();
             private int order;
 
+            /**
+             * Default constructor.
+             */
+            public Definition() {
+            }
+
+            /**
+             * Constructor.
+             */
+            public Definition(
+                final String name,
+                final String type,
+                final boolean required,
+                final String defaultValue,
+                final String importance,
+                final String documentation,
+                final String group,
+                final String width,
+                final String displayName,
+                final Collection<String> dependents,
+                final int order
+            ) {
+                this.name = name;
+                this.type = type;
+                this.required = required;
+                this.defaultValue = defaultValue;
+                this.importance = importance;
+                this.documentation = documentation;
+                this.group = group;
+                this.width = width;
+                this.displayName = displayName;
+                this.dependents = new ArrayList<>(dependents);
+                this.order = order;
+            }
+
             public String getName() {
                 return name;
             }
@@ -166,6 +236,29 @@ public static final class Value {
             private Collection<String> errors = new ArrayList<>();
             private boolean visible = true;
 
+            /**
+             * Default constructor.
+             */
+            public Value() {
+            }
+
+            /**
+             * Constructor.
+             */
+            public Value(
+                final String name,
+                final String value,
+                final Collection<String> recommendedValues,
+                final Collection<String> errors,
+                final boolean visible
+            ) {
+                this.name = name;
+                this.value = value;
+                this.recommendedValues = new ArrayList<>(recommendedValues);
+                this.errors = new ArrayList<>(errors);
+                this.visible = visible;
+            }
+
             public String getName() {
                 return name;
             }

src/main/java/org/sourcelab/kafka/connect/apiclient/request/dto/ConnectorStatus.java

@@ -17,7 +17,9 @@
 
 package org.sourcelab.kafka.connect.apiclient.request.dto;
 
+import java.util.ArrayList;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
@@ -30,6 +32,22 @@ public class ConnectorStatus {
     private Map<String, String> connector;
     private List<TaskStatus> tasks;
 
+    /**
+     * Default constructor.
+     */
+    public ConnectorStatus() {
+    }
+
+    /**
+     * Constructor.
+     */
+    public ConnectorStatus(final String name, final String type, final Map<String, String> connector, final List<TaskStatus> tasks) {
+        this.name = name;
+        this.type = type;
+        this.connector = new HashMap<>(connector);
+        this.tasks = new ArrayList<>(tasks);
+    }
+
     public String getName() {
         return name;
     }
@@ -65,6 +83,22 @@ public static class TaskStatus {
         private String workerId;
         private String trace;
 
+        /**
+         * Default constructor.
+         */
+        public TaskStatus() {
+        }
+
+        /**
+         * Constructor.
+         */
+        public TaskStatus(final int id, final String state, final String workerId, final String trace) {
+            this.id = id;
+            this.state = state;
+            this.workerId = workerId;
+            this.trace = trace;
+        }
+
         public int getId() {
             return id;
         }