common/openecomp-logging-lib/openecomp-logging-api/src/main/java/org/openecomp/core/logging/api/Logger.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 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.core.logging.api;
  22
  23 /**
  24  * <p>This interface defines logging as specified by OPENECOMP logging requirements.</p> <p>Formatted
  25  * messages must follow the <a href="http://www.slf4j.org/api/org/slf4j/helpers/MessageFormatter.html>SLF4J
  26  * format</a>.</p>
  27  */
  28 public interface Logger {
  29
  30   String getName();
  31
  32   boolean isMetricsEnabled();
  33
  34   void metrics(String msg);
  35
  36   void metrics(String msg, Object arg);
  37
  38   void metrics(String msg, Object arg1, Object arg2);
  39
  40   void metrics(String msg, Object... arguments);
  41
  42   void metrics(String msg, Throwable throwable);
  43
  44   boolean isAuditEnabled();
  45
  46   void audit(String msg);
  47
  48   void audit(String msg, Object arg);
  49
  50   void audit(String msg, Object arg1, Object arg2);
  51
  52   void audit(String msg, Object... arguments);
  53
  54   void audit(String msg, Throwable throwable);
  55
  56   boolean isDebugEnabled();
  57
  58   void debug(String msg);
  59
  60   void debug(String msg, Object arg);
  61
  62   void debug(String msg, Object arg1, Object arg2);
  63
  64   void debug(String msg, Object... arguments);
  65
  66   void debug(String msg, Throwable throwable);
  67
  68   boolean isInfoEnabled();
  69
  70   void info(String msg);
  71
  72   void info(String msg, Object arg);
  73
  74   void info(String msg, Object arg1, Object arg2);
  75
  76   void info(String msg, Object... arguments);
  77
  78   void info(String msg, Throwable throwable);
  79
  80   boolean isWarnEnabled();
  81
  82   void warn(String msg);
  83
  84   void warn(String msg, Object arg);
  85
  86   void warn(String msg, Object... arguments);
  87
  88   void warn(String msg, Object arg1, Object arg2);
  89
  90   void warn(String msg, Throwable throwable);
  91
  92   boolean isErrorEnabled();
  93
  94   void error(String msg);
  95
  96   void error(String msg, Object arg);
  97
  98   void error(String msg, Object arg1, Object arg2);
  99
 100   void error(String msg, Object... arguments);
 101
 102   void error(String msg, Throwable throwable);
 103 }