/*
* ================================================================================
* Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*
*/
package org.onap.dcae.utils.eelf.logger.api.info;
/**
* Captures field required for logging Response information
*
* @author Rajiv Singla
*/
public interface ResponseLogInfo extends LogInfo {
/**
* Required field contains application-specific response codes. While error codes are
* application-specific, they
* should conform categories mentioned in table below in order to provide consistency
*
*
*
*
Error type
*
Notes
*
*
*
0
*
Success
*
*
*
100
*
Permission errors
*
*
*
200
*
Availability errors/Timeouts
*
*
*
300
*
Data errors
*
*
*
400
*
Schema errors
*
*
*
500
*
Business process errors
*
*
*
900
*
Unknown Errors
*
*
*
* @return application-specific error code
*/
Integer getResponseCode();
/**
* Required field contains a human readable description of the {@link #getResponseCode()}.
*
* @return human readable description of the response code
*/
String getResponseDescription();
}