1 files changed, 222 insertions, 0 deletions
diff --git a/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/AbstractFilter.java b/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/AbstractFilter.java
new file mode 100644
index 0000000..13c88b0
--- /dev/null
+++ b/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/AbstractFilter.java
@@ -0,0 +1,222 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - Logging
+ * ================================================================================
+ * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.logging.filter.base;
+
+import java.net.InetAddress;
+import java.net.UnknownHostException;
+import java.time.ZoneOffset;
+import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
+import java.time.temporal.ChronoUnit;
+import java.util.UUID;
+import javax.servlet.http.HttpServletRequest;
+import javax.ws.rs.core.HttpHeaders;
+import javax.ws.rs.core.Response;
+import org.onap.logging.ref.slf4j.ONAPLogConstants;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.slf4j.MDC;
+
+public abstract class AbstractFilter {
+
+    protected static Logger logger = LoggerFactory.getLogger(AbstractFilter.class);
+
+    private static final String INSTANCE_UUID = UUID.randomUUID().toString();
+
+    protected void setInstanceID() {
+        MDC.put(ONAPLogConstants.MDCs.INSTANCE_UUID, INSTANCE_UUID);
+    }
+
+    protected void setServerFQDN() {
+        String serverFQDN = "";
+        InetAddress addr = null;
+        try {
+            addr = InetAddress.getLocalHost();
+            serverFQDN = addr.getCanonicalHostName();
+            MDC.put(ONAPLogConstants.MDCs.SERVER_IP_ADDRESS, addr.getHostAddress());
+        } catch (UnknownHostException e) {
+            logger.warn("Cannot Resolve Host Name");
+            serverFQDN = "";
+        }
+        MDC.put(ONAPLogConstants.MDCs.SERVER_FQDN, serverFQDN);
+    }
+
+    protected void setClientIPAddress(HttpServletRequest httpServletRequest) {
+        String clientIpAddress = "";
+        if (httpServletRequest != null) {
+            // This logic is to avoid setting the client ip address to that of the load
+            // balancer in front of the application
+            String getForwadedFor = httpServletRequest.getHeader("X-Forwarded-For");
+            if (getForwadedFor != null) {
+                clientIpAddress = getForwadedFor;
+            } else {
+                clientIpAddress = httpServletRequest.getRemoteAddr();
+            }
+        }
+        MDC.put(ONAPLogConstants.MDCs.CLIENT_IP_ADDRESS, clientIpAddress);
+    }
+
+    protected void setEntryTimeStamp() {
+        MDC.put(ONAPLogConstants.MDCs.ENTRY_TIMESTAMP,
+                ZonedDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ISO_INSTANT));
+    }
+
+    protected String getRequestId(SimpleMap headers) {
+        logger.trace("Checking X-ONAP-RequestID header for requestId.");
+        String requestId = headers.get(ONAPLogConstants.Headers.REQUEST_ID);
+        if (requestId != null && !requestId.isEmpty()) {
+            return requestId;
+        }
+
+        logger.trace("No valid X-ONAP-RequestID header value. Checking X-RequestID header for requestId.");
+        requestId = headers.get(Constants.HttpHeaders.HEADER_REQUEST_ID);
+        if (requestId != null && !requestId.isEmpty()) {
+            return requestId;
+        }
+
+        logger.trace("No valid X-RequestID header value. Checking X-TransactionID header for requestId.");
+        requestId = headers.get(Constants.HttpHeaders.TRANSACTION_ID);
+        if (requestId != null && !requestId.isEmpty()) {
+            return requestId;
+        }
+
+        logger.trace("No valid X-TransactionID header value. Checking X-ECOMP-RequestID header for requestId.");
+        requestId = headers.get(Constants.HttpHeaders.ECOMP_REQUEST_ID);
+        if (requestId != null && !requestId.isEmpty()) {
+            return requestId;
+        }
+
+        logger.trace("No valid requestId headers. Generating requestId: {}", requestId);
+        return UUID.randomUUID().toString();
+    }
+
+    protected void setInvocationId(SimpleMap headers) {
+        String invocationId = headers.get(ONAPLogConstants.Headers.INVOCATION_ID);
+        if (invocationId == null || invocationId.isEmpty())
+            invocationId = UUID.randomUUID().toString();
+        MDC.put(ONAPLogConstants.MDCs.INVOCATION_ID, invocationId);
+    }
+
+    protected void setInvocationIdFromMDC() {
+        String invocationId = MDC.get(ONAPLogConstants.MDCs.INVOCATION_ID);
+        if (invocationId == null || invocationId.isEmpty())
+            invocationId = UUID.randomUUID().toString();
+        MDC.put(ONAPLogConstants.MDCs.INVOCATION_ID, invocationId);
+    }
+
+    protected void setMDCPartnerName(SimpleMap headers) {
+        logger.trace("Checking X-ONAP-PartnerName header for partnerName.");
+        String partnerName = headers.get(ONAPLogConstants.Headers.PARTNER_NAME);
+        if (partnerName == null || partnerName.isEmpty()) {
+            logger.trace("No valid X-ONAP-PartnerName header value. Checking User-Agent header for partnerName.");
+            partnerName = headers.get(HttpHeaders.USER_AGENT);
+            if (partnerName == null || partnerName.isEmpty()) {
+                logger.trace("No valid User-Agent header value. Checking X-ClientID header for partnerName.");
+                partnerName = headers.get(Constants.HttpHeaders.CLIENT_ID);
+                if (partnerName == null || partnerName.isEmpty()) {
+                    logger.trace("No valid partnerName headers. Defaulting partnerName to UNKNOWN.");
+                    partnerName = Constants.DefaultValues.UNKNOWN;
+                }
+            }
+        }
+        MDC.put(ONAPLogConstants.MDCs.PARTNER_NAME, partnerName);
+    }
+
+    protected void setLogTimestamp() {
+        MDC.put(ONAPLogConstants.MDCs.LOG_TIMESTAMP,
+                ZonedDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ISO_INSTANT));
+    }
+
+    protected void setElapsedTime() {
+        DateTimeFormatter timeFormatter = DateTimeFormatter.ISO_ZONED_DATE_TIME;
+        ZonedDateTime entryTimestamp =
+                ZonedDateTime.parse(MDC.get(ONAPLogConstants.MDCs.ENTRY_TIMESTAMP), timeFormatter);
+        ZonedDateTime endTimestamp = ZonedDateTime.parse(MDC.get(ONAPLogConstants.MDCs.LOG_TIMESTAMP), timeFormatter);
+
+        MDC.put(ONAPLogConstants.MDCs.ELAPSED_TIME,
+                Long.toString(ChronoUnit.MILLIS.between(entryTimestamp, endTimestamp)));
+    }
+
+    protected void setElapsedTimeInvokeTimestamp() {
+        DateTimeFormatter timeFormatter = DateTimeFormatter.ISO_ZONED_DATE_TIME;
+        ZonedDateTime entryTimestamp =
+                ZonedDateTime.parse(MDC.get(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP), timeFormatter);
+        ZonedDateTime endTimestamp = ZonedDateTime.parse(MDC.get(ONAPLogConstants.MDCs.LOG_TIMESTAMP), timeFormatter);
+
+        MDC.put(ONAPLogConstants.MDCs.ELAPSED_TIME,
+                Long.toString(ChronoUnit.MILLIS.between(entryTimestamp, endTimestamp)));
+    }
+
+    protected void setResponseStatusCode(int code) {
+        String statusCode;
+        if (Response.Status.Family.familyOf(code).equals(Response.Status.Family.SUCCESSFUL)) {
+            statusCode = ONAPLogConstants.ResponseStatus.COMPLETE.toString();
+        } else {
+            statusCode = ONAPLogConstants.ResponseStatus.ERROR.toString();
+            setErrorCode(code);
+            setErrorDesc(code);
+        }
+        MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, statusCode);
+    }
+
+    protected void setTargetEntity(ONAPComponents targetEntity) {
+        MDC.put(ONAPLogConstants.MDCs.TARGET_ENTITY, targetEntity.toString());
+    }
+
+    protected void clearClientMDCs() {
+        MDC.remove(ONAPLogConstants.MDCs.INVOCATION_ID);
+        MDC.remove(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION);
+        MDC.remove(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE);
+        MDC.remove(ONAPLogConstants.MDCs.RESPONSE_CODE);
+        MDC.remove(ONAPLogConstants.MDCs.TARGET_ENTITY);
+        MDC.remove(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME);
+        MDC.remove(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP);
+        MDC.remove(ONAPLogConstants.MDCs.ERROR_CODE);
+        MDC.remove(ONAPLogConstants.MDCs.ERROR_DESC);
+    }
+
+    protected void setResponseDescription(int statusCode) {
+        MDC.put(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION, Response.Status.fromStatusCode(statusCode).toString());
+    }
+
+    protected void setErrorCode(int statusCode) {
+        MDC.put(ONAPLogConstants.MDCs.ERROR_CODE, String.valueOf(statusCode));
+    }
+
+    protected void setErrorDesc(int statusCode) {
+        MDC.put(ONAPLogConstants.MDCs.ERROR_DESC, Response.Status.fromStatusCode(statusCode).toString());
+    }
+
+    protected String getProperty(String property) {
+        logger.info("Checking for system property [{}]", property);
+        String propertyValue = System.getProperty(property);
+        if (propertyValue == null || propertyValue.isEmpty()) {
+            logger.info("System property was null or empty. Checking environment variable for: {}", property);
+            propertyValue = System.getenv(property);
+            if (propertyValue == null || propertyValue.isEmpty()) {
+                logger.info("Environment variable: {} was null or empty. Returning value: {}", property,
+                        Constants.DefaultValues.UNKNOWN);
+                propertyValue = Constants.DefaultValues.UNKNOWN;
+            }
+        }
+        return propertyValue;
+    }
+}