com.sap.cloud.sdk.cloudplatform.servlet.response

Class ResponseWithErrorCode

java.lang.Object

com.sap.cloud.sdk.cloudplatform.servlet.response.ResponseWithErrorCode

Direct Known Subclasses:

AccessDeniedResponse, CloudConnectorErrorResponse, ConstraintViolatedResponse, DestinationErrorResponse, EntityAlreadyExistsResponse, EntityNotFoundResponse, FeatureNotEnabledResponse, ForbiddenOperationResponse, FormatNotRecognizedResponse, InvalidFieldFormatResponse, InvalidJsonResponse, InvalidParameterResponse, LogonErrorResponse, MandatoryFieldsMissingResponse, MissingConfigResponse, MissingParameterResponse, NotAuthenticatedResponse, NotImplementedResponse, PayloadTooLargeResponse, QuerySignatureErrorResponse, RemoteFunctionResponseWithErrorCode, RequestExecutionErrorResponse, ServiceNotAvailableResponse, UnexpectedErrorResponse, UnsupportedOperationResponse, VersionNotSupportedResponse

public abstract class ResponseWithErrorCode
extends Object

Class representing an error response that is returned by a web service.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description The error description.
protected String	errorCode The error code.
protected int	httpStatusCode The HTTP status code.
protected String	referenceId The error reference id.

Constructor Summary

Constructors

Constructor and Description
ResponseWithErrorCode(int httpStatusCode, String errorCode, String description) Constructor for a response with a HTTP status code.

Method Summary

Modifier and Type	Method and Description
io.vavr.control.Option<String>	getDescription() Get optional description.
String	getErrorCode() The error code.
int	getHttpStatusCode() The HTTP status code.
String	getReferenceId() The error reference id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

httpStatusCode

protected final int httpStatusCode

The HTTP status code.

errorCode

@Expose
 @SerializedName(value="error")
protected final String errorCode

The error code.

referenceId

@Expose
 @SerializedName(value="referenceId")
protected final String referenceId

The error reference id.

description

@Nullable
 @Expose
 @SerializedName(value="description")
protected final String description

The error description.

Constructor Detail

ResponseWithErrorCode

public ResponseWithErrorCode(int httpStatusCode,
                             @Nonnull
                             String errorCode,
                             @Nullable
                             String description)

Constructor for a response with a HTTP status code.

Parameters:

httpStatusCode - The HTTP status code.

errorCode - The error code.

description - The optional error description.

Method Detail

getDescription

@Nonnull
public io.vavr.control.Option<String> getDescription()

Get optional description.

Returns:

The description.

getHttpStatusCode

public int getHttpStatusCode()

The HTTP status code.

getErrorCode

public String getErrorCode()

The error code.

getReferenceId

public String getReferenceId()

The error reference id.