X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=ecomp-portal-BE-common%2Fsrc%2Fmain%2Fjava%2Forg%2Fonap%2Fportalapp%2Fportal%2Flogging%2Faop%2FEPEELFLoggerAdvice.java;fp=ecomp-portal-BE-common%2Fsrc%2Fmain%2Fjava%2Forg%2Fonap%2Fportalapp%2Fportal%2Flogging%2Faop%2FEPEELFLoggerAdvice.java;h=11fb2fb546b59ed175bc10ca3efc1605aa718a4b;hb=21a8761f684745bb300e075c7e98ad897ace9eed;hp=0000000000000000000000000000000000000000;hpb=3af8af1310d5a27cb58be29505573f0bbdc1717c;p=portal.git

diff --git a/ecomp-portal-BE-common/src/main/java/org/onap/portalapp/portal/logging/aop/EPEELFLoggerAdvice.java b/ecomp-portal-BE-common/src/main/java/org/onap/portalapp/portal/logging/aop/EPEELFLoggerAdvice.java
new file mode 100644
index 00000000..11fb2fb5
--- /dev/null
+++ b/ecomp-portal-BE-common/src/main/java/org/onap/portalapp/portal/logging/aop/EPEELFLoggerAdvice.java
@@ -0,0 +1,400 @@
+/*-
+ * ============LICENSE_START==========================================
+ * ONAP Portal
+ * ===================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+ * ===================================================================
+ *
+ * Unless otherwise specified, all software contained herein is licensed
+ * under the Apache License, Version 2.0 (the "License");
+ * you may not use this software except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *             http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Unless otherwise specified, all documentation contained herein is licensed
+ * under the Creative Commons License, Attribution 4.0 Intl. (the "License");
+ * you may not use this documentation except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *             https://creativecommons.org/licenses/by/4.0/
+ *
+ * Unless required by applicable law or agreed to in writing, documentation
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * ============LICENSE_END============================================
+ *
+ * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ */
+package org.onap.portalapp.portal.logging.aop;
+
+import java.net.InetAddress;
+import java.text.SimpleDateFormat;
+import java.util.Date;
+import java.util.UUID;
+
+import javax.servlet.http.HttpServletRequest;
+
+import org.onap.portalapp.portal.domain.EPUser;
+import org.onap.portalapp.portal.utils.EPCommonSystemProperties;
+import org.onap.portalapp.util.EPUserUtils;
+import org.onap.portalsdk.core.exception.SessionExpiredException;
+import org.onap.portalsdk.core.logging.format.AlarmSeverityEnum;
+import org.onap.portalsdk.core.logging.format.AuditLogFormatter;
+import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
+import org.onap.portalsdk.core.util.SystemProperties;
+import org.onap.portalsdk.core.util.SystemProperties.SecurityEventTypeEnum;
+import org.onap.portalsdk.core.web.support.UserUtils;
+import org.slf4j.MDC;
+
+import com.att.eelf.configuration.Configuration;
+
+@org.springframework.context.annotation.Configuration
+public class EPEELFLoggerAdvice {
+
+	private EELFLoggerDelegate adviceLogger = EELFLoggerDelegate.getLogger(EPEELFLoggerAdvice.class);
+
+	/**
+	 * DateTime Format according to the ECOMP Application Logging Guidelines.
+	 */
+
+	/**
+	 * @return Current date and time in the format specified by the ECOMP
+	 *         Application Logging Guidelines.
+	 */
+	public static String getCurrentDateTimeUTC() {
+		SimpleDateFormat ecompLogDateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSXXX");
+		String currentDateTime = ecompLogDateFormat.format(new Date());
+		return currentDateTime;
+	}
+
+	/**
+	 * Sets logging context with values from HttpServletRequest object.
+	 * 
+	 * @param req
+	 *            HttpServletRequest
+	 * @param securityEventType
+	 *            SecurityEventTypeEnum
+	 */
+	public void loadServletRequestBasedDefaults(HttpServletRequest req, SecurityEventTypeEnum securityEventType) {
+		try {
+			setHttpRequestBasedDefaultsIntoGlobalLoggingContext(req, securityEventType, req.getServletPath());
+		} catch (Exception e) {
+			adviceLogger.error(EELFLoggerDelegate.errorLogger, "loadServletRequestBasedDefaults failed", e);
+		}
+	}
+
+	/**
+	 * 
+	 * @param securityEventType
+	 * @param args
+	 * @param passOnArgs
+	 * @return Object array
+	 */
+	public Object[] before(SecurityEventTypeEnum securityEventType, Object[] args, Object[] passOnArgs) {
+		String className = "";
+		if (passOnArgs.length > 0 && passOnArgs[0] != null)
+			className = passOnArgs[0].toString();
+		String methodName = "";
+		if (passOnArgs.length > 1 && passOnArgs[1] != null)
+			methodName = passOnArgs[1].toString();
+
+		// Initialize Request defaults only for controller methods.
+		MDC.put(className + methodName + EPCommonSystemProperties.METRICSLOG_BEGIN_TIMESTAMP, getCurrentDateTimeUTC());
+		MDC.put(EPCommonSystemProperties.TARGET_ENTITY, EPCommonSystemProperties.ECOMP_PORTAL_BE);
+		MDC.put(EPCommonSystemProperties.TARGET_SERVICE_NAME, methodName);
+		if (MDC.get(Configuration.MDC_KEY_REQUEST_ID) == null){
+			String requestId = UUID.randomUUID().toString();
+			MDC.put(Configuration.MDC_KEY_REQUEST_ID, requestId);
+		}
+		MDC.put(EPCommonSystemProperties.PARTNER_NAME, "Unknown");
+		MDC.put(Configuration.MDC_SERVICE_NAME, EPCommonSystemProperties.ECOMP_PORTAL_BE);
+
+		if (securityEventType != null) {
+			MDC.put(className + methodName + EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP,
+					getCurrentDateTimeUTC());
+			HttpServletRequest req = null;
+			if (args.length > 0 && args[0] != null && args[0] instanceof HttpServletRequest) {
+				req = (HttpServletRequest) args[0];
+				this.setHttpRequestBasedDefaultsIntoGlobalLoggingContext(req, securityEventType, methodName);
+			}
+		}
+
+		EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(className);
+		logger.debug(EELFLoggerDelegate.debugLogger, "EPEELFLoggerAdvice#before: entering {}", methodName);
+		return new Object[] { "" };
+	}
+
+	/**
+	 * 
+	 * @param securityEventType
+	 * @param statusCode
+	 * @param responseCode
+	 * @param args
+	 * @param returnArgs
+	 * @param passOnArgs
+	 */
+	public void after(SecurityEventTypeEnum securityEventType, String statusCode, String responseCode, Object[] args,
+			Object[] returnArgs, Object[] passOnArgs) {
+		String className = "";
+		if (passOnArgs.length > 0 && passOnArgs[0] != null)
+			className = passOnArgs[0].toString();
+		// Method Name
+		String methodName = "";
+		if (passOnArgs.length > 1 && passOnArgs[1] != null)
+			methodName = passOnArgs[1].toString();
+
+		if (MDC.get(EPCommonSystemProperties.TARGET_SERVICE_NAME) == null
+				|| MDC.get(EPCommonSystemProperties.TARGET_SERVICE_NAME) == "")
+			MDC.put(EPCommonSystemProperties.TARGET_SERVICE_NAME, methodName);
+
+		if (MDC.get(EPCommonSystemProperties.TARGET_ENTITY) == null
+				|| MDC.get(EPCommonSystemProperties.TARGET_ENTITY) == "")
+			MDC.put(EPCommonSystemProperties.TARGET_ENTITY, EPCommonSystemProperties.ECOMP_PORTAL_BE);
+
+		MDC.put(EPCommonSystemProperties.METRICSLOG_BEGIN_TIMESTAMP,
+				MDC.get(className + methodName + EPCommonSystemProperties.METRICSLOG_BEGIN_TIMESTAMP));
+		MDC.put(EPCommonSystemProperties.METRICSLOG_END_TIMESTAMP, getCurrentDateTimeUTC());
+		this.calculateDateTimeDifference(MDC.get(EPCommonSystemProperties.METRICSLOG_BEGIN_TIMESTAMP),
+				MDC.get(EPCommonSystemProperties.METRICSLOG_END_TIMESTAMP));
+
+		// Making sure to reload the INCOMING request MDC defaults if they have
+		// been wiped out by either Outgoing or LDAP Phone book search
+		// operations.
+		if (securityEventType != null && args.length > 0 && args[0] != null && args[0] instanceof HttpServletRequest
+				&& securityEventType == SecurityEventTypeEnum.INCOMING_REST_MESSAGE
+				&& (MDC.get(EPCommonSystemProperties.FULL_URL) == null
+						|| MDC.get(EPCommonSystemProperties.FULL_URL) == "")) {
+			HttpServletRequest req = (HttpServletRequest) args[0];
+			this.setHttpRequestBasedDefaultsIntoGlobalLoggingContext(req, securityEventType, methodName);
+		}
+
+		// Use external API response code in case if it resulted in an error.
+		String externalAPIResponseCode = MDC.get(EPCommonSystemProperties.EXTERNAL_API_RESPONSE_CODE);
+		if (externalAPIResponseCode == null || externalAPIResponseCode == ""
+				|| externalAPIResponseCode.trim().equalsIgnoreCase("200")) {
+			MDC.put(EPCommonSystemProperties.RESPONSE_CODE, responseCode);
+			MDC.put(EPCommonSystemProperties.STATUS_CODE, statusCode);
+		} else {
+			MDC.put(EPCommonSystemProperties.RESPONSE_CODE, externalAPIResponseCode);
+			MDC.put(EPCommonSystemProperties.STATUS_CODE, "ERROR");
+		}
+
+		EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(className);
+		logger.debug(EELFLoggerDelegate.debugLogger, "EPEELFLoggerAdvice#after: finished {}", methodName);
+		// add the metrics log
+		logger.info(EELFLoggerDelegate.metricsLogger,  methodName + " operation is completed.");
+
+		// Log security message, if necessary
+		if (securityEventType != null) {
+			MDC.put(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP,
+					MDC.get(className + methodName + EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP));
+			MDC.put(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP, getCurrentDateTimeUTC());
+			this.calculateDateTimeDifference(MDC.get(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP),
+					MDC.get(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP));
+
+			this.logSecurityMessage(logger, securityEventType, methodName);
+
+			// Outgoing & LDAP messages are part of Incoming requests so,
+			// keep "RequestId", "PartnerName", "ServiceName", "LoginId" &
+			// "ResponseCode" etc. in memory and remove it only when
+			// finished processing the parent incoming message.
+			if (securityEventType != SecurityEventTypeEnum.OUTGOING_REST_MESSAGE
+					&& securityEventType != SecurityEventTypeEnum.LDAP_PHONEBOOK_USER_SEARCH) {
+				MDC.remove(Configuration.MDC_KEY_REQUEST_ID);
+				MDC.remove(EPCommonSystemProperties.PARTNER_NAME);
+				MDC.remove(Configuration.MDC_SERVICE_NAME);
+				MDC.remove(EPCommonSystemProperties.MDC_LOGIN_ID);
+				MDC.remove(EPCommonSystemProperties.EXTERNAL_API_RESPONSE_CODE);
+			}else{
+				MDC.remove(Configuration.MDC_KEY_REQUEST_ID);
+				MDC.remove(EPCommonSystemProperties.PARTNER_NAME);
+				MDC.remove(Configuration.MDC_SERVICE_NAME);
+			}
+
+			// clear when finishes audit logging
+			MDC.remove(EPCommonSystemProperties.FULL_URL);
+			MDC.remove(EPCommonSystemProperties.PROTOCOL);
+			MDC.remove(EPCommonSystemProperties.STATUS_CODE);
+			MDC.remove(className + methodName + EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP);
+			MDC.remove(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP);
+			MDC.remove(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP);
+			MDC.remove(EPCommonSystemProperties.RESPONSE_CODE);
+		}
+		MDC.remove(className + methodName + EPCommonSystemProperties.METRICSLOG_BEGIN_TIMESTAMP);
+		MDC.remove(EPCommonSystemProperties.METRICSLOG_BEGIN_TIMESTAMP);
+		MDC.remove(EPCommonSystemProperties.METRICSLOG_END_TIMESTAMP);
+		MDC.remove(EPCommonSystemProperties.MDC_TIMER);
+		MDC.remove(EPCommonSystemProperties.TARGET_ENTITY);
+		MDC.remove(EPCommonSystemProperties.TARGET_SERVICE_NAME);
+	
+	}
+
+	/**
+	 * 
+	 * @param logger
+	 * @param securityEventType
+	 * @param restMethod
+	 */
+	private void logSecurityMessage(EELFLoggerDelegate logger, SecurityEventTypeEnum securityEventType,
+			String restMethod) {
+		StringBuilder additionalInfoAppender = new StringBuilder();
+		String auditMessage = "";
+
+		if (securityEventType == SecurityEventTypeEnum.OUTGOING_REST_MESSAGE) {
+			additionalInfoAppender.append(String.format("%s '%s' request was initiated.", restMethod,
+					MDC.get(EPCommonSystemProperties.TARGET_SERVICE_NAME)));
+		} else if (securityEventType == SecurityEventTypeEnum.LDAP_PHONEBOOK_USER_SEARCH) {
+			additionalInfoAppender.append("LDAP Phonebook search operation is performed.");
+		} else {
+			additionalInfoAppender.append(String.format("%s request was received.", restMethod));
+
+			if (securityEventType == SecurityEventTypeEnum.FE_LOGIN_ATTEMPT) {
+				String loginId = "";
+				String additionalMessage = " Successfully authenticated.";
+				loginId = MDC.get(EPCommonSystemProperties.MDC_LOGIN_ID);
+				if (loginId == null || loginId == "" || loginId == EPCommonSystemProperties.UNKNOWN) {
+					additionalMessage = " No cookies are found.";
+				}
+				additionalInfoAppender.append(additionalMessage);
+			} else if (securityEventType == SecurityEventTypeEnum.FE_LOGOUT) {
+				additionalInfoAppender.append(" User has been successfully logged out.");
+			}
+		}
+
+		String fullURL = MDC.get(EPCommonSystemProperties.FULL_URL);
+		if (fullURL != null && fullURL != "") {
+			additionalInfoAppender.append(" Request-URL:" + MDC.get(EPCommonSystemProperties.FULL_URL));
+		}
+
+		auditMessage = AuditLogFormatter.getInstance().createMessage(MDC.get(EPCommonSystemProperties.PROTOCOL),
+				securityEventType.name(), MDC.get(EPCommonSystemProperties.MDC_LOGIN_ID),
+				additionalInfoAppender.toString());
+
+		logger.info(EELFLoggerDelegate.auditLogger, auditMessage);
+	}
+
+	/**
+	 * 
+	 * @param req
+	 * @param securityEventType
+	 * @param restMethod
+	 */
+	private void setHttpRequestBasedDefaultsIntoGlobalLoggingContext(HttpServletRequest req,
+			SecurityEventTypeEnum securityEventType, String restMethod) {
+		/**
+		 * No need to load the request based defaults for the following security
+		 * messages since either they are initiated by the Portal BE or not Http
+		 * request based.
+		 */
+		if (req != null) {
+			if (securityEventType != SecurityEventTypeEnum.OUTGOING_REST_MESSAGE
+					&& securityEventType != SecurityEventTypeEnum.LDAP_PHONEBOOK_USER_SEARCH
+					&& securityEventType != SecurityEventTypeEnum.INCOMING_UEB_MESSAGE) {
+				// Load the RequestID (aka TrasactionId) into MDC context.
+				String requestId = UserUtils.getRequestId(req);
+				if (requestId == null||requestId.trim().length()==0) {
+					requestId = UUID.randomUUID().toString();
+				}
+				MDC.put(Configuration.MDC_KEY_REQUEST_ID, requestId);
+
+				// Load user agent into MDC context, if available.
+				String accessingClient = "Unknown";
+				accessingClient = req.getHeader(SystemProperties.USERAGENT_NAME);
+				if (accessingClient != null && accessingClient.trim().length()==0 && (accessingClient.contains("Mozilla")
+						|| accessingClient.contains("Chrome") || accessingClient.contains("Safari"))) {
+					accessingClient = EPCommonSystemProperties.ECOMP_PORTAL_FE;
+				}
+				MDC.put(EPCommonSystemProperties.PARTNER_NAME, accessingClient);
+
+				// Load loginId into MDC context.
+				EPUser user = null;
+				try {
+					user = EPUserUtils.getUserSession(req);
+				} catch (SessionExpiredException se) {
+					adviceLogger.debug(EELFLoggerDelegate.debugLogger,
+							"setHttpRequestBasedDefaultsIntoGlobalLoggingContext: No user found in session");
+				}
+
+				MDC.put(EPCommonSystemProperties.MDC_LOGIN_ID, (user != null ? user.getOrgUserId() : "NoUser"));
+
+				// Rest URL & Protocol
+				String restURL = "";
+				MDC.put(EPCommonSystemProperties.FULL_URL, EPCommonSystemProperties.UNKNOWN);
+				MDC.put(EPCommonSystemProperties.PROTOCOL, EPCommonSystemProperties.HTTP);
+				restURL = UserUtils.getFullURL(req);
+				if (restURL != null && restURL != "") {
+					MDC.put(EPCommonSystemProperties.FULL_URL, restURL);
+					if (restURL.toLowerCase().contains("https")) {
+						MDC.put(EPCommonSystemProperties.PROTOCOL, EPCommonSystemProperties.HTTPS);
+					}
+				}
+
+				// Rest Path
+				MDC.put(Configuration.MDC_SERVICE_NAME, restMethod);
+				String restPath = req.getServletPath();
+				if (restPath != null && restPath != "") {
+					MDC.put(Configuration.MDC_SERVICE_NAME, restPath);
+				}
+
+				// Client IPAddress i.e. IPAddress of the remote host who is
+				// making this request.
+				String clientIPAddress = "";
+				clientIPAddress = req.getHeader("X-FORWARDED-FOR");
+				if (clientIPAddress == null) {
+					clientIPAddress = req.getRemoteAddr();
+				}
+				MDC.put(EPCommonSystemProperties.CLIENT_IP_ADDRESS, clientIPAddress);
+			} else if (securityEventType == SecurityEventTypeEnum.LDAP_PHONEBOOK_USER_SEARCH) {
+				MDC.put(EPCommonSystemProperties.TARGET_ENTITY, "Phonebook");
+				MDC.put(EPCommonSystemProperties.TARGET_SERVICE_NAME, "search");
+			}
+		} else {
+			MDC.put(Configuration.MDC_SERVICE_NAME, restMethod);
+			MDC.put(EPCommonSystemProperties.PARTNER_NAME, EPCommonSystemProperties.ECOMP_PORTAL_FE);
+		}
+
+		MDC.put(Configuration.MDC_SERVICE_INSTANCE_ID, "");
+		MDC.put(Configuration.MDC_ALERT_SEVERITY, AlarmSeverityEnum.INFORMATIONAL.severity());
+		try {
+			MDC.put(Configuration.MDC_SERVER_FQDN, InetAddress.getLocalHost().getCanonicalHostName());
+			MDC.put(Configuration.MDC_SERVER_IP_ADDRESS, InetAddress.getLocalHost().getHostAddress());
+			MDC.put(Configuration.MDC_INSTANCE_UUID, SystemProperties.getProperty(SystemProperties.INSTANCE_UUID));
+		} catch (Exception e) {
+			adviceLogger.error(EELFLoggerDelegate.errorLogger,
+					"setHttpRequestBasedDefaultsIntoGlobalLoggingContext failed", e);
+		}
+	}
+
+	/**
+	 * 
+	 * @param beginDateTime
+	 * @param endDateTime
+	 */
+	private void calculateDateTimeDifference(String beginDateTime, String endDateTime) {
+		if (beginDateTime != null && endDateTime != null && !beginDateTime.isEmpty()&&!endDateTime.isEmpty()) {
+			try {
+				SimpleDateFormat ecompLogDateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSXXX");
+				Date beginDate = ecompLogDateFormat.parse(beginDateTime);
+				Date endDate = ecompLogDateFormat.parse(endDateTime);
+				String timeDifference = String.format("%d", endDate.getTime() - beginDate.getTime());
+				MDC.put(SystemProperties.MDC_TIMER, timeDifference);
+			} catch (Exception e) {
+				adviceLogger.error(EELFLoggerDelegate.errorLogger, "calculateDateTimeDifference failed", e);
+			}
+		}
+	}
+
+	public String getInternalResponseCode() {
+		return MDC.get(EPCommonSystemProperties.RESPONSE_CODE);
+	}
+}