From 1dce37f5ddcd50cd5ec592a0746912fae354080f Mon Sep 17 00:00:00 2001 From: Stephen Powis Date: Tue, 29 Jan 2019 10:25:33 +0900 Subject: [PATCH 1/2] Update internal dependencies, resolve updated checkstyle rule violations --- build/checkstyle-v1.5.xml | 3 --- pom.xml | 10 +++++----- .../kafka/connect/apiclient/request/Request.java | 7 +++++-- .../request/dto/ConnectorPluginConfigDefinition.java | 2 +- .../apiclient/request/dto/NewConnectorDefinition.java | 2 +- .../connect/apiclient/request/post/PostConnector.java | 2 +- .../rest/exceptions/InvalidRequestException.java | 3 ++- 7 files changed, 15 insertions(+), 14 deletions(-) diff --git a/build/checkstyle-v1.5.xml b/build/checkstyle-v1.5.xml index 80eae51..731a1b7 100644 --- a/build/checkstyle-v1.5.xml +++ b/build/checkstyle-v1.5.xml @@ -37,9 +37,6 @@ - - - diff --git a/pom.xml b/pom.xml index e9aceb3..0779d9d 100644 --- a/pom.xml +++ b/pom.xml @@ -47,10 +47,10 @@ UTF-8 - 25.0-jre + 27.0.1-jre - 4.5.5 + 4.5.7 2.9.8 @@ -61,10 +61,10 @@ build/checkstyle-v1.5.xml 2.17 - 8.0 + 8.17 - 2.8.2 + 2.11.1 false @@ -141,7 +141,7 @@ org.hamcrest hamcrest-library - 1.3 + 2.1 test diff --git a/src/main/java/org/sourcelab/kafka/connect/apiclient/request/Request.java b/src/main/java/org/sourcelab/kafka/connect/apiclient/request/Request.java index 2d4d5e8..31e280e 100644 --- a/src/main/java/org/sourcelab/kafka/connect/apiclient/request/Request.java +++ b/src/main/java/org/sourcelab/kafka/connect/apiclient/request/Request.java @@ -26,17 +26,20 @@ public interface Request { /** - * @return The name of the end point this request uses. Example: "campaign", "user", etc.. + * The name of the API end point to issue a request against. This is appended to the API Hostname. + * @return The name of the end point this request uses. */ String getApiEndpoint(); /** + * Request Method, IE POST, GET, etc.. * @return The type of HTTP Request. */ RequestMethod getRequestMethod(); /** - * @return correctly formatted request parameters. + * Object to be submitted as the body of the request. It will be serialized to JSON using Jackson. + * @return Object representing request body content. */ Object getRequestBody(); diff --git a/src/main/java/org/sourcelab/kafka/connect/apiclient/request/dto/ConnectorPluginConfigDefinition.java b/src/main/java/org/sourcelab/kafka/connect/apiclient/request/dto/ConnectorPluginConfigDefinition.java index 6cbe8af..968251b 100644 --- a/src/main/java/org/sourcelab/kafka/connect/apiclient/request/dto/ConnectorPluginConfigDefinition.java +++ b/src/main/java/org/sourcelab/kafka/connect/apiclient/request/dto/ConnectorPluginConfigDefinition.java @@ -29,7 +29,7 @@ public final class ConnectorPluginConfigDefinition { private final Map config; /** - * Constructor + * Constructor. * @param connectorPluginName Name of Connector Plugin. * @param config Configuration values for connector. */ diff --git a/src/main/java/org/sourcelab/kafka/connect/apiclient/request/dto/NewConnectorDefinition.java b/src/main/java/org/sourcelab/kafka/connect/apiclient/request/dto/NewConnectorDefinition.java index 6b175e2..a7f4e28 100644 --- a/src/main/java/org/sourcelab/kafka/connect/apiclient/request/dto/NewConnectorDefinition.java +++ b/src/main/java/org/sourcelab/kafka/connect/apiclient/request/dto/NewConnectorDefinition.java @@ -29,7 +29,7 @@ public final class NewConnectorDefinition { private final Map config; /** - * Constructor + * Constructor. * @param name Name of Connector. * @param config Configuration values for connector. */ diff --git a/src/main/java/org/sourcelab/kafka/connect/apiclient/request/post/PostConnector.java b/src/main/java/org/sourcelab/kafka/connect/apiclient/request/post/PostConnector.java index fee7ff5..88cc0b5 100644 --- a/src/main/java/org/sourcelab/kafka/connect/apiclient/request/post/PostConnector.java +++ b/src/main/java/org/sourcelab/kafka/connect/apiclient/request/post/PostConnector.java @@ -31,7 +31,7 @@ public final class PostConnector implements PostRequest { private final NewConnectorDefinition connectorDefinition; /** - * Constructor + * Constructor. * @param connectorDefinition Defines the new connector to be deployed. */ public PostConnector(final NewConnectorDefinition connectorDefinition) { diff --git a/src/main/java/org/sourcelab/kafka/connect/apiclient/rest/exceptions/InvalidRequestException.java b/src/main/java/org/sourcelab/kafka/connect/apiclient/rest/exceptions/InvalidRequestException.java index ab71de2..ac9d789 100644 --- a/src/main/java/org/sourcelab/kafka/connect/apiclient/rest/exceptions/InvalidRequestException.java +++ b/src/main/java/org/sourcelab/kafka/connect/apiclient/rest/exceptions/InvalidRequestException.java @@ -48,7 +48,8 @@ public InvalidRequestException(final String message, final Throwable cause) { } /** - * @return Http Error Code. + * Resulting HTTP Status code. + * @return Http Status Code. */ public int getErrorCode() { return errorCode; From 8cc5ffde7b6b503e3e0b9c3ecbf7a251e442930e Mon Sep 17 00:00:00 2001 From: Stephen Powis Date: Tue, 29 Jan 2019 10:26:50 +0900 Subject: [PATCH 2/2] Optimize Imports --- .../sourcelab/kafka/connect/apiclient/KafkaConnectClient.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/sourcelab/kafka/connect/apiclient/KafkaConnectClient.java b/src/main/java/org/sourcelab/kafka/connect/apiclient/KafkaConnectClient.java index 4115f6e..26e0485 100644 --- a/src/main/java/org/sourcelab/kafka/connect/apiclient/KafkaConnectClient.java +++ b/src/main/java/org/sourcelab/kafka/connect/apiclient/KafkaConnectClient.java @@ -46,9 +46,9 @@ import org.sourcelab.kafka.connect.apiclient.request.put.PutConnectorPluginConfigValidate; import org.sourcelab.kafka.connect.apiclient.request.put.PutConnectorResume; import org.sourcelab.kafka.connect.apiclient.rest.HttpClientRestClient; -import org.sourcelab.kafka.connect.apiclient.rest.exceptions.InvalidRequestException; import org.sourcelab.kafka.connect.apiclient.rest.RestClient; import org.sourcelab.kafka.connect.apiclient.rest.RestResponse; +import org.sourcelab.kafka.connect.apiclient.rest.exceptions.InvalidRequestException; import java.io.IOException; import java.util.Collection;