reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/AbstractAuditLogFilter.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - Logging
   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.onap.logging.filter.base;
  22
  23 import javax.servlet.http.HttpServletRequest;
  24 import org.onap.logging.ref.slf4j.ONAPLogConstants;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27 import org.slf4j.MDC;
  28
  29 public abstract class AbstractAuditLogFilter<GenericRequest, GenericResponse> extends MDCSetup {
  30     protected static final Logger logger = LoggerFactory.getLogger(AbstractAuditLogFilter.class);
  31
  32     protected void pre(SimpleMap headers, GenericRequest request, HttpServletRequest httpServletRequest) {
  33         try {
  34             String requestId = getRequestId(headers);
  35             MDC.put(ONAPLogConstants.MDCs.REQUEST_ID, requestId);
  36             setInvocationId(headers);
  37             setServiceName(request);
  38             setMDCPartnerName(headers);
  39             setServerFQDN();
  40             setClientIPAddress(httpServletRequest);
  41             setInstanceID();
  42             setEntryTimeStamp();
  43             MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, ONAPLogConstants.ResponseStatus.INPROGRESS.toString());
  44             additionalPreHandling(request);
  45             setLogTimestamp();
  46             setElapsedTime();
  47             logEntering();
  48         } catch (Exception e) {
  49             logger.warn("Error in AbstractInboundFilter pre", e);
  50         }
  51     }
  52
  53     protected void post(GenericResponse response) {
  54         try {
  55             MDC.put(ONAPLogConstants.MDCs.INVOCATION_ID, MDC.get(ONAPLogConstants.MDCs.SERVER_INVOCATION_ID));
  56             int responseCode = getResponseCode(response);
  57             setResponseStatusCode(responseCode);
  58             MDC.put(ONAPLogConstants.MDCs.RESPONSE_CODE, String.valueOf(responseCode));
  59             setResponseDescription(responseCode);
  60             setLogTimestamp();
  61             setElapsedTime();
  62             additionalPostHandling(response);
  63             logExiting();
  64         } catch (Exception e) {
  65             logger.warn("Error in AbstractInboundFilter post", e);
  66         } finally {
  67             MDC.clear();
  68         }
  69     }
  70
  71     protected abstract int getResponseCode(GenericResponse response);
  72
  73     protected abstract void setServiceName(GenericRequest request);
  74
  75     protected void additionalPreHandling(GenericRequest request) {
  76         // override to add additional pre handling
  77     }
  78
  79     protected void additionalPostHandling(GenericResponse response) {
  80         // override to add additional post handling
  81     }
  82
  83     protected void logEntering() {
  84         logger.info(ONAPLogConstants.Markers.ENTRY, "Entering");
  85     }
  86
  87     protected void logExiting() {
  88         logger.info(ONAPLogConstants.Markers.EXIT, "Exiting.");
  89     }
  90
  91 }