Merge pull request #219 from Engineering-Research-and-Development/feature/logging_improvement

Feature/logging improvement

Author: IgorBalog-Eng

src/main/java/it/eng/idsa/businesslogic/configuration/CertificationCheck.java

@@ -16,7 +16,7 @@ public class CertificationCheck {
 
 	private static final Logger logger = LoggerFactory.getLogger(CertificationCheck.class);
 
-	private static final String[] CERTIFIED_VERSION = { "1.14.1" };
+	private static final String[] CERTIFIED_VERSION = { "1.14.2" };
 	@PostConstruct
 	public void checkIfVerionsIsCertified() {
 		String version = Objects.requireNonNullElse(Application.class.getPackage().getImplementationVersion(), "");

src/main/java/it/eng/idsa/businesslogic/processor/common/GetTokenFromDapsProcessor.java

@@ -64,7 +64,6 @@ public void process(Exchange exchange) throws Exception {
 		String token = null;
 		try {
 			token = dapsTokenProviderService.provideToken();
-			logger.debug("DAT token: {}", token);
 		} catch (Exception e) {
 			logger.error("Can not get the token from the DAPS server ", e);
 			publisher.publishEvent(new TrueConnectorEvent(TrueConnectorEventType.CONNECTOR_TOKEN_FETCH_FAILURE, multipartMessage, correlationId));
@@ -84,7 +83,6 @@ public void process(Exchange exchange) throws Exception {
 		}
 
 		String messageStringWithToken = multipartMessageService.addToken(message, token);
-		logger.debug("messageStringWithToken=\n" + messageStringWithToken);
 
 		multipartMessage = new MultipartMessageBuilder()
 				.withHttpHeader(multipartMessage.getHttpHeaders())

src/main/java/it/eng/idsa/businesslogic/processor/common/ValidateTokenProcessor.java

@@ -58,7 +58,6 @@ public void process(Exchange exchange) throws Exception {
             return;
 		}
 		String token = multipartMessage.getHeaderContent().getSecurityToken().getTokenValue();
-		logger.info("token: {}", token);
 
 		// Check is "token" valid
 		boolean isTokenValid = dapsService.validateToken(token);

src/main/java/it/eng/idsa/businesslogic/processor/receiver/ReceiverFileRecreatorProcessor.java

@@ -42,7 +42,7 @@ public void process(Exchange exchange) throws Exception {
 		Thread fileRecreatorBeanThread = new Thread(fileRecreatorBean, "FileRecreator_"+this.getClass().getSimpleName());
 		fileRecreatorBeanThread.start();
 		String recreatedMultipartMessage = webSocketServerConfiguration.recreatedMultipartMessageBeanWebSocket().remove();
-		logger.debug("Received message over WSS , {}", recreatedMultipartMessage);
+		logger.debug("Received message over WSS");
 
 		exchange.getMessage().setBody(recreatedMultipartMessage, String.class);
 	}
@@ -51,8 +51,7 @@ private void initializeServer(FileRecreatorBeanServer fileRecreatorBean) {
 		try {
 			fileRecreatorBean.setup();
 		} catch(Exception e) {
-			logger.info("... can not initilize the IdscpServer");
-			logger.error("Cannot initiallize server", e);
+			logger.error("Cannot initiallize IDSCP Server", e);
 			rejectionMessageService.sendRejectionMessage(null, RejectionReason.TEMPORARILY_NOT_AVAILABLE);
 		}
 	}

src/main/java/it/eng/idsa/businesslogic/processor/receiver/ReceiverSendDataToDataAppProcessor.java

@@ -22,6 +22,7 @@
 import it.eng.idsa.businesslogic.service.HttpHeaderService;
 import it.eng.idsa.businesslogic.service.RejectionMessageService;
 import it.eng.idsa.businesslogic.service.impl.SendDataToBusinessLogicServiceImpl;
+import it.eng.idsa.businesslogic.util.Helper;
 import it.eng.idsa.businesslogic.util.RouterType;
 import it.eng.idsa.businesslogic.util.TrueConnectorConstants;
 import it.eng.idsa.multipart.builder.MultipartMessageBuilder;
@@ -119,24 +120,23 @@ public void process(Exchange exchange) throws Exception {
 	private void handleResponse(Exchange exchange, Message message, Response response, String openApiDataAppAddress)
 			throws UnsupportedOperationException, IOException {
 		String responseString = getResponseBodyAsString(response);
-		logger.info("data sent to destination: " + openApiDataAppAddress);
-		logger.info("response received from the DataAPP=" + responseString);
+		logger.info("data received from: {}", openApiDataAppAddress);
 
 		Map<String, Object> headers = httpHeaderService.okHttpHeadersToMap(response.headers());
 		String correlationId = (String) exchange.getMessage().getHeader(TrueConnectorConstants.CORRELATION_ID);
 		if(StringUtils.isNotBlank(correlationId)) {
 			headers.put(TrueConnectorConstants.CORRELATION_ID, correlationId);
 		}
 		exchange.getMessage().setHeaders(headers);
-		
+		MultipartMessage multipartMessage = null;
 		if (RouterType.HTTP_HEADER.equals(openDataAppReceiverRouter)) {
 			message = httpHeaderService.headersToMessage(headers);
 
 			Map<String, String> headerHeaderContentType = new HashMap<>();
 			headerHeaderContentType.put("Content-Type", "application/ld+json");
 			Map<String, String> payloadHeaderContentType = new HashMap<>();
 			payloadHeaderContentType.put("Content-Type", response.headers().get(MultipartMessageKey.CONTENT_TYPE.label));
-			MultipartMessage multipartMessage = new MultipartMessageBuilder()
+			multipartMessage = new MultipartMessageBuilder()
 					.withHeaderContent(message)
 					.withHeaderHeader(headerHeaderContentType)
 					.withPayloadContent(responseString)
@@ -145,9 +145,11 @@ private void handleResponse(Exchange exchange, Message message, Response respons
 			exchange.getMessage().setBody(multipartMessage);
 
 		} else {
-			MultipartMessage multipartMessage = MultipartMessageProcessor.parseMultipartMessage(responseString);
+			multipartMessage = MultipartMessageProcessor.parseMultipartMessage(responseString);
 			exchange.getMessage().setBody(multipartMessage);
 		}
+		
+		logger.info("Received message of type: {}", Helper.getIDSMessageType(multipartMessage.getHeaderContent()));
 	}
 
 	private String getResponseBodyAsString(Response response) {

src/main/java/it/eng/idsa/businesslogic/processor/receiver/ReceiverUsageControlProcessor.java

@@ -72,8 +72,6 @@ public void process(Exchange exchange) {
 			String payloadToEnforce = usageControlService.createUsageControlObject(artifactRequestMessage, artifactResponseMessage,
 			        multipartMessage.getPayloadContent());
 
-			logger.debug("Message Body: " + payloadToEnforce);
-			
 			MultipartMessage reponseMultipartMessage = new MultipartMessageBuilder()
 					.withHttpHeader(multipartMessage.getHttpHeaders())
 					.withHeaderHeader(multipartMessage.getHeaderHeader())

src/main/java/it/eng/idsa/businesslogic/processor/receiver/ReceiverVersionCheckProcessor.java

@@ -48,14 +48,12 @@ private boolean checkForVersionSupport(final String versionString,	final List<?
 			}
 		}
 
-		if (!versionSupported) {
-			if (logger.isWarnEnabled()) {
-				logger.warn("InfoModel version incompatibility detected! "
-						+ "To disable this warning, add the request's version to the inbound "
-						+ "version list in your property file. PLEASE NOTE that this is NO "
-						+ "guarantee that this log message will not be followed by exceptions, "
-						+ "e.g. due to deserialization errors.");
-			}
+		if (!versionSupported && logger.isWarnEnabled()) {
+			logger.warn("InfoModel version incompatibility detected! "
+					+ "To disable this warning, add the request's version to the inbound "
+					+ "version list in your property file. PLEASE NOTE that this is NO "
+					+ "guarantee that this log message will not be followed by exceptions, "
+					+ "e.g. due to deserialization errors.");
 		}
 		return versionSupported;
 	}

src/main/java/it/eng/idsa/businesslogic/processor/receiver/ReceiverWebSocketSendDataToDataAppProcessor.java

@@ -18,6 +18,7 @@
 import it.eng.idsa.businesslogic.configuration.ApplicationConfiguration;
 import it.eng.idsa.businesslogic.processor.sender.websocket.client.MessageWebSocketOverHttpSender;
 import it.eng.idsa.businesslogic.service.RejectionMessageService;
+import it.eng.idsa.businesslogic.util.Helper;
 import it.eng.idsa.businesslogic.util.MessagePart;
 import it.eng.idsa.multipart.domain.MultipartMessage;
 import it.eng.idsa.multipart.processor.MultipartMessageProcessor;
@@ -71,12 +72,10 @@ private void handleResponse(Exchange exchange, Message message, String response,
               logger.info("...communication error with: " + openApiDataAppAddress);
               rejectionMessageService.sendRejectionMessage((Message) exchange.getProperty("Original-Message-Header"), RejectionReason.INTERNAL_RECIPIENT_ERROR);
           } else {
-        	  logger.info("Received response from DataAPP");
-        	  logger.debug("response received from the DataAPP=" + response);
 			  MultipartMessage multipartMessage = MultipartMessageProcessor.parseMultipartMessage(response);
               exchange.getMessage().setHeader(MessagePart.HEADER, multipartMessage.getHeaderContentString());
               //Save original Header for Usage Control Enforcement
-              
+              logger.info("Received response from DataAPP, message type: {}", Helper.getIDSMessageType(multipartMessage.getHeaderContent()));
               if (multipartMessage.getPayloadContent() != null) {
                   exchange.getMessage().setHeader(MessagePart.PAYLOAD, multipartMessage.getPayloadContent());
               }

src/main/java/it/eng/idsa/businesslogic/processor/receiver/websocket/server/FileRecreatorBeanServer.java

@@ -41,7 +41,7 @@ public void setup() throws Exception {
 			HttpWebSocketServerBean httpWebSocketServerBean = webSocketServerConfiguration.httpsServerWebSocket();
 			httpWebSocketServerBean.createServer();
 		} catch (Exception e) {
-			e.printStackTrace();
+			logger.error("Could not start file recreator server: {}", e.getMessage());
 			throw e;
 		}
 	}
@@ -88,12 +88,9 @@ private String recreateMultipartMessageFromReceivedFrames() {
 			multipartMessage = recreateMultipartMessage(this.fileByteArray);
 			// once bytes are consumed to get message - empty array
 			fileByteArray = new ArrayList<>();
-			logger.info(
-					"Recreated the Multipart message from the received frames: lenght=" + multipartMessage.length());
+			logger.info("Recreated the Multipart message from the received frames: lenght= {}", multipartMessage.length());
 		} catch (IOException e) {
-			// TODO Auto-generated catch block
-			e.printStackTrace();
-			System.out.println("Error on the process of recreation the file from the received frames.");
+			logger.error("Coud not recreate the file from the received frames: {}", e.getMessage());
 		}
 		return multipartMessage;
 	}

src/main/java/it/eng/idsa/businesslogic/processor/receiver/websocket/server/FrameBufferBean.java

@@ -1,12 +1,17 @@
 package it.eng.idsa.businesslogic.processor.receiver.websocket.server;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 /**
  * 
  * @author Milan Karajovic and Gabriele De Luca
  *
  */
 
 public class FrameBufferBean {
+	private static final Logger logger = LoggerFactory.getLogger(FrameBufferBean.class);
+
 	private byte[] frame = null;
 	private boolean frameIsReceived = false;
 
@@ -15,7 +20,7 @@ public synchronized void add(byte[] msg) {
 			try {
 				wait();
 			} catch(InterruptedException e) {
-				e.printStackTrace();
+				logger.error("Adding frame to buffer interupted: {}", e.getMessage());
 			}
 		}
 
@@ -29,7 +34,7 @@ public synchronized byte[] remove() {
 			try {
 				wait();
 			} catch(InterruptedException e) {
-				e.printStackTrace();
+				logger.error("Removing frame from buffer interupted: {}", e.getMessage());
 			}
 		}