Merge pull request #565 from fugerit-org/562-chore-logging-review

562 chore logging review

Author: fugerit79

fj-doc-lib-autodoc/src/main/java/org/fugerit/java/doc/lib/autodoc/facade/AutodocModelToSinpleTableFacade.java

@@ -138,12 +138,12 @@ private void handleComplexType( final StringBuilder builder, XsdComplexType comp
 		try {
 			this.handleSequence(builder, complexType.getChildAsSequence());
 		} catch (NullPointerException npe) {
-			log.warn( "npe 1 "+npe+" -> "+complexType.getRawName() );
+			log.warn( "npe 1 {} -> {}", npe, complexType.getRawName() );
 		}
 		try {
 			this.handleChoice(builder, complexType.getChildAsChoice());
 		} catch (NullPointerException npe) {
-			log.warn( "npe 2 "+npe+" -> "+complexType.getRawName() );
+            log.warn( "npe 2 {} -> {}", npe, complexType.getRawName() );
 		}
 	}
 

fj-doc-val-core/src/main/java/org/fugerit/java/doc/val/core/basic/AbstractDocTypeValidator.java

@@ -16,11 +16,15 @@
 
 import lombok.Getter;
 import lombok.extern.slf4j.Slf4j;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 @Slf4j
 public abstract class AbstractDocTypeValidator implements DocTypeValidator {
 
-	@Override
+    private static final Logger logger = LoggerFactory.getLogger( AbstractDocTypeValidator.class );
+
+    @Override
 	public String toString() {
 		return this.getClass().getSimpleName()+"[mimeType=" + mimeType + ", supportedExtensions=" + supportedExtensions + "]";
 	}
@@ -74,4 +78,9 @@ public boolean checkCompatibility() {
 		return Boolean.TRUE;
 	}
 
+    protected void logFailedCheck( String type, Exception e ) {
+        String message = e.toString();
+        logger.warn( "Failed check on {} : {}", type, message );
+    }
+
 }

fj-doc-val-core/src/test/java/test/org/fugerit/java/doc/core/val/TestAbstractDocTypeValidator.java

@@ -0,0 +1,27 @@
+package test.org.fugerit.java.doc.core.val;
+
+import org.fugerit.java.core.cfg.ConfigRuntimeException;
+import org.fugerit.java.doc.val.core.DocTypeValidationResult;
+import org.fugerit.java.doc.val.core.DocTypeValidator;
+import org.fugerit.java.doc.val.core.basic.AbstractDocTypeValidator;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+class TestAbstractDocTypeValidator {
+
+    @Test
+    void testValidate() throws IOException {
+        DocTypeValidator validator = new AbstractDocTypeValidator( "a", "b" ) {
+            @Override
+            public DocTypeValidationResult validate(InputStream is) {
+                this.logFailedCheck( this.getMimeType(), new ConfigRuntimeException( "scenario exception" ) );
+                return null;
+            }
+        };
+        Assertions.assertNull( validator.validate( (InputStream) null ) );
+    }
+
+}

fj-doc-val-poi/src/main/java/org/fugerit/java/doc/val/poi/DocValidator.java

@@ -6,13 +6,9 @@
 import org.fugerit.java.doc.val.core.DocTypeValidationResult;
 import org.fugerit.java.doc.val.core.DocTypeValidator;
 import org.fugerit.java.doc.val.core.basic.AbstractDocTypeValidator;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 public class DocValidator extends AbstractDocTypeValidator {
 
-	private static final Logger logger = LoggerFactory.getLogger( DocValidator.class );
-	
 	public static final String EXTENSION = "DOC";
 
 	public static final String MIME_TYPE = "application/msword";
@@ -29,7 +25,7 @@ public DocTypeValidationResult validate(InputStream is) {
 		try ( HWPFDocument workbook = new HWPFDocument( is ) ) {
 			result = DocTypeValidationResult.newOk();
 		} catch (Exception e) {
-			logger.warn( "Failed check on pdf : {}", e.toString() );
+			this.logFailedCheck( EXTENSION, e );
 			result.withMainException( e );
 		}
 		return result;

fj-doc-val-poi/src/main/java/org/fugerit/java/doc/val/poi/DocxValidator.java

@@ -6,13 +6,9 @@
 import org.fugerit.java.doc.val.core.DocTypeValidationResult;
 import org.fugerit.java.doc.val.core.DocTypeValidator;
 import org.fugerit.java.doc.val.core.basic.AbstractDocTypeValidator;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 public class DocxValidator extends AbstractDocTypeValidator {
 
-	private static final Logger logger = LoggerFactory.getLogger(DocxValidator.class);
-
 	public static final String EXTENSION = "DOCX";
 
 	public static final String MIME_TYPE = "application/vnd.openxmlformats-officedocument.wordprocessingml.document";
@@ -29,7 +25,7 @@ public DocTypeValidationResult validate(InputStream is) {
 		try (XWPFDocument workbook = new XWPFDocument(is)) {
 			result = DocTypeValidationResult.newOk();
 		} catch (Exception e) {
-			logger.warn("Failed check on pdf : {}", e.toString());
+            this.logFailedCheck( EXTENSION, e );
 			result.withMainException( e );
 		}
 		return result;

fj-doc-val-poi/src/main/java/org/fugerit/java/doc/val/poi/XlsValidator.java

@@ -6,13 +6,9 @@
 import org.fugerit.java.doc.val.core.DocTypeValidationResult;
 import org.fugerit.java.doc.val.core.DocTypeValidator;
 import org.fugerit.java.doc.val.core.basic.AbstractDocTypeValidator;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 public class XlsValidator extends AbstractDocTypeValidator {
 
-	private static final Logger logger = LoggerFactory.getLogger( XlsValidator.class );
-	
 	public static final String EXTENSION = "XLS";
 
 	public static final String MIME_TYPE = "application/vnd.ms-excel";
@@ -29,7 +25,7 @@ public DocTypeValidationResult validate(InputStream is) {
 		try ( HSSFWorkbook workbook = new HSSFWorkbook( is ) ) {
 			result = DocTypeValidationResult.newOk();
 		} catch (Exception e) {
-			logger.warn( "Failed check on pdf : {}", e.toString() );
+            this.logFailedCheck( EXTENSION, e );
 			result.withMainException( e );
 		}
 		return result;

fj-doc-val-poi/src/main/java/org/fugerit/java/doc/val/poi/XlsxValidator.java

@@ -6,13 +6,9 @@
 import org.fugerit.java.doc.val.core.DocTypeValidationResult;
 import org.fugerit.java.doc.val.core.DocTypeValidator;
 import org.fugerit.java.doc.val.core.basic.AbstractDocTypeValidator;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 public class XlsxValidator extends AbstractDocTypeValidator {
 
-	private static final Logger logger = LoggerFactory.getLogger( XlsxValidator.class );
-	
 	public static final String EXTENSION = "XLSX";
 
 	public static final String MIME_TYPE = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
@@ -29,7 +25,7 @@ public DocTypeValidationResult validate(InputStream is) {
 		try ( XSSFWorkbook workbook = new XSSFWorkbook( is ) ) {
 			result = DocTypeValidationResult.newOk();
 		} catch (Exception e) {
-			logger.warn( "Failed check on pdf : {}", e.toString() );
+            this.logFailedCheck( EXTENSION, e );
 			result.withMainException( e );
 		}
 		return result;