reference/logging-filter/logging-filter-spring/src/main/java/org/onap/logging/filter/spring/StatusLoggingInterceptor.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
  22 package org.onap.logging.filter.spring;
  23
  24 import javax.servlet.http.HttpServletRequest;
  25 import javax.servlet.http.HttpServletResponse;
  26 import javax.ws.rs.core.Context;
  27 import javax.ws.rs.core.Response;
  28 import javax.ws.rs.ext.Providers;
  29 import org.onap.logging.filter.base.PayloadLoggingServletFilter;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32 import org.springframework.stereotype.Component;
  33 import org.springframework.web.servlet.HandlerInterceptor;
  34 import org.springframework.web.servlet.ModelAndView;
  35
  36 // TODO do we want this class to log message payloads? In the previous implementation it did not
  37 @Component
  38 public class StatusLoggingInterceptor extends PayloadLoggingServletFilter implements HandlerInterceptor {
  39
  40     private static final Logger logger = LoggerFactory.getLogger(StatusLoggingInterceptor.class);
  41
  42     @Context
  43     private Providers providers;
  44
  45     @Override
  46     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
  47             throws Exception {
  48         if (logger.isDebugEnabled()) {
  49             logRequestInformation(request);
  50         }
  51         return true;
  52     }
  53
  54     protected void logRequestInformation(HttpServletRequest request) {
  55         logger.debug("===========================request begin================================================");
  56         logger.debug("URI         : {}", request.getRequestURI());
  57         logger.debug("Method      : {}", request.getMethod());
  58         logger.debug("Headers     : {}", getSecureRequestHeaders(request));
  59         logger.debug("==========================request end================================================");
  60     }
  61
  62     // TODO previously no response information was being logged, I followed the format in SpringClientPayloadFilter
  63     @Override
  64     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
  65             ModelAndView modelAndView) throws Exception {
  66         if (logger.isDebugEnabled()) {
  67             logger.debug("============================response begin==========================================");
  68             logger.debug("Status code  : {}", response.getStatus());
  69             logger.debug("Status text  : {}", Response.Status.fromStatusCode(response.getStatus()));
  70             logger.debug("Headers      : {}", formatResponseHeaders(response));
  71             logger.debug("=======================response end=================================================");
  72         }
  73     }
  74 }