eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/ResponseLogInfo.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 field required for logging Response information
  24  *
  25  * @author Rajiv Singla
  26  */
  27 public interface ResponseLogInfo extends LogInfo {
  28
  29     /**
  30      * Required field contains application-specific response codes. While error codes are
  31      * application-specific, they
  32      * should conform categories mentioned in table below in order to provide consistency
  33      * <div style="display: flex">
  34      *     <div style="border-left: 2px solid black; border-right: 2px solid black;">
  35      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Error Type</p>
  36      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">0</p>
  37      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">100</p>
  38      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">200</p>
  39      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">300</p>
  40      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">400</p>
  41      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">500</p>
  42      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;border-bottom: 2px solid black;">
  43      *             900</p>
  44      *     </div>
  45      *     <div style="border-right: 2px solid black;">
  46      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Notes</p>
  47      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Success</p>
  48      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Permission errors</p>
  49      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Availability errors/Timeouts</p>
  50      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Data errors</p>
  51      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Schema errors</p>
  52      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Business process errors</p>
  53      *         <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;border-bottom: 2px solid black;">
  54      *             Unknown Errors</p>
  55      *     </div>
  56      * </div>
  57      *
  58      * @return error Code
  59      */
  60     Integer getResponseCode();
  61
  62
  63     /**
  64      * Required field contains a human readable description of the {@link #getResponseCode()}.
  65      *
  66      * @return human readable description of the response code
  67      */
  68     String getResponseDescription();
  69
  70 }