gerrit.onap Code Review - sdc.git/blob

   1 /*
   2  * Copyright © 2016-2018 European Support Limited
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.openecomp.sdc.logging.servlet;
  18
  19 import javax.servlet.http.HttpServletRequest;
  20
  21 /**
  22  * Tracks logging and tracing information through the processing of an HTTP request.
  23  *
  24  * @author evitaliy
  25  * @since 31 Jul 2018
  26  */
  27 public interface Tracker {
  28
  29     /**
  30      * Will be executed before request processing has started.
  31      *
  32      * @param request provided by every Servlet container
  33      */
  34     void preRequest(HttpServletRequest request);
  35
  36     /**
  37      * Will be executed after a request has been processed.  Results may be treated differently depending on a container
  38      * and application. For instance, JAX-RS applications may take into account exception mappers before generating a
  39      * response; some applications may Swagger annotations to map a response status to a human-friendly message, etc.
  40      *
  41      * @param result application- and container-specific request results
  42      */
  43     void postRequest(RequestProcessingResult result);
  44 }