Merge pull request #1 from Crim/sp/renameClient

rename ApiClient to KafkaConnectClient

Author: Crim

README.md

@@ -30,16 +30,30 @@ Example Code:
 final Configuration configuration = new Configuration("hostname.for.kafka-connect.service.com:8083");
 
 /*
- * Create an instance of ApiClient, passing your configuration.
+ * Create an instance of KafkaConnectClient, passing your configuration.
  */
-final ApiClient client = new ApiClient(configuration);
+final KafkaConnectClient client = new KafkaConnectClient(configuration);
 
 /*
  * Making requests by calling the public methods available on ApiClient.
+ * 
+ * For example, get a list of deployed connectors:
  */
+final Collection<String> connectorList = client.getConnectors();
+
+/*
+ * Or to deploy a new connector:
+ */
+final ConnectorDefinition connectorDefition = client.addConnector(NewConnectorDefinition.newBuilder()
+    .withName("MyNewConnector")
+    .withConfig("connector.class", "org.apache.kafka.connect.tools.VerifiableSourceConnector")
+    .withConfig("tasks.max", 3)
+    .withConfig("topics", "test-topic")
+    .build()
+));
 ```
 
-Public methods available on ApiClient can be [found here](src/main/java/org/sourcelab/kafka/connect/apiclient/ApiClient.java#L101-L266)
+Public methods available on KafkaConnectClient can be [found here](src/main/java/org/sourcelab/kafka/connect/apiclient/ApiClient.java#L101-L266)
 
 ## Changelog
 

pom.xml

@@ -46,8 +46,14 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 
+        <!-- guava version -->
+        <guava.version>24.0-jre</guava.version>
+
+        <!-- Http Components version -->
+        <http-components.version>4.5.5</http-components.version>
+
         <!-- Jackson version -->
-        <jackson.version>2.9.3</jackson.version>
+        <jackson.version>2.9.4</jackson.version>
 
         <!-- Define which version of junit you'll be running -->
         <junit.version>4.12</junit.version>
@@ -75,14 +81,14 @@
         <dependency>
             <groupId>org.apache.httpcomponents</groupId>
             <artifactId>httpclient</artifactId>
-            <version>4.5.4</version>
+            <version>${http-components.version}</version>
         </dependency>
 
         <!-- Guava for Preconditions and URI Escaping -->
         <dependency>
             <groupId>com.google.guava</groupId>
             <artifactId>guava</artifactId>
-            <version>24.0-jre</version>
+            <version>${guava.version}</version>
         </dependency>
 
         <!-- For parsing XML responses to POJOs -->

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

@@ -22,7 +22,7 @@
  *
  * Also allows for configuring an optional proxy with or without authentication.
  */
-public class Configuration {
+public final class Configuration {
     // Defines the URL/Hostname of Kafka-Connect
     private final String apiHost;
 

src/main/java/org/sourcelab/kafka/connect/apiclient/ApiClient.java renamed to src/main/java/org/sourcelab/kafka/connect/apiclient/KafkaConnectClient.java

@@ -59,8 +59,8 @@
  * Official Rest Endpoint documentation can be found here:
  *   https://docs.confluent.io/current/connect/restapi.html
  */
-public class ApiClient {
-    private static final Logger logger = LoggerFactory.getLogger(ApiClient.class);
+public class KafkaConnectClient {
+    private static final Logger logger = LoggerFactory.getLogger(KafkaConnectClient.class);
 
     /**
      * Our API Configuration.
@@ -82,7 +82,7 @@ public class ApiClient {
      * Default Constructor.
      * @param configuration Api Client Configuration.
      */
-    public ApiClient(final Configuration configuration) {
+    public KafkaConnectClient(final Configuration configuration) {
         this.configuration = configuration;
         this.restClient = new HttpClientRestClient();
     }
@@ -93,7 +93,7 @@ public ApiClient(final Configuration configuration) {
      * @param configuration Pardot Api Configuration.
      * @param restClient RestClient implementation to use.
      */
-    public ApiClient(final Configuration configuration, final RestClient restClient) {
+    public KafkaConnectClient(final Configuration configuration, final RestClient restClient) {
         this.configuration = configuration;
         this.restClient = restClient;
     }
@@ -293,7 +293,7 @@ private <T> T submitRequest(final Request<T> request) {
         try {
             final RequestErrorResponse errorResponse = JacksonFactory.newInstance().readValue(responseStr, RequestErrorResponse.class);
             throw new InvalidRequestException(errorResponse.getMessage(), errorResponse.getErrorCode());
-        } catch (IOException e) {
+        } catch (final IOException e) {
             // swallow
         }
         throw new InvalidRequestException("Invalid response from server: " + responseStr, restResponse.getHttpCode());

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

@@ -147,7 +147,7 @@ public void close() {
         if (httpClient != null) {
             try {
                 httpClient.close();
-            } catch (IOException e) {
+            } catch (final IOException e) {
                 logger.error("Error closing: {}", e.getMessage(), e);
             }
         }
@@ -178,7 +178,7 @@ public RestResponse submitRequest(final Request request) throws RestException {
                 default:
                     throw new IllegalArgumentException("Unknown Request Method: " + request.getRequestMethod());
             }
-        } catch (IOException exception) {
+        } catch (final IOException exception) {
             throw new RestException(exception.getMessage(), exception);
         }
     }
@@ -198,7 +198,7 @@ private <T> T submitGetRequest(final String url, final Map<String, String> getPa
                 .setCharset(StandardCharsets.UTF_8);
 
             // Attach submitRequest params
-            for (Map.Entry<String, String> entry : getParams.entrySet()) {
+            for (final Map.Entry<String, String> entry : getParams.entrySet()) {
                 uriBuilder.setParameter(entry.getKey(), entry.getValue());
             }
 
@@ -215,12 +215,12 @@ private <T> T submitGetRequest(final String url, final Map<String, String> getPa
 
             // Execute and return
             return httpClient.execute(get, responseHandler);
-        } catch (ClientProtocolException e) {
+        } catch (final ClientProtocolException e) {
             e.printStackTrace();
-        } catch (IOException e) {
+        } catch (final IOException e) {
             // Typically this is a parse error.
             e.printStackTrace();
-        } catch (URISyntaxException e) {
+        } catch (final URISyntaxException e) {
             // Bad URI building
             e.printStackTrace();
         }
@@ -257,9 +257,9 @@ private <T> T submitPostRequest(final String url, final Object requestBody, fina
 
             // Execute and return
             return httpClient.execute(post, responseHandler);
-        } catch (ClientProtocolException e) {
+        } catch (final ClientProtocolException e) {
             e.printStackTrace();
-        } catch (IOException e) {
+        } catch (final IOException e) {
             // Typically this is a parse error.
             e.printStackTrace();
         }
@@ -296,12 +296,12 @@ private <T> T submitPutRequest(final String url, final Object requestBody, final
 
             // Execute and return
             return httpClient.execute(put, responseHandler);
-        } catch (ClientProtocolException e) {
+        } catch (final ClientProtocolException e) {
             e.printStackTrace();
-        } catch (IOException e) {
+        } catch (final IOException e) {
             // Typically this is a parse error.
             e.printStackTrace();
-        } catch (URISyntaxException e) {
+        } catch (final URISyntaxException e) {
             // Bad URI building
             e.printStackTrace();
         }
@@ -340,12 +340,12 @@ private <T> T submitDeleteRequest(final String url, final Object requestBody, fi
 
             // Execute and return
             return httpClient.execute(delete, responseHandler);
-        } catch (ClientProtocolException e) {
+        } catch (final ClientProtocolException e) {
             e.printStackTrace();
-        } catch (IOException e) {
+        } catch (final IOException e) {
             // Typically this is a parse error.
             e.printStackTrace();
-        } catch (URISyntaxException e) {
+        } catch (final URISyntaxException e) {
             // Bad URI building
             e.printStackTrace();
         }

src/main/java/org/sourcelab/kafka/connect/apiclient/rest/HttpClientRestClient.java

@@ -20,7 +20,7 @@
 /**
  * Represents the response from the API.
  */
-public class RestResponse {
+public final class RestResponse {
     private final String responseStr;
     private final int httpCode;
 

src/main/java/org/sourcelab/kafka/connect/apiclient/rest/RestResponse.java

@@ -30,7 +30,7 @@
 /**
  * Handles parsing a response to RestResponse object.
  */
-public class RestResponseHandler implements ResponseHandler<RestResponse> {
+public final class RestResponseHandler implements ResponseHandler<RestResponse> {
     private static final Logger logger = LoggerFactory.getLogger(RestResponseHandler.class);
 
     @Override
@@ -46,7 +46,7 @@ public RestResponse handleResponse(final HttpResponse response) {
 
             // Construct return object
             return new RestResponse(responseStr, statusCode);
-        } catch (IOException exception) {
+        } catch (final IOException exception) {
             logger.error("Failed to read entity: {}", exception.getMessage(), exception);
             // TODO throw exception
             return null;

src/main/java/org/sourcelab/kafka/connect/apiclient/rest/handlers/RestResponseHandler.java

@@ -27,7 +27,7 @@
 /**
  * Returns response as a string.
  */
-public class StringResponseHandler implements ResponseHandler<String> {
+public final class StringResponseHandler implements ResponseHandler<String> {
     @Override
     public String handleResponse(final HttpResponse response) throws IOException {
 

src/main/java/org/sourcelab/kafka/connect/apiclient/rest/handlers/StringResponseHandler.java

@@ -48,12 +48,12 @@ public void doTest() throws FileNotFoundException {
         walk(projectRootPath);
     }
 
-    private void walk(File root) throws FileNotFoundException {
-        File[] list = root.listFiles();
+    private void walk(final File root) throws FileNotFoundException {
+        final File[] list = root.listFiles();
 
         if (list == null) return;
 
-        for (File f : list) {
+        for (final File f : list) {
             if (f.isDirectory()) {
                 walk(f);
             } else {
@@ -66,27 +66,27 @@ private void walk(File root) throws FileNotFoundException {
         }
     }
 
-    private void testFile(File myFile) throws FileNotFoundException {
-        String fileData = new Scanner(myFile).useDelimiter("\\Z").next();
+    private void testFile(final File myFile) throws FileNotFoundException {
+        final String fileData = new Scanner(myFile).useDelimiter("\\Z").next();
 
         // Look for our pattern
-        Matcher matches = regexPattern.matcher(fileData);
+        final Matcher matches = regexPattern.matcher(fileData);
 
         // If we didn't find a match
         if (!matches.find()) {
             return;
         }
 
         // Grab out the Class name
-        String loggerClassName = matches.group(1);
+        final String loggerClassName = matches.group(1);
         if (loggerClassName == null) {
             return;
         }
 
         // Get class name from the file name
         // I bet this will be completely broken for inner classes...
         // if you run into that, just exclude it? or figure out a better solution to this :p
-        String className = myFile.getName().replace(".java", "");
+        final String className = myFile.getName().replace(".java", "");
         if (!className.equals(loggerClassName)) {
             logger.info("Class {} ClassNameUsedByLogger {} ", className, loggerClassName);
             assertFalse("Found instance of logger using wrong class? " + myFile.getPath() + " Using " + loggerClassName, true);