ATS-532 : Code improvements (#89)

- move startup message from controllers to the Application classes (SpringBoot configuration beans) - added static imports for most static variables and static methods - simplified a few nested *if*s - replaced Arrays.asList() with explicit immutable collections - fixed a few IntelliJ code inspection warnings
2025-08-21 18:08:37 +00:00 · 2019-08-18 18:45:14 +03:00
parent 485347729b
commit 22de0ce5df
40 changed files with 391 additions and 329 deletions
--- a/alfresco-docker-tika/src/main/java/org/alfresco/transformer/Application.java
+++ b/alfresco-docker-tika/src/main/java/org/alfresco/transformer/Application.java
@@ -26,13 +26,21 @@
 */
 package org.alfresco.transformer;

+import static org.alfresco.transformer.logging.StandardMessages.LICENCE;
+
+import java.util.Arrays;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.actuate.autoconfigure.metrics.MeterRegistryCustomizer;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
+import org.springframework.boot.context.event.ApplicationReadyEvent;
 import org.springframework.context.annotation.Bean;
+import org.springframework.context.event.EventListener;

 import io.micrometer.core.instrument.MeterRegistry;

@@ -40,6 +48,8 @@ import io.micrometer.core.instrument.MeterRegistry;
@EnableAutoConfiguration(exclude = {DataSourceAutoConfiguration.class})
 public class Application
 {
+    private static final Logger logger = LoggerFactory.getLogger(Application.class);
+
    @Value("${container.name}")
    private String containerName;

@@ -53,4 +63,15 @@ public class Application
    {
        SpringApplication.run(Application.class, args);
    }
+
+    @EventListener(ApplicationReadyEvent.class)
+    public void startup()
+    {
+        logger.info("--------------------------------------------------------------------------------------------------------------------------------------------------------------");
+        Arrays.stream(LICENCE.split("\\n")).forEach(logger::info);
+        logger.info("Tika is from Apache. See the license at http://www.apache.org/licenses/LICENSE-2.0. or in /Apache\\ 2.0.txt");
+        logger.info("--------------------------------------------------------------------------------------------------------------------------------------------------------------");
+
+        logger.info("Starting application components... Done");
+    }
 }
--- a/alfresco-docker-tika/src/main/java/org/alfresco/transformer/TikaController.java
+++ b/alfresco-docker-tika/src/main/java/org/alfresco/transformer/TikaController.java
@@ -37,13 +37,12 @@ import static org.alfresco.transformer.fs.FileManager.createAttachment;
 import static org.alfresco.transformer.fs.FileManager.createSourceFile;
 import static org.alfresco.transformer.fs.FileManager.createTargetFile;
 import static org.alfresco.transformer.fs.FileManager.createTargetFileName;
-import static org.alfresco.transformer.logging.StandardMessages.LICENCE;
 import static org.alfresco.transformer.util.Util.stringToBoolean;
 import static org.springframework.http.HttpStatus.BAD_REQUEST;
 import static org.springframework.http.HttpStatus.OK;
+import static org.springframework.http.MediaType.MULTIPART_FORM_DATA_VALUE;

 import java.io.File;
-import java.util.Arrays;
 import java.util.Map;

 import javax.servlet.http.HttpServletRequest;
@@ -56,7 +55,6 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.core.io.Resource;
-import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -69,9 +67,9 @@ import org.springframework.web.multipart.MultipartFile;
 * Status Codes:
 *
 * 200 Success
- * 400 Bad Request: Invalid target mimetype &lt;mimetype>
- * 400 Bad Request: Request parameter &lt;name> is missing (missing mandatory parameter)
- * 400 Bad Request: Request parameter &lt;name> is of the wrong type
+ * 400 Bad Request: Invalid target mimetype <mimetype>
+ * 400 Bad Request: Request parameter <name> is missing (missing mandatory parameter)
+ * 400 Bad Request: Request parameter <name> is of the wrong type
 * 400 Bad Request: Transformer exit code was not 0 (possible problem with the source file)
 * 400 Bad Request: The source filename was not supplied
 * 500 Internal Server Error: (no message with low level IO problems)
@@ -92,18 +90,6 @@ public class TikaController extends AbstractTransformerController
    @Autowired
    private TikaJavaExecutor javaExecutor;

-    @Autowired
-    public TikaController()
-    {
-        logger.info(
-            "--------------------------------------------------------------------------------------------------------------------------------------------------------------");
-        Arrays.stream(LICENCE.split("\\n")).forEach(logger::info);
-        logger.info(
-            "Tika is from Apache. See the license at http://www.apache.org/licenses/LICENSE-2.0. or in /Apache\\ 2.0.txt");
-        logger.info(
-            "--------------------------------------------------------------------------------------------------------------------------------------------------------------");
-    }
-
    @Override
    public String getTransformerName()
    {
@@ -133,7 +119,7 @@ public class TikaController extends AbstractTransformerController
        };
    }

-    @PostMapping(value = "/transform", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
+    @PostMapping(value = "/transform", consumes = MULTIPART_FORM_DATA_VALUE)
    public ResponseEntity<Resource> transform(HttpServletRequest request,
        @RequestParam("file") MultipartFile sourceMultipartFile,
        @RequestParam("targetExtension") String targetExtension,
--- a/alfresco-docker-tika/src/main/java/org/alfresco/transformer/executors/Tika.java
+++ b/alfresco-docker-tika/src/main/java/org/alfresco/transformer/executors/Tika.java
@@ -26,7 +26,6 @@
 */
 package org.alfresco.transformer.executors;

-import static java.util.Arrays.asList;
 import static org.alfresco.repo.content.MimetypeMap.MIMETYPE_HTML;
 import static org.alfresco.repo.content.MimetypeMap.MIMETYPE_IMAGE_JPEG;
 import static org.alfresco.repo.content.MimetypeMap.MIMETYPE_IMAGE_PNG;
@@ -74,6 +73,8 @@ import org.xml.sax.Attributes;
 import org.xml.sax.ContentHandler;
 import org.xml.sax.SAXException;

+import com.google.common.collect.ImmutableList;
+
 /**
 * Stripped down command line Tika transformers. Not actually run as a separate process, but the code fits the patten
 * used by transformers that do.
@@ -455,7 +456,7 @@ public class Tika
    public static final String TIKA_AUTO = "TikaAuto";
    public static final String TEXT_MINING = "TextMining";

-    public static final List<String> TRANSFORM_NAMES = asList(
+    public static final List<String> TRANSFORM_NAMES = ImmutableList.of(
        ARCHIVE, OUTLOOK_MSG, PDF_BOX, POI_OFFICE, POI, POI_OO_XML, TIKA_AUTO, TEXT_MINING);

    public static final String TARGET_MIMETYPE = "--targetMimetype=";
@@ -484,9 +485,9 @@ public class Tika
    private final Parser tikaOfficeDetectParser = new TikaOfficeDetectParser();
    private final PDFParserConfig pdfParserConfig = new PDFParserConfig();

-    private DocumentSelector pdfBoxEmbededDocumentSelector = new DocumentSelector()
+    private final DocumentSelector pdfBoxEmbededDocumentSelector = new DocumentSelector()
    {
-        private final List<String> disabledMediaTypes = asList(MIMETYPE_IMAGE_JPEG,
+        private final List<String> disabledMediaTypes = ImmutableList.of(MIMETYPE_IMAGE_JPEG,
            MIMETYPE_IMAGE_TIFF, MIMETYPE_IMAGE_PNG);

        @Override
--- a/alfresco-docker-tika/src/test/java/org/alfresco/transformer/TikaControllerTest.java
+++ b/alfresco-docker-tika/src/test/java/org/alfresco/transformer/TikaControllerTest.java
@@ -64,10 +64,18 @@ import static org.junit.Assert.assertTrue;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyLong;
 import static org.mockito.Mockito.when;
+import static org.springframework.http.HttpHeaders.ACCEPT;
+import static org.springframework.http.HttpHeaders.CONTENT_DISPOSITION;
+import static org.springframework.http.HttpHeaders.CONTENT_TYPE;
+import static org.springframework.http.HttpStatus.CREATED;
 import static org.springframework.http.HttpStatus.INTERNAL_SERVER_ERROR;
 import static org.springframework.http.HttpStatus.OK;
+import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
+import static org.springframework.http.MediaType.APPLICATION_PDF_VALUE;
+import static org.springframework.http.MediaType.TEXT_PLAIN_VALUE;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+import static org.springframework.util.StringUtils.getFilenameExtension;

 import java.io.File;
 import java.io.IOException;
@@ -93,15 +101,12 @@ import org.springframework.boot.test.mock.mockito.SpyBean;
 import org.springframework.core.io.FileSystemResource;
 import org.springframework.core.io.Resource;
 import org.springframework.http.HttpHeaders;
-import org.springframework.http.HttpStatus;
-import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.mock.web.MockMultipartFile;
 import org.springframework.test.context.junit4.SpringRunner;
 import org.springframework.test.web.servlet.MvcResult;
 import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
 import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
-import org.springframework.util.StringUtils;

 /**
 * Test the TikaController without a server.
@@ -169,7 +174,7 @@ public class TikaControllerTest extends AbstractTransformerControllerTest
                String actualOptions = actualProperties.get("options");
                String actualSource = actualProperties.get("source");
                String actualTarget = actualProperties.get("target");
-                String actualTargetExtension = StringUtils.getFilenameExtension(actualTarget);
+                String actualTargetExtension = getFilenameExtension(actualTarget);

                assertNotNull(actualSource);
                assertNotNull(actualTarget);
@@ -533,11 +538,10 @@ public class TikaControllerTest extends AbstractTransformerControllerTest
    {
        transformRequest.setSourceExtension(sourceExtension);
        transformRequest.setTargetExtension(targetExtension);
-        transformRequest.setSourceMediaType(MediaType.APPLICATION_PDF_VALUE);
-        transformRequest.setTargetMediaType(MediaType.TEXT_PLAIN_VALUE);
+        transformRequest.setSourceMediaType(APPLICATION_PDF_VALUE);
+        transformRequest.setTargetMediaType(TEXT_PLAIN_VALUE);
        transformRequest.getTransformRequestOptions().put("transform", "PdfBox");
-        transformRequest.getTransformRequestOptions().put("targetMimetype",
-            MediaType.TEXT_PLAIN_VALUE);
+        transformRequest.getTransformRequestOptions().put("targetMimetype", TEXT_PLAIN_VALUE);
        transformRequest.getTransformRequestOptions().put("targetEncoding", "UTF-8");
    }

@@ -562,14 +566,13 @@ public class TikaControllerTest extends AbstractTransformerControllerTest

        // HTTP Request
        HttpHeaders headers = new HttpHeaders();
-        headers.set(HttpHeaders.CONTENT_DISPOSITION,
-            "attachment; filename=quick." + sourceExtension);
+        headers.set(CONTENT_DISPOSITION, "attachment; filename=quick." + sourceExtension);
        ResponseEntity<Resource> response = new ResponseEntity<>(new FileSystemResource(
            sourceFile), headers, OK);

        when(alfrescoSharedFileStoreClient.retrieveFile(sourceFileRef)).thenReturn(response);
-        when(alfrescoSharedFileStoreClient.saveFile(any())).thenReturn(
-            new FileRefResponse(new FileRefEntity(targetFileRef)));
+        when(alfrescoSharedFileStoreClient.saveFile(any()))
+            .thenReturn(new FileRefResponse(new FileRefEntity(targetFileRef)));
        when(mockExecutionResult.getExitValue()).thenReturn(0);

        // Update the Transformation Request with any specific params before sending it
@@ -577,14 +580,14 @@ public class TikaControllerTest extends AbstractTransformerControllerTest

        // Serialize and call the transformer
        String tr = objectMapper.writeValueAsString(transformRequest);
-        String transformationReplyAsString = mockMvc.perform(
-            MockMvcRequestBuilders.post("/transform")
-                                  .header(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON_VALUE)
-                                  .header(HttpHeaders.CONTENT_TYPE,
-                                      MediaType.APPLICATION_JSON_VALUE).content(tr))
-                                                    .andExpect(
-                                                        status().is(HttpStatus.CREATED.value()))
-                                                    .andReturn().getResponse().getContentAsString();
+        String transformationReplyAsString = mockMvc
+            .perform(MockMvcRequestBuilders
+                .post("/transform")
+                .header(ACCEPT, APPLICATION_JSON_VALUE)
+                .header(CONTENT_TYPE, APPLICATION_JSON_VALUE)
+                .content(tr))
+            .andExpect(status().is(CREATED.value()))
+            .andReturn().getResponse().getContentAsString();

        TransformReply transformReply = objectMapper.readValue(transformationReplyAsString,
            TransformReply.class);