Merge pull request #149 from com-pas/replace-slf4j-with-log4j2

Replace SLF4J with Log4j2

Author: Dennis Labordus

app/pom.xml

@@ -61,6 +61,10 @@ SPDX-License-Identifier: Apache-2.0
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-websockets</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-hibernate-validator</artifactId>
+        </dependency>
 
         <dependency>
             <groupId>io.quarkus</groupId>
@@ -76,9 +80,10 @@ SPDX-License-Identifier: Apache-2.0
         </dependency>
 
         <dependency>
-            <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-hibernate-validator</artifactId>
+            <groupId>org.jboss.logmanager</groupId>
+            <artifactId>log4j2-jboss-logmanager</artifactId>
         </dependency>
+
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-container-image-docker</artifactId>
@@ -133,11 +138,6 @@ SPDX-License-Identifier: Apache-2.0
             <artifactId>openpojo</artifactId>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>org.slf4j</groupId>
-            <artifactId>slf4j-simple</artifactId>
-            <scope>test</scope>
-        </dependency>
     </dependencies>
 
     <build>

app/src/main/java/org/lfenergy/compas/scl/validator/rest/v1/NsdocResource.java

@@ -5,6 +5,8 @@
 
 import io.quarkus.security.Authenticated;
 import io.smallrye.mutiny.Uni;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.lfenergy.compas.scl.validator.rest.v1.model.NsdocListResponse;
 import org.lfenergy.compas.scl.validator.rest.v1.model.NsdocResponse;
 import org.lfenergy.compas.scl.validator.service.NsdocService;
