common-app-api/src/main/java/org/openecomp/sdc/common/log/wrappers/LoggerSdcAudit.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.openecomp.sdc.common.log.wrappers;
  22
  23 import org.apache.commons.lang3.StringUtils;
  24 import org.openecomp.sdc.common.api.Constants;
  25 import org.openecomp.sdc.common.log.elements.LoggerAudit;
  26 import org.openecomp.sdc.common.log.elements.LoggerFactory;
  27 import org.openecomp.sdc.common.log.enums.LogLevel;
  28 import org.openecomp.sdc.common.log.enums.Severity;
  29 import org.openecomp.sdc.common.util.ThreadLocalsHolder;
  30 import org.slf4j.MDC;
  31
  32 import javax.ws.rs.container.ContainerRequestContext;
  33 import javax.ws.rs.core.Response;
  34
  35
  36 /**
  37  * Created by dd4296 on 12/19/2017.
  38  * <p>
  39  * audit log for asdc using the log library
  40  * this is adapted for filter classes
  41  */
  42 public class LoggerSdcAudit extends LoggerSdcUtilBase {
  43
  44     private static final String AUDIT_ON = "auditOn";
  45     private String className;
  46     private final LoggerAudit ecompLoggerAudit;
  47
  48     public LoggerSdcAudit(Class<?> clazz) {
  49         this.className = clazz.getName();
  50         ecompLoggerAudit = LoggerFactory.getMdcLogger(LoggerAudit.class, org.slf4j.LoggerFactory.getLogger(clazz));
  51     }
  52
  53     public void startLog(ContainerRequestContext requestContext) {
  54         ecompLoggerAudit.clear()
  55                 .startTimer()
  56                 .setPartnerName(getPartnerName(
  57                         requestContext.getHeaderString("user-agent"),
  58                         requestContext.getHeaderString("USER_ID"),
  59                         getUrl(requestContext)))
  60                 .setServiceName(getServiceName(requestContext))
  61                 .setKeyRequestId(ThreadLocalsHolder.getUuid());
  62         MDC.put(AUDIT_ON, "true");
  63     }
  64
  65     public static boolean isFlowBeingTakenCare() {
  66         String auditOn = MDC.get(AUDIT_ON);
  67         return !StringUtils.isEmpty(auditOn) && "true".equals(auditOn);
  68     }
  69
  70     //this function clears the MDC data that relevant for this class
  71     public void clearMyData() {
  72         ecompLoggerAudit.clear();
  73     }
  74
  75     public void log(String remoteAddress,
  76                     ContainerRequestContext requestContext,
  77                     Response.StatusType statusInfo,
  78                     LogLevel logLevel,
  79                     Severity securityLevel,
  80                     String message) {
  81
  82         try {
  83
  84             String msg = ecompLoggerAudit.getAuditMessage() == null
  85                     ? message : ecompLoggerAudit.getAuditMessage();
  86             ecompLoggerAudit.stopTimer()
  87                     .setRemoteHost(remoteAddress)
  88                     .setResponseCode(convertHttpCodeToErrorCode(statusInfo.getStatusCode()))
  89                     .setStatusCode(Integer.toString(statusInfo.getStatusCode()))
  90                     .setResponseDesc(statusInfo.getReasonPhrase())
  91                     .setInstanceUUID(requestContext.getHeaderString(Constants.X_ECOMP_INSTANCE_ID_HEADER))
  92                     .setOptServiceInstanceId(requestContext.getHeaderString(Constants.X_ECOMP_SERVICE_ID_HEADER))
  93                     .setOptClassName(className)
  94                     .setOptAlertSeverity(securityLevel)
  95                     .setOptCustomField1(requestContext.getMethod() + ": " + getUrl(requestContext))
  96                     .setOptCustomField2(Integer.toString(statusInfo.getStatusCode()))
  97                     .log(logLevel, msg);
  98         } catch (Exception e) {
  99             log.warn("Failed to write to Audit Log. Original Message: {}", message, e);
 100         } finally {
 101             MDC.put(AUDIT_ON, "false");
 102         }
 103     }
 104 }