Cleanup

Author: Stephen Powis

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

@@ -1,3 +1,20 @@
+/**
+ * Copyright 2018, 2019 SourceLab.org https://github.com/SourceLabOrg/kafka-connect-client
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
 package org.sourcelab.kafka.connect.apiclient.request.dto;
 
 /**
@@ -8,24 +25,36 @@ public class ConnectServerVersion {
     private String commit;
     private String kafkaClusterId;
 
+    /**
+     * Version of running Kafka-Connect server.
+     * @return Version of running Kafka-Connect server.
+     */
     public String getVersion() {
         return version;
     }
 
+    /**
+     * Commit hash of running Kafka-Connect server.
+     * @return Commit hash of running Kafka-Connect server.
+     */
     public String getCommit() {
         return commit;
     }
 
+    /**
+     * Kafka Cluster Identifier.
+     * @return Kafka Cluster Identifier.
+     */
     public String getKafkaClusterId() {
         return kafkaClusterId;
     }
 
     @Override
     public String toString() {
-        return "ConnectServerVersion{" +
-            "version='" + version + '\'' +
-            ", commit='" + commit + '\'' +
-            ", kafkaClusterId='" + kafkaClusterId + '\'' +
-            '}';
+        return "ConnectServerVersion{"
+            + "version='" + version + '\''
+            + ", commit='" + commit + '\''
+            + ", kafkaClusterId='" + kafkaClusterId + '\''
+            + '}';
     }
 }

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

@@ -1,16 +1,55 @@
-package org.sourcelab.kafka.connect.apiclient.request.dto;
+/**
+ * Copyright 2018, 2019 SourceLab.org https://github.com/SourceLabOrg/kafka-connect-client
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
 
+package org.sourcelab.kafka.connect.apiclient.request.dto;
 
 import java.util.Collection;
 import java.util.Map;
 
+/**
+ * Deployed Connectors extended with their associated ConnectorDefinitions.
+ *
+ * Requires Kafka-Connect server 2.3.0+
+ */
 public interface ConnectorsWithExpandedInfo {
 
+    /**
+     * Names for all deployed connectors.
+     * @return Names of all deployed connectors.
+     */
     Collection<String> getConnectorNames();
 
-    ConnectorDefinition getDefinitionForConnector(final String connectorName);
+    /**
+     * Given a connector name, return the definition for the connector.
+     * @param connectorName name of connector to return definition for.
+     * @return ConnectorDefinition for the given connector name.
+     * @throws IllegalArgumentException if passed a connector name not included in the results.
+     */
+    ConnectorDefinition getDefinitionForConnector(final String connectorName) throws IllegalArgumentException;
 
+    /**
+     * All ConnectorDefinitions.
+     * @return all ConnectorDefinitions.
+     */
     Collection<ConnectorDefinition> getAllDefinitions();
 
+    /**
+     * Map of ConnectorName to its respective ConnectorDefinition.
+     * @return Map of ConnectorName to its respective ConnectorDefinition.
+     */
     Map<String, ConnectorDefinition> getMappedDefinitions();
 }

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