@@ -20,6 +22,8 @@
 @RequestScoped
 @Path("/nsdoc/v1")
 public class NsdocResource {
+    private static final Logger LOGGER = LogManager.getLogger(NsdocResource.class);
+
     private final NsdocService nsdocService;
 
     public NsdocResource(NsdocService nsdocService) {
@@ -30,6 +34,7 @@ public NsdocResource(NsdocService nsdocService) {
     @Consumes(MediaType.APPLICATION_XML)
     @Produces(MediaType.APPLICATION_XML)
     public Uni<NsdocListResponse> list() {
+        LOGGER.info("Retrieving list of NSDoc Files");
         var response = new NsdocListResponse();
         response.setNsdocFiles(nsdocService.list());
         return Uni.createFrom().item(response);
@@ -40,6 +45,7 @@ public Uni<NsdocListResponse> list() {
     @Consumes(MediaType.APPLICATION_XML)
     @Produces(MediaType.APPLICATION_XML)
     public Uni<NsdocResponse> get(@PathParam(ID_PARAM) UUID id) {
+        LOGGER.info("Retrieving NS Doc File '{}'", id);
         var response = new NsdocResponse();
         response.setNsdocFile(nsdocService.get(id));
         return Uni.createFrom().item(response);

app/src/main/java/org/lfenergy/compas/scl/validator/rest/v1/SclValidatorResource.java

@@ -5,6 +5,8 @@
 
 import io.quarkus.security.Authenticated;
 import io.smallrye.mutiny.Uni;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.lfenergy.compas.scl.extensions.model.SclFileType;
 import org.lfenergy.compas.scl.validator.rest.v1.model.SclValidateRequest;
 import org.lfenergy.compas.scl.validator.rest.v1.model.SclValidateResponse;
@@ -22,6 +24,8 @@
 @RequestScoped
 @Path("/validate/v1/{" + TYPE_PATH_PARAM + "}")
 public class SclValidatorResource {
+    private static final Logger LOGGER = LogManager.getLogger(SclValidatorResource.class);
+
     private final SclValidatorService sclValidatorService;
 
     @Inject
@@ -34,6 +38,7 @@ public SclValidatorResource(SclValidatorService sclValidatorService) {
     @Produces(MediaType.APPLICATION_XML)
     public Uni<SclValidateResponse> validateSCL(@PathParam(TYPE_PATH_PARAM) SclFileType type,
                                                 @Valid SclValidateRequest request) {
+        LOGGER.info("Validating SCL File for type {}.", type);
         var response = new SclValidateResponse();
         response.setValidationErrorList(sclValidatorService.validate(type, request.getSclData()));
         return Uni.createFrom().item(response);

app/src/main/java/org/lfenergy/compas/scl/validator/rest/v1/SclValidatorServerEndpoint.java

@@ -5,6 +5,8 @@
 
 import io.quarkus.security.Authenticated;
 import io.vertx.mutiny.core.eventbus.EventBus;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.lfenergy.compas.core.websocket.ErrorResponseEncoder;
 import org.lfenergy.compas.scl.extensions.model.SclFileType;
 import org.lfenergy.compas.scl.validator.rest.v1.event.SclValidatorEventRequest;
@@ -13,8 +15,6 @@
 import org.lfenergy.compas.scl.validator.rest.v1.websocket.SclValidateRequestEncoder;
 import org.lfenergy.compas.scl.validator.rest.v1.websocket.SclValidateResponseDecoder;
 import org.lfenergy.compas.scl.validator.rest.v1.websocket.SclValidateResponseEncoder;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 import javax.enterprise.context.ApplicationScoped;
 import javax.inject.Inject;
@@ -31,7 +31,7 @@
         decoders = {SclValidateRequestDecoder.class, SclValidateResponseDecoder.class},
         encoders = {SclValidateRequestEncoder.class, SclValidateResponseEncoder.class, ErrorResponseEncoder.class})
 public class SclValidatorServerEndpoint {
-    private static final Logger LOGGER = LoggerFactory.getLogger(SclValidatorServerEndpoint.class);
+    private static final Logger LOGGER = LogManager.getLogger(SclValidatorServerEndpoint.class);
 
     private final EventBus eventBus;
 

pom.xml

@@ -24,10 +24,10 @@ SPDX-License-Identifier: Apache-2.0
         <sonarqube-plugin.version>3.2.0</sonarqube-plugin.version>
 
         <compas.scl.xsd.version>0.0.4</compas.scl.xsd.version>
-        <compas.core.version>0.10.2</compas.core.version>
+        <compas.core.version>0.11.0</compas.core.version>
 
         <quarkus.platform.version>2.14.1.Final</quarkus.platform.version>
-        <slf4j.version>2.0.4</slf4j.version>
+        <log4j2.version>2.19.0</log4j2.version>
         <openpojo.version>0.9.1</openpojo.version>
     </properties>
 
@@ -133,14 +133,14 @@ SPDX-License-Identifier: Apache-2.0
             </dependency>
 
             <dependency>
-                <groupId>org.slf4j</groupId>
-                <artifactId>slf4j-api</artifactId>
-                <version>${slf4j.version}</version>
+                <groupId>org.apache.logging.log4j</groupId>
+                <artifactId>log4j-api</artifactId>
+                <version>${log4j2.version}</version>
             </dependency>
             <dependency>
-                <groupId>org.slf4j</groupId>
-                <artifactId>slf4j-simple</artifactId>
-                <version>${slf4j.version}</version>
+                <groupId>org.apache.logging.log4j</groupId>
+                <artifactId>log4j-core</artifactId>
+                <version>${log4j2.version}</version>
             </dependency>
 
             <dependency>

riseclipse/validator-riseclipse/pom.xml

@@ -67,15 +67,21 @@ SPDX-License-Identifier: Apache-2.0
             <groupId>org.antlr.runtime</groupId>
             <artifactId>org.antlr.runtime</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.apache.log4j</groupId>
-            <artifactId>org.apache.log4j</artifactId>
-        </dependency>
         <dependency>
             <groupId>javax.inject</groupId>
             <artifactId>javax.inject</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-core</artifactId>
+            <scope>provided</scope>
+        </dependency>
+
         <!-- Test Dependencies -->
         <dependency>
             <groupId>org.lfenergy.compas.scl.validator</groupId>
@@ -94,11 +100,6 @@ SPDX-License-Identifier: Apache-2.0
             <artifactId>junit-jupiter-engine</artifactId>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>org.slf4j</groupId>
-            <artifactId>slf4j-simple</artifactId>
-            <scope>test</scope>
-        </dependency>
     </dependencies>
 
     <build>

riseclipse/validator-riseclipse/src/main/java/org/lfenergy/compas/scl/validator/collector/AbstractFileCollector.java

@@ -3,10 +3,10 @@
 // SPDX-License-Identifier: Apache-2.0
 package org.lfenergy.compas.scl.validator.collector;
 
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.eclipse.emf.common.util.URI;
 import org.lfenergy.compas.scl.validator.exception.SclValidatorException;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 import java.io.File;
 import java.io.IOException;
@@ -23,7 +23,7 @@
  * Abstract class to support retrieving default files from the ClassPath or from a Directory.
  */
 public abstract class AbstractFileCollector implements OclFileCollector {
-    private static final Logger LOGGER = LoggerFactory.getLogger(AbstractFileCollector.class);
+    private static final Logger LOGGER = LogManager.getLogger(AbstractFileCollector.class);
 
     private static final String DEFAULT_OCL_DIRECTORY = "/ocl/";
 

riseclipse/validator-riseclipse/src/main/java/org/lfenergy/compas/scl/validator/collector/CompasOclFileCollector.java

@@ -3,9 +3,9 @@
 // SPDX-License-Identifier: Apache-2.0
 package org.lfenergy.compas.scl.validator.collector;
 
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.eclipse.emf.common.util.URI;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -15,7 +15,7 @@
  * directory configured.
  */
 public class CompasOclFileCollector extends AbstractFileCollector {
-    private static final Logger LOGGER = LoggerFactory.getLogger(CompasOclFileCollector.class);
+    private static final Logger LOGGER = LogManager.getLogger(CompasOclFileCollector.class);
 
     private final String oclCustomDirectory;
 

riseclipse/validator-riseclipse/src/main/java/org/lfenergy/compas/scl/validator/util/MessageUtil.java renamed to riseclipse/validator-riseclipse/src/main/java/org/lfenergy/compas/scl/validator/impl/MessageUtil.java

@@ -1,16 +1,16 @@
 // SPDX-FileCopyrightText: 2022 Alliander N.V.
 //
 // SPDX-License-Identifier: Apache-2.0
-package org.lfenergy.compas.scl.validator.util;
+package org.lfenergy.compas.scl.validator.impl;
 
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.lfenergy.compas.scl.validator.model.ValidationError;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 import java.util.Optional;
 
 public class MessageUtil {
-    private static final Logger LOGGER = LoggerFactory.getLogger(MessageUtil.class);
+    private static final Logger LOGGER = LogManager.getLogger(MessageUtil.class);
 
     MessageUtil() {
         throw new UnsupportedOperationException("MessageUtil class");

riseclipse/validator-riseclipse/src/main/java/org/lfenergy/compas/scl/validator/impl/OclFileLoader.java

@@ -4,6 +4,8 @@
 package org.lfenergy.compas.scl.validator.impl;
 
 import fr.centralesupelec.edf.riseclipse.iec61850.scl.SclPackage;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.eclipse.emf.common.util.URI;
 import org.eclipse.emf.ecore.impl.EPackageRegistryImpl;
 import org.eclipse.emf.ecore.resource.Resource.Diagnostic;
@@ -12,8 +14,6 @@
 import org.eclipse.ocl.pivot.validation.ComposedEValidator;
 import org.eclipse.ocl.xtext.completeocl.validation.CompleteOCLEObjectValidator;
 import org.lfenergy.compas.scl.validator.exception.SclValidatorException;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 import java.io.BufferedWriter;
 import java.io.IOException;
@@ -25,7 +25,7 @@
 import static org.lfenergy.compas.scl.validator.exception.SclValidatorErrorCode.*;
 
 public class OclFileLoader {
-    private static final Logger LOGGER = LoggerFactory.getLogger(OclFileLoader.class);
+    private static final Logger LOGGER = LogManager.getLogger(OclFileLoader.class);
 
     private final List<URI> oclFiles;
     private final Path oclTempFile;