eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/EELFLoggerContext.java

   1 /*
   2  * ================================================================================
   3  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  * ============LICENSE_END=========================================================
  17  *
  18  */
  19
  20 package org.onap.dcae.utils.eelf.logger.api.log;
  21
  22
  23 import org.onap.dcae.utils.eelf.logger.api.spec.AppLogSpec;
  24
  25 /**
  26  * EELF Logger Context contains fields are set during application creation time and are fixed for the entire
  27  * duration of the application lifetime
  28  *
  29  * @author Rajiv Singla
  30  */
  31 public interface EELFLoggerContext {
  32
  33     /**
  34      * Returns App Log Spec
  35      *
  36      * @return current app log spec
  37      */
  38     AppLogSpec getAppLogSpec();
  39
  40
  41     /**
  42      * Sets new App Log Spec
  43      *
  44      * @param appLogSpec new app log spec
  45      */
  46     void setAppLogSpec(AppLogSpec appLogSpec);
  47
  48
  49     /**
  50      * Returns true if logging context is already initialized
  51      *
  52      * @return true if logger context is already initialized
  53      */
  54     boolean isInitialized();
  55
  56 }