eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/ErrorLogInfo.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.info;
  21
  22 /**
  23  * Captures fields required to log error related information
  24  *
  25  * @author Rajiv Singla
  26  */
  27 public interface ErrorLogInfo extends LogInfo {
  28
  29
  30     /**
  31      * Required field contains an error code representing the error condition. The codes can be chose by
  32      * the logging application but they should adhere to the guidelines embodied in the table below:
  33      * <table summary="Error Codes" cellspacing=0 border=1>
  34      * <tr>
  35      * <td style=min-width:50px>Error type</td>
  36      * <td style=min-width:50px>Notes</td>
  37      * </tr>
  38      * <tr>
  39      * <td style=min-width:50px>100</td>
  40      * <td style=min-width:50px>Permission errors</td>
  41      * </tr>
  42      * <tr>
  43      * <td style=min-width:50px>200</td>
  44      * <td style=min-width:50px>Availability errors/Timeouts</td>
  45      * </tr>
  46      * <tr>
  47      * <td style=min-width:50px>300</td>
  48      * <td style=min-width:50px>Data errors</td>
  49      * </tr>
  50      * <tr>
  51      * <td style=min-width:50px>400</td>
  52      * <td style=min-width:50px>Schema errors</td>
  53      * </tr>
  54      * <tr>
  55      * <td style=min-width:50px>500</td>
  56      * <td style=min-width:50px>Business process errors</td>
  57      * </tr>
  58      * <tr>
  59      * <td style=min-width:50px>900</td>
  60      * <td style=min-width:50px>Unknown Errors</td>
  61      * </tr>
  62      * </table>
  63      *
  64      * @return error Code
  65      */
  66     Integer getErrorCode();
  67
  68
  69     /**
  70      * Required field contains a human readable description of the error condition.
  71      *
  72      * @return human readable description of the error condition
  73      */
  74     String getErrorDescription();
  75
  76 }