@@ -1,3 +1,20 @@
+/**
+ * Copyright 2018, 2019 SourceLab.org https://github.com/SourceLabOrg/kafka-connect-client
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
 package org.sourcelab.kafka.connect.apiclient.request.dto;
 
 import com.fasterxml.jackson.annotation.JsonAnySetter;
@@ -9,21 +26,31 @@
 import java.util.Map;
 import java.util.stream.Collectors;
 
+/**
+ * Deployed Connectors extended with all available associated Metadata.
+ *
+ * Currently this includes both 'info' and 'status' metadata.
+ *
+ * Requires Kafka-Connect server 2.3.0+
+ */
 public class ConnectorsWithExpandedMetadata implements ConnectorsWithExpandedInfo, ConnectorsWithExpandedStatus {
     @JsonAnySetter
     private Map<String, ConnectorsWithExpandedMetadata.ConnectorWithExpandedMetadata> results = new HashMap<>();
 
+    @Override
     public Collection<String> getConnectorNames() {
         return results.keySet();
     }
 
+    @Override
     public ConnectorDefinition getDefinitionForConnector(final String connectorName) {
         if (!results.containsKey(connectorName)) {
             throw new IllegalArgumentException("Results do not contain connector: " + connectorName);
         }
         return results.get(connectorName).getInfo();
     }
 
+    @Override
     public Collection<ConnectorDefinition> getAllDefinitions() {
         return results
             .values()
@@ -32,6 +59,7 @@ public Collection<ConnectorDefinition> getAllDefinitions() {
             .collect(Collectors.toList());
     }
 
+    @Override
     public Map<String, ConnectorDefinition> getMappedDefinitions() {
         return Collections.unmodifiableMap(
             results
@@ -41,13 +69,15 @@ public Map<String, ConnectorDefinition> getMappedDefinitions() {
         );
     }
 
+    @Override
     public ConnectorStatus getStatusForConnector(final String connectorName) {
         if (!results.containsKey(connectorName)) {
             throw new IllegalArgumentException("Results do not contain connector: " + connectorName);
         }
         return results.get(connectorName).getStatus();
     }
 
+    @Override
     public Collection<ConnectorStatus> getAllStatuses() {
         return results
             .values()
@@ -56,6 +86,7 @@ public Collection<ConnectorStatus> getAllStatuses() {
             .collect(Collectors.toList());
     }
 
+    @Override
     public Map<String, ConnectorStatus> getMappedStatuses() {
         return Collections.unmodifiableMap(
             results
@@ -72,6 +103,9 @@ public String toString() {
             + '}';
     }
 
+    /**
+     * Expanded metadata included with the connector response.
+     */
     public static class ConnectorWithExpandedMetadata {
 
         @JsonProperty("info")
@@ -90,10 +124,18 @@ public ConnectorDefinition getInfo() {
 
         @Override
         public String toString() {
-            return "Connector{" +
-                "info=" + info +
-                ", status=" + status +
-                '}';
+            String value = "ConnectorMetadata{";
+            if (info != null) {
+                value += "info=" + info;
+                if (status != null) {
+                    value += ", ";
+                }
+            }
+            if (status != null) {
+                value += "status=" + status;
+            }
+            value += '}';
+            return value;
         }
     }
 }

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

@@ -3,13 +3,36 @@
 import java.util.Collection;
 import java.util.Map;
 
+/**
+ * Deployed Connectors extended with their associated ConnectorDefinitions.
+ *
+ * Requires Kafka-Connect server 2.3.0+
+ */
 public interface ConnectorsWithExpandedStatus {
 
+    /**
+     * Names for all deployed connectors.
+     * @return Names of all deployed connectors.
+     */
     Collection<String> getConnectorNames();
 
+    /**
+     * Given a connector name, return the status for the connector.
+     * @param connectorName name of connector to return status for.
+     * @return ConnectorStatus for the given connector name.
+     * @throws IllegalArgumentException if passed a connector name not included in the results.
+     */
     ConnectorStatus getStatusForConnector(final String connectorName);
 
+    /**
+     * All connector statuses.
+     * @return All connector statuses.
+     */
     Collection<ConnectorStatus> getAllStatuses();
 
+    /**
+     * Map of ConnectorName to its respective Status.
+     * @return Map of ConnectorName to its respective Status.
+     */
     Map<String, ConnectorStatus> getMappedStatuses();
 }

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

@@ -1,10 +1,34 @@
+/**
+ * Copyright 2018, 2019 SourceLab.org https://github.com/SourceLabOrg/kafka-connect-client
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
 package org.sourcelab.kafka.connect.apiclient.request.get;
 
 import org.sourcelab.kafka.connect.apiclient.request.JacksonFactory;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorsWithExpandedMetadata;
 
 import java.io.IOException;
 
+/**
+ * Defines a request to retrieve all deployed Connectors extended with all available associated metadata.
+ *
+ * Currently this includes both 'info' and 'status' metadata.
+ *
+ * Requires Kafka-Connect server 2.3.0+
+ */
 public class GetConnectorsExpandAllDetails implements GetRequest<ConnectorsWithExpandedMetadata> {
 
     @Override

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

@@ -1,3 +1,20 @@
+/**
+ * Copyright 2018, 2019 SourceLab.org https://github.com/SourceLabOrg/kafka-connect-client
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
 package org.sourcelab.kafka.connect.apiclient.request.get;
 
 import org.sourcelab.kafka.connect.apiclient.request.JacksonFactory;
@@ -6,6 +23,11 @@
 
 import java.io.IOException;
 
+/**
+ * Defines a request to retrieve all deployed Connectors extended with 'info' metadata.
+ *
+ * Requires Kafka-Connect server 2.3.0+
+ */
 public class GetConnectorsExpandInfo implements GetRequest<ConnectorsWithExpandedInfo> {
 
     @Override

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

@@ -1,12 +1,33 @@
-package org.sourcelab.kafka.connect.apiclient.request.get;
+/**
+ * Copyright 2018, 2019 SourceLab.org https://github.com/SourceLabOrg/kafka-connect-client
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
 
+package org.sourcelab.kafka.connect.apiclient.request.get;
 
 import org.sourcelab.kafka.connect.apiclient.request.JacksonFactory;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorsWithExpandedMetadata;
 import org.sourcelab.kafka.connect.apiclient.request.dto.ConnectorsWithExpandedStatus;
 
 import java.io.IOException;
 
+/**
+ * Defines a request to retrieve all deployed Connectors extended 'status' metadata.
+ *
+ * Requires Kafka-Connect server 2.3.0+
+ */
 public class GetConnectorsExpandStatus implements GetRequest<ConnectorsWithExpandedStatus> {
 
     @Override

src/test/java/org/sourcelab/kafka/connect/apiclient/request/get/connector/GetConnectServerVersionTest.java

@@ -1,3 +1,20 @@
+/**
+ * Copyright 2018, 2019 SourceLab.org https://github.com/SourceLabOrg/kafka-connect-client
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
 package org.sourcelab.kafka.connect.apiclient.request.get.connector;
 
 import org.junit.Test;