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
9 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
20 package org.onap.dcae.utils.eelf.logger.api.info;
23 * Captures field required for logging Response information
25 * @author Rajiv Singla
27 public interface ResponseLogInfo extends LogInfo {
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
34 * <table cellspacing=0 border=1>
36 * <th style=min-width:50px><b>Error type</b></th>
37 * <th style=min-width:50px><b>Notes</b></th>
40 * <td style=min-width:50px>0</td>
41 * <td style=min-width:50px>Success</td>
44 * <td style=min-width:50px>100</td>
45 * <td style=min-width:50px>Permission errors</td>
48 * <td style=min-width:50px>200</td>
49 * <td style=min-width:50px>Availability errors/Timeouts</td>
52 * <td style=min-width:50px>300</td>
53 * <td style=min-width:50px>Data errors</td>
56 * <td style=min-width:50px>400</td>
57 * <td style=min-width:50px>Schema errors</td>
60 * <td style=min-width:50px>500</td>
61 * <td style=min-width:50px>Business process errors</td>
64 * <td style=min-width:50px>900</td>
65 * <td style=min-width:50px>Unknown Errors</td>
69 * @return application-specific error code
71 Integer getResponseCode();
75 * Required field contains a human readable description of the {@link #getResponseCode()}.
77 * @return human readable description of the response code
79 String getResponseDescription();