catalog-fe/src/main/java/org/openecomp/sdc/fe/servlets/LoggingServlet.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.fe.servlets;
  22
  23 import org.openecomp.sdc.common.servlets.BasicServlet;
  24 import org.openecomp.sdc.fe.impl.LogHandler;
  25
  26 import javax.servlet.http.HttpServletRequest;
  27 import javax.ws.rs.core.Response;
  28
  29 public abstract class LoggingServlet extends BasicServlet {
  30
  31     public static final String UUID = "uuid";
  32     public static final String TRANSACTION_START_TIME = "transactionStartTime";
  33
  34     /**
  35      * log incoming requests
  36      * @param httpRequest the http request
  37      */
  38     void logFeRequest(HttpServletRequest httpRequest){
  39         LogHandler.logFeRequest(httpRequest);
  40         inHttpRequest(httpRequest);
  41     }
  42
  43     /**
  44      * log response
  45      * @param request orig request
  46      * @param response returned response
  47      */
  48     void logFeResponse(HttpServletRequest request, Response response) {
  49         LogHandler.logFeResponse(request);
  50         outHttpResponse(response);
  51     }
  52
  53     /**
  54      * Extracted for purpose of clear method name, for logback %M parameter
  55      * @param httpRequest http request
  56      */
  57     protected abstract void inHttpRequest(HttpServletRequest httpRequest) ;
  58
  59
  60     /**
  61      * Extracted for purpose of clear method name, for logback %M parameter
  62      * @param response http response
  63      */
  64     protected abstract void outHttpResponse(Response response);
  65 }