gerrit.onap Code Review - sdc.git/blob

   1 /*
   2  * Copyright © 2016-2017 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.slf4j;
  18
  19 import java.util.Map;
  20
  21 /**
  22  * Does not store a state other than initial context values. Objects of this class may be reused by multiple threads,
  23  * therefore they must be stateless to prevent inadvertent exchange of context values between threads.
  24  *
  25  * @author evitaliy
  26  * @since 08 Jan 2018
  27  */
  28 final class Context {
  29
  30     private final Map<ContextField, String> originalCtx;
  31
  32     Context() {
  33         this.originalCtx = MDCDelegate.copy();
  34     }
  35
  36     /**
  37      * Pushes the initial context onto current thread, and returns the existing context. The result cannot be stored as
  38      * local state (see the class comments), and must be kept in a local variable to work properly.
  39      *
  40      * @return previous context values
  41      */
  42     final Map<ContextField, String> replace() {
  43         Map<ContextField, String> old = MDCDelegate.copy();
  44         MDCDelegate.replace(this.originalCtx);
  45         return old;
  46     }
  47
  48     /**
  49      * Pushes an old context onto current thread.
  50      *
  51      * @param old copy of the old context returned by {@link #replace()}
  52      */
  53     final void revert(Map<ContextField, String> old) {
  54         MDCDelegate.replace(old);
  55     }
  56 }