Merge pull request #124 from datalogics-kam/dlpjts-129-logging

DLPJTS-129 Use slf4j and log4j for logging.
datalogics · Oct 10, 2017 · 8d13af1 · 8d13af1
2 parents c4ee065 + ae576eb
commit 8d13af1
Show file tree

Hide file tree

Showing 18 changed files with 220 additions and 218 deletions.
diff --git a/.gitignore b/.gitignore
@@ -112,7 +112,7 @@ fabric.properties
 ### Intellij Patch ###
 # Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
 
-# *.iml
+*.iml
 # modules.xml
 # .idea/misc.xml
 # *.ipr

diff --git a/lite/pom.xml b/lite/pom.xml
@@ -36,7 +36,7 @@
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
     <checkstyle-config.version>2.0.2-SNAPSHOT</checkstyle-config.version>
     <pmdconfig.version>2.0.0-SNAPSHOT</pmdconfig.version>
-    <pmdVersion>5.5.2</pmdVersion>
+    <pmdVersion>5.8.1</pmdVersion>
   </properties>
   <dependencyManagement>
     <dependencies>
@@ -110,6 +110,23 @@
       <version>3.5</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-api</artifactId>
+      <version>1.7.25</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-slf4j-impl</artifactId>
+      <version>2.9.1</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-core</artifactId>
+      <version>2.9.1</version>
+      <classifier>tests</classifier>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
   <build>
     <pluginManagement>
@@ -278,7 +295,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-pmd-plugin</artifactId>
-        <version>3.7</version>
+        <version>3.8</version>
         <executions>
           <execution>
             <goals>
@@ -363,7 +380,7 @@
       <plugin>
         <groupId>org.codehaus.mojo</groupId>
         <artifactId>animal-sniffer-maven-plugin</artifactId>
-        <version>1.14</version>
+        <version>1.16</version>
         <executions>
           <execution>
             <id>check-java-version</id>
@@ -570,6 +587,8 @@
                         <include>.settings/org.eclipse.m2e.core.prefs</include>
                         <!-- all the Markdown files at the top level -->
                         <include>*.md</include>
+                        <!-- log4j2 configuration files -->
+                        <include>src/**/log4j2*.xml</include>
                         <!-- things used to build the project -->
                         <include>fix_throws_javadoc.sed</include>
                         <include>fix_throws_javadoc.sh</include>

diff --git a/pdf-java-toolkit-samples.iml b/pdf-java-toolkit-samples.iml
diff --git a/pom.xml b/pom.xml
@@ -37,7 +37,7 @@
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
     <checkstyle-config.version>2.1.0-SNAPSHOT</checkstyle-config.version>
     <pmdconfig.version>2.0.0-SNAPSHOT</pmdconfig.version>
-    <pmdVersion>5.5.2</pmdVersion>
+    <pmdVersion>5.8.1</pmdVersion>
   </properties>
   <dependencyManagement>
     <dependencies>
@@ -111,6 +111,23 @@
       <version>3.5</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-api</artifactId>
+      <version>1.7.25</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-slf4j-impl</artifactId>
+      <version>2.9.1</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-core</artifactId>
+      <version>2.9.1</version>
+      <classifier>tests</classifier>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
   <build>
     <pluginManagement>
@@ -278,7 +295,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-pmd-plugin</artifactId>
-        <version>3.7</version>
+        <version>3.8</version>
         <executions>
           <execution>
             <goals>
@@ -382,7 +399,7 @@
       <plugin>
         <groupId>org.codehaus.mojo</groupId>
         <artifactId>animal-sniffer-maven-plugin</artifactId>
-        <version>1.14</version>
+        <version>1.16</version>
         <executions>
           <execution>
             <id>check-java-version</id>

diff --git a/src/main/java/com/datalogics/pdf/samples/extraction/TextExtract.java b/src/main/java/com/datalogics/pdf/samples/extraction/TextExtract.java
@@ -20,22 +20,24 @@
 import com.datalogics.pdf.samples.util.FontUtils;
 import com.datalogics.pdf.samples.util.IoUtils;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
+import java.lang.invoke.MethodHandles;
 import java.net.URISyntaxException;
 import java.net.URL;
 import java.nio.file.Files;
-import java.util.logging.Level;
-import java.util.logging.Logger;
 
 /**
  * This sample demonstrates how to extract text from a document. The text is extracted in reading order and then saved
  * to a text file.
  */
 public final class TextExtract {
-    private static final Logger LOGGER = Logger.getLogger(TextExtract.class.getName());
+    private static final Logger LOGGER = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
     public static final String INPUT_PDF_PATH = "/com/datalogics/pdf/samples/pdfjavatoolkit-ds.pdf";
     public static final String OUTPUT_TEXT_PATH = "TextExtract.txt";
@@ -105,7 +107,7 @@ public static void extractTextReadingOrder(final URL inputUrl, final URL outputU
                     } while (wordsIter.hasNext());
                 }
             } else {
-                if (LOGGER.isLoggable(Level.INFO)) {
+                if (LOGGER.isInfoEnabled()) {
                     LOGGER.info(inputUrl.toURI().getPath() + " did not have any text to extract.");
                 }
             }

diff --git a/src/main/java/com/datalogics/pdf/samples/forms/ExportFormDataToCsv.java b/src/main/java/com/datalogics/pdf/samples/forms/ExportFormDataToCsv.java
@@ -18,17 +18,18 @@
 
 import org.apache.commons.csv.CSVFormat;
 import org.apache.commons.csv.CSVPrinter;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.io.File;
 import java.io.IOException;
 import java.io.PrintWriter;
+import java.lang.invoke.MethodHandles;
 import java.net.URISyntaxException;
 import java.net.URL;
 import java.nio.file.Files;
 import java.util.Iterator;
 import java.util.List;
-import java.util.logging.Level;
-import java.util.logging.Logger;
 
 /**
  * This sample demonstrates exporting data from PDF form fields with formatting to a CSV file.
@@ -37,7 +38,7 @@ public final class ExportFormDataToCsv {
     public static final String DEFAULT_INPUT = "filled_acroform.pdf";
     public static final String CSV_OUTPUT = "exported-form-data.csv";
 
-    private static final Logger LOGGER = Logger.getLogger(ExportFormDataToCsv.class.getName());
+    private static final Logger LOGGER = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
     /**
      * This is a utility class, and won't be instantiated.
@@ -160,17 +161,17 @@ private static void exportFieldValues(final PDFInteractiveForm form, final CSVPr
                 final List<?> value = field.getValueList();
                 if (value == null) {
                     printer.print("");
-                    if (LOGGER.isLoggable(Level.WARNING)) {
-                        LOGGER.warning(field.getQualifiedName() + " has no value!");
+                    if (LOGGER.isWarnEnabled()) {
+                        LOGGER.warn(field.getQualifiedName() + " has no value!");
                     }
                 } else {
                     // If the list of values is not empty, write out only the first one.
                     // For more complex forms, the field type should be inspected to
                     // determine how to handle extracting the values.
                     printer.print(value.get(0).toString());
-                    if (LOGGER.isLoggable(Level.WARNING)) {
-                        LOGGER.warning(field.getQualifiedName()
-                                       + " has no formatting rules! Writing out non formatted value!");
+                    if (LOGGER.isWarnEnabled()) {
+                        LOGGER.warn(field.getQualifiedName()
+                                    + " has no formatting rules! Writing out non formatted value!");
                     }
                 }
             } else {

diff --git a/src/main/java/com/datalogics/pdf/samples/manipulation/ConvertPdfDocument.java b/src/main/java/com/datalogics/pdf/samples/manipulation/ConvertPdfDocument.java
@@ -27,9 +27,12 @@
 import com.datalogics.pdf.samples.util.DocumentUtils;
 import com.datalogics.pdf.samples.util.IoUtils;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import java.io.IOException;
+import java.lang.invoke.MethodHandles;
 import java.net.URL;
-import java.util.logging.Logger;
 
 
 /**
@@ -44,7 +47,7 @@
  */
 
 public final class ConvertPdfDocument {
-    private static final Logger LOGGER = Logger.getLogger(ConvertPdfDocument.class.getName());
+    private static final Logger LOGGER = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
     public static final String INPUT_UNCONVERTED_PDF_PATH = "UnConvertedPdf.pdf";
     public static final String OUTPUT_CONVERTED_PDF_PATH = "ConvertedPdfa-1b.pdf";

diff --git a/src/main/java/com/datalogics/pdf/samples/manipulation/ConvertToPdfA2.java b/src/main/java/com/datalogics/pdf/samples/manipulation/ConvertToPdfA2.java
@@ -29,15 +29,18 @@
 import com.datalogics.pdf.samples.util.DocumentUtils;
 import com.datalogics.pdf.samples.util.IoUtils;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import java.io.IOException;
+import java.lang.invoke.MethodHandles;
 import java.net.URL;
-import java.util.logging.Logger;
 
 /**
  * This sample demonstrates how to convert a PDF to a PDF/A-2 archive file. (PDF/A-2b by default)
  */
 public final class ConvertToPdfA2 {
-    private static final Logger LOGGER = Logger.getLogger(ConvertToPdfA2.class.getName());
+    private static final Logger LOGGER = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
     public static final String INPUT_PDF_PATH = "UnconvertedPdfA2.pdf";
     public static final String OUTPUT_PDF_PATH = "ConvertedToPdfA2.pdf";

diff --git a/src/main/java/com/datalogics/pdf/samples/manipulation/RedactAndSanitizeDocument.java b/src/main/java/com/datalogics/pdf/samples/manipulation/RedactAndSanitizeDocument.java
@@ -45,11 +45,14 @@
 import com.datalogics.pdf.samples.util.DocumentUtils;
 import com.datalogics.pdf.samples.util.IoUtils;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import java.io.IOException;
+import java.lang.invoke.MethodHandles;
 import java.net.URL;
 import java.util.EnumSet;
 import java.util.Locale;
-import java.util.logging.Logger;
 
 /**
  * This sample demonstrates how to open a document, add redaction annotations to it, and then apply the redaction. The
@@ -95,7 +98,7 @@
  * </ul>
  */
 public final class RedactAndSanitizeDocument {
-    private static final Logger LOGGER = Logger.getLogger(RedactAndSanitizeDocument.class.getName());
+    private static final Logger LOGGER = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
     public static final String SEARCH_PDF_STRING = "Reader";
     public static final String INPUT_PDF_PATH = "pdfjavatoolkit-ds.pdf";
@@ -314,7 +317,7 @@ public static void sanitizeDocument(final PDFDocument document, final URL saniti
                     PDFConfigurationException, PDFInvalidParameterException, PDFUnableToCompleteOperationException {
 
         if (!canSanitizeDocument(document)) {
-            LOGGER.warning("The document was not sanitized");
+            LOGGER.warn("The document was not sanitized");
             return;
         }
         ByteWriter writer = null;