Merge pull request #191 from rosette-api/ws-2537-fix-javadoc-generation-for-maven-central-requirement

WS-2537:  Fix Javadoc generation. And upgrades.

Author: seth-mg

.travis.yml

@@ -38,13 +38,13 @@
         <dependency>
             <groupId>com.squareup</groupId>
             <artifactId>javapoet</artifactId>
-            <version>1.9.0</version>
+            <version>${java-poet.version}</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
-            <version>1.18.20</version>
+            <version>${lombok.version}</version>
             <scope>provided</scope>
         </dependency>
     </dependencies>

annotations/pom.xml

@@ -1,5 +1,5 @@
 /*
-* Copyright 2017 Basis Technology Corp.
+* Copyright 2017-2022 Basis Technology Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -24,4 +24,4 @@
 @Retention(RetentionPolicy.SOURCE)
 @Target(ElementType.TYPE)
 public @interface JacksonMixin {
-}
+}

annotations/src/main/java/com/basistech/rosette/annotations/JacksonMixin.java

@@ -54,22 +54,22 @@
         <dependency>
             <groupId>org.apache.httpcomponents</groupId>
             <artifactId>httpclient</artifactId>
-            <version>${http-components-version}</version>
+            <version>${http-components.version}</version>
         </dependency>
         <dependency>
             <groupId>org.apache.httpcomponents</groupId>
             <artifactId>httpclient-osgi</artifactId>
-            <version>${http-components-version}</version>
+            <version>${http-components.version}</version>
         </dependency>
         <dependency>
             <groupId>org.apache.httpcomponents</groupId>
             <artifactId>httpcore-osgi</artifactId>
-            <version>${http-components-core-version}</version>
+            <version>${http-components-core.version}</version>
         </dependency>
         <dependency>
             <groupId>org.apache.httpcomponents</groupId>
             <artifactId>httpmime</artifactId>
-            <version>${http-components-version}</version>
+            <version>${http-components.version}</version>
         </dependency>
         <dependency>
             <groupId>org.slf4j</groupId>
@@ -82,19 +82,19 @@
         <dependency>
             <groupId>org.mock-server</groupId>
             <artifactId>mockserver-client-java</artifactId>
-            <version>${mockserver-version}</version>
+            <version>${mockserver.version}</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.mock-server</groupId>
             <artifactId>mockserver-core</artifactId>
-            <version>${mockserver-version}</version>
+            <version>${mockserver.version}</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.mock-server</groupId>
             <artifactId>mockserver-netty</artifactId>
-            <version>${mockserver-version}</version>
+            <version>${mockserver.version}</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -140,7 +140,7 @@
             <plugin>
                 <groupId>org.mock-server</groupId>
                 <artifactId>mockserver-maven-plugin</artifactId>
-                <version>${mockserver-version}</version>
+                <version>${mockserver.version}</version>
                 <configuration>
                     <serverPort>${mockServerClient.port}</serverPort>
                     <logLevel>WARN</logLevel>

api/pom.xml

@@ -1,5 +1,5 @@
 /*
-* Copyright 2017 Basis Technology Corp.
+* Copyright 2017-2022 Basis Technology Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -73,6 +73,7 @@
 import java.util.Properties;
 import java.util.Set;
 import java.util.concurrent.Future;
+import java.util.regex.Pattern;
 import java.util.zip.GZIPInputStream;
 
 import static java.net.HttpURLConnection.HTTP_OK;
@@ -85,8 +86,11 @@ public class HttpRosetteAPI extends AbstractRosetteAPI {
     public static final String DEFAULT_URL_BASE = "https://api.rosette.com/rest/v1";
     public static final String SERVICE_NAME = "RosetteAPI";
     public static final String BINDING_VERSION = getVersion();
-    public static final String USER_AGENT_STR = SERVICE_NAME + "-Java/" + BINDING_VERSION + "/" + System.getProperty("java.version");
+    public static final String USER_AGENT_STR = SERVICE_NAME + "-Java/" + BINDING_VERSION + "/"
+            + System.getProperty("java.version");
     private static final Logger LOG = LoggerFactory.getLogger(HttpRosetteAPI.class);
+    private static final String IO_EXCEPTION_MESSAGE = "IO Exception communicating with the Rosette API";
+    private static final Pattern TRAILING_SLASHES = Pattern.compile("/+$");
     private String urlBase = DEFAULT_URL_BASE;
     private int failureRetries = 1;
     private ObjectMapper mapper;
@@ -116,7 +120,7 @@ private HttpRosetteAPI() {
     HttpRosetteAPI(String key, String urlToCall, Integer failureRetries,
                        CloseableHttpClient httpClient, List<Header> additionalHeaders,
                        Integer connectionConcurrency, boolean onlyAcceptKnownFields) throws HttpRosetteAPIException {
-        urlBase = urlToCall == null ? urlBase : urlToCall.trim().replaceAll("/+$", "");
+        urlBase = urlToCall == null ? urlBase : TRAILING_SLASHES.matcher(urlToCall.trim()).replaceAll("");
         if (failureRetries != null && failureRetries >= 1) {
             this.failureRetries = failureRetries;
         }
@@ -241,7 +245,8 @@ public PingResponse ping() throws IOException, HttpRosetteAPIException {
     @Override
     public SupportedLanguagesResponse getSupportedLanguages(String endpoint) throws HttpRosetteAPIException  {
         if (DOC_ENDPOINTS.contains(endpoint) || NAME_DEDUPLICATION_SERVICE_PATH.equals(endpoint)) {
-            return sendGetRequest(urlBase + endpoint + SUPPORTED_LANGUAGES_SUBPATH, SupportedLanguagesResponse.class);
+            return sendGetRequest(urlBase + endpoint + SUPPORTED_LANGUAGES_SUBPATH,
+                    SupportedLanguagesResponse.class);
         } else {
             return null;
         }
@@ -258,7 +263,8 @@ public SupportedLanguagesResponse getSupportedLanguages(String endpoint) throws
     @Override
     public SupportedLanguagePairsResponse getSupportedLanguagePairs(String endpoint) throws HttpRosetteAPIException  {
         if (NAMES_ENDPOINTS.contains(endpoint) && !NAME_DEDUPLICATION_SERVICE_PATH.equals(endpoint)) {
-            return sendGetRequest(urlBase + endpoint + SUPPORTED_LANGUAGES_SUBPATH, SupportedLanguagePairsResponse.class);
+            return sendGetRequest(urlBase + endpoint + SUPPORTED_LANGUAGES_SUBPATH,
+                    SupportedLanguagePairsResponse.class);
         } else {
             return null;
         }
@@ -276,11 +282,12 @@ public SupportedLanguagePairsResponse getSupportedLanguagePairs(String endpoint)
      * @throws RosetteRuntimeException for other errors, such as communications problems with HTTP.
      */
     @Override
-    public <RequestType extends Request, ResponseType extends Response> ResponseType perform(String endpoint, RequestType request, Class<ResponseType> responseClass) throws HttpRosetteAPIException {
+    public <RequestType extends Request, ResponseType extends Response> ResponseType perform(String endpoint,
+                             RequestType request, Class<ResponseType> responseClass) throws HttpRosetteAPIException {
         try {
             return sendPostRequest(request, urlBase + endpoint, responseClass);
         } catch (IOException e) {
-            throw new RosetteRuntimeException("IO Exception communicating with the Rosette API", e);
+            throw new RosetteRuntimeException(IO_EXCEPTION_MESSAGE, e);
         } catch (URISyntaxException e) {
             throw new RosetteRuntimeException("Invalid URI", e);
         }
@@ -296,11 +303,12 @@ public <RequestType extends Request, ResponseType extends Response> ResponseType
      * @throws RosetteRuntimeException for other errors, such as communications problems with HTTP.
      */
     @Override
-    public <RequestType extends Request> AnnotatedText perform(String endpoint, RequestType request) throws HttpRosetteAPIException {
+    public <RequestType extends Request> AnnotatedText perform(String endpoint, RequestType request)
+            throws HttpRosetteAPIException {
         try {
             return sendPostRequest(request, urlBase + endpoint, AnnotatedText.class);
         } catch (IOException e) {
-            throw new RosetteRuntimeException("IO Exception communicating with the Rosette API", e);
+            throw new RosetteRuntimeException(IO_EXCEPTION_MESSAGE, e);
         } catch (URISyntaxException e) {
             throw new RosetteRuntimeException("Invalid URI", e);
         }
@@ -310,7 +318,9 @@ public <RequestType extends Request> AnnotatedText perform(String endpoint, Requ
      * This method always throws UnsupportedOperationException.
      */
     @Override
-    public <RequestType extends Request, ResponseType extends Response> Future<ResponseType> performAsync(String endpoint, RequestType request, Class<ResponseType> responseClass) throws HttpRosetteAPIException {
+    public <RequestType extends Request, ResponseType extends Response> Future<ResponseType>
+        performAsync(String endpoint, RequestType request, Class<ResponseType> responseClass)
+            throws HttpRosetteAPIException {
         throw new UnsupportedOperationException("Asynchronous operations are not yet supported");
     }
 
@@ -335,7 +345,7 @@ private <T extends Response> T sendGetRequest(String urlStr, Class<T> clazz) thr
             responseHeadersToExtendedInformation(resp, httpResponse);
             return resp;
         } catch (IOException e) {
-            throw new RosetteRuntimeException("IO Exception communicating with the Rosette API", e);
+            throw new RosetteRuntimeException(IO_EXCEPTION_MESSAGE, e);
         }
     }
 
@@ -349,7 +359,8 @@ private <T extends Response> T sendGetRequest(String urlStr, Class<T> clazz) thr
      * @return Response
      * @throws IOException
      */
-    private <T> T sendPostRequest(Object request, String urlStr, Class<T> clazz) throws IOException, URISyntaxException {
+    private <T> T sendPostRequest(Object request, String urlStr, Class<T> clazz)
+            throws IOException, URISyntaxException {
         ObjectWriter writer = mapper.writer().without(JsonGenerator.Feature.AUTO_CLOSE_TARGET);
         boolean notPlainText = false;
         if (request instanceof DocumentRequest) {
@@ -391,7 +402,7 @@ private <T> T sendPostRequest(Object request, String urlStr, Class<T> clazz) thr
                 T resp = getResponse(response, clazz);
                 Header ridHeader = response.getFirstHeader("X-RosetteAPI-DocumentRequest-Id");
                 if (ridHeader != null && ridHeader.getValue() != null) {
-                    LOG.debug("DocumentRequest ID " + ridHeader.getValue());
+                    LOG.debug("DocumentRequest ID {}", ridHeader.getValue());
                 }
                 if (resp instanceof Response) {
                     responseHeadersToExtendedInformation((Response)resp, response);
@@ -418,7 +429,8 @@ private <T extends Response> void responseHeadersToExtendedInformation(T resp, H
                 if (resp.getExtendedInformation().get(header.getName()) instanceof Set) {
                     currentSetValue = (Set<Object>) resp.getExtendedInformation().get(header.getName());
                 } else {
-                    currentSetValue = new HashSet<>(Collections.singletonList(resp.getExtendedInformation().get(header.getName())));
+                    currentSetValue = new HashSet<>(Collections.singletonList(resp
+                            .getExtendedInformation().get(header.getName())));
                 }
                 currentSetValue.add(header.getValue());
                 resp.addExtendedInformation(header.getName(), currentSetValue);
@@ -459,7 +471,8 @@ public boolean isStreaming() {
         });
     }
 
-    private void setupMultipartRequest(final Request request, final ObjectWriter finalWriter, HttpPost post) throws IOException {
+    private void setupMultipartRequest(final Request request, final ObjectWriter finalWriter, HttpPost post)
+            throws IOException {
         MultipartEntityBuilder builder = MultipartEntityBuilder.create();
         builder.setMimeSubtype("mixed");
         builder.setMode(HttpMultipartMode.STRICT);
@@ -533,7 +546,8 @@ private String headerValueOrNull(Header header) {
      * @return Response
      * @throws IOException
      */
-    private <T extends Object> T getResponse(HttpResponse httpResponse, Class<T> clazz) throws IOException, HttpRosetteAPIException {
+    private <T extends Object> T getResponse(HttpResponse httpResponse, Class<T> clazz)
+            throws IOException, HttpRosetteAPIException {
         int status = httpResponse.getStatusLine().getStatusCode();
         String encoding = headerValueOrNull(httpResponse.getFirstHeader(HttpHeaders.CONTENT_ENCODING));
 
@@ -548,15 +562,16 @@ private <T extends Object> T getResponse(HttpResponse httpResponse, Class<T> cla
                 if ("application/json".equals(responseContentType)) {
                     ErrorResponse errorResponse = mapper.readValue(inputStream, ErrorResponse.class);
                     if (ridHeader != null) {
-                        LOG.debug("DocumentRequest ID " + ridHeader);
+                        LOG.debug("DocumentRequest ID {}", ridHeader);
                     }
                     if (ecHeader != null) {
                         errorResponse.setCode(ecHeader);
                     }
                     if (429 == status) {
                         String concurrencyMessage = "You have exceeded your plan's limit on concurrent calls. "
-                                + "This could be caused by multiple processes or threads making Rosette API calls in parallel, "
-                                + "or if your httpClient is configured with higher concurrency than your plan allows.";
+                                + "This could be caused by multiple processes or threads making Rosette API calls "
+                                + "in parallel, or if your httpClient is configured with higher concurrency "
+                                + "than your plan allows.";
                         if (emHeader == null) {
                             emHeader = concurrencyMessage;
                         } else {
@@ -677,6 +692,7 @@ public Builder additionalHeader(String name, String value) {
          * Only process the response from server if all fields are recognized. If set and a new
          * field is returned in the response, exception will be thrown.
          *
+         * @param onlyAcceptKnownFields whether to accept known fields.
          * @return this.
          */
         public Builder onlyAcceptKnownFields(boolean onlyAcceptKnownFields) {

api/src/main/java/com/basistech/rosette/api/HttpRosetteAPI.java

@@ -1,5 +1,5 @@
 /*
-* Copyright 2017 Basis Technology Corp.
+* Copyright 2017-2022 Basis Technology Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -64,11 +64,12 @@ public class BasicTest extends AbstractTest {
     private MockServerClient mockServer;
     private HttpRosetteAPI api;
 
-    private static int getFreePort() {
+    public BasicTest() throws IOException {
+    }
+
+    private static int getFreePort() throws IOException {
         try (ServerSocket socket = new ServerSocket(0)) {
             serverPort = socket.getLocalPort();
-        } catch (IOException e) {
-            fail("Failed to allocate a port");
         }
         assertNotEquals(0, serverPort);
         return serverPort;
@@ -118,7 +119,7 @@ public void testMultipleConnections() throws IOException, InterruptedException {
 
         Date d2 = new Date();
 
-        assert d2.getTime() - d1.getTime() > delayTime * numConnections * 1000; // at least as long as the delay in the request
+        assertTrue(d2.getTime() - d1.getTime() > delayTime * numConnections * 1000); // at least as long as the delay in the request
 
         api = new HttpRosetteAPI.Builder().connectionConcurrency(numConnections)
                 .url(String.format("http://localhost:%d/rest/v1", serverPort))
@@ -137,8 +138,8 @@ public void testMultipleConnections() throws IOException, InterruptedException {
 
         d2 = new Date();
 
-        assert d2.getTime() - d1.getTime() < delayTime * numConnections * 1000; // less than (numConnections) serial requests
-        assert d2.getTime() - d1.getTime() > delayTime * 1000; // but at least as long as one
+        assertTrue(d2.getTime() - d1.getTime() < delayTime * numConnections * 1000); // less than (numConnections) serial requests
+        assertTrue(d2.getTime() - d1.getTime() > delayTime * 1000); // but at least as long as one
     }
 
     @Test
@@ -159,7 +160,8 @@ public void testHeaders() throws Exception {
                 .url(String.format("http://localhost:%d/rest/v1", serverPort))
                 .additionalHeader("X-Foo", "Bar")
                 .build();
-        api.ping();
+        var resp = api.ping();
+        assertEquals("5", resp.getExtendedInformation().get("X-RosetteAPI-Concurrency"));
     }
 
     @Test