eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/DebugLog.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 import org.onap.dcae.utils.eelf.logger.api.info.LogLevelCategory;
  23 import org.onap.dcae.utils.eelf.logger.api.spec.DebugLogSpec;
  24 import org.onap.dcae.utils.eelf.logger.api.spec.OptionalLogSpec;
  25
  26 /**
  27  * Debug Log captures all log levels supported by debug specifications.
  28  * <p>
  29  * <b>NOTE: DEBUG Log is optional as per EELF Specifications</b>
  30  *
  31  * @author Rajiv Singla
  32  */
  33 public interface DebugLog {
  34
  35     /**
  36      * Logs debug message with provided {@link LogLevelCategory}
  37      *
  38      * @param logLevelCategory log level category
  39      * @param message log message
  40      * @param debugLogSpec debug log spec
  41      * @param optionalLogSpec optional log spec
  42      * @param args argument values for log message interpolation
  43      */
  44     void log(LogLevelCategory logLevelCategory, String message, DebugLogSpec debugLogSpec,
  45              OptionalLogSpec optionalLogSpec, String... args);
  46
  47     /**
  48      * Logs debug message with provided {@link LogLevelCategory} and with default {@link OptionalLogSpec}
  49      *
  50      * @param logLevelCategory log level category
  51      * @param message log message
  52      * @param debugLogSpec debug log spec
  53      * @param args argument values for log message interpolation
  54      */
  55     void log(LogLevelCategory logLevelCategory, String message, DebugLogSpec debugLogSpec, String... args);
  56
  57
  58     /**
  59      * Logs debug message with provided DEBUG {@link LogLevelCategory}
  60      *
  61      * @param message log message
  62      * @param debugLogSpec debug log spec
  63      * @param args argument values for log message interpolation
  64      */
  65     void debug(String message, DebugLogSpec debugLogSpec, OptionalLogSpec optionalLogSpec, String... args);
  66
  67     /**
  68      * Logs debug message with provided DEBUG {@link LogLevelCategory} and with default {@link OptionalLogSpec}
  69      *
  70      * @param message log message
  71      * @param debugLogSpec debug log spec
  72      * @param args argument values for log message interpolation
  73      */
  74     void debug(String message, DebugLogSpec debugLogSpec, String... args);
  75
  76 }