com.sap.cloud.sdk.service.prov.api.response

Interface ErrorResponseBuilder

All Known Implementing Classes:

ErrorResponseBuilderImpl

public interface ErrorResponseBuilder

Provides the methods for creating an error response and populating its status code, cause, and message, in the case of a failed operation.

Method Summary

Modifier and Type	Method and Description
ErrorResponseBuilder	addContainerMessages(Severity... severities) Adds the non-leading container messages with the given severities to the ErrorResponse.
ErrorResponseBuilder	addErrorDetail(String messageKey, String target, Object... params) Adds a new error detail.
ErrorResponse	response() Returns an instance of ErrorResponse object.
ErrorResponseBuilder	setCause(Throwable throwable) Sets the exception that caused the operation to fail in the ErrorResponseBuilder object.
ErrorResponseBuilder	setErrorCode(String errorCode) Sets the error code in the ErrorResponseBuilder object.
ErrorResponseBuilder	setMessage(String messageKey, Object... params) Sets the error message considering localization.
ErrorResponseBuilder	setStatusCode(int statusCode) Sets the status code of the error in the ErrorResponseBuilder object.

Method Detail

setCause

ErrorResponseBuilder setCause(Throwable throwable)

Sets the exception that caused the operation to fail in the ErrorResponseBuilder object.

Parameters:

throwable - A Throwable object that represents the exception

Returns:

An ErrorResponseBuilder object containing the exception

setStatusCode

ErrorResponseBuilder setStatusCode(int statusCode)

Sets the status code of the error in the ErrorResponseBuilder object.

Parameters:

statusCode - An int representing the status code

Returns:

An ErrorResponseBuilder object containing the status code

setMessage

ErrorResponseBuilder setMessage(String messageKey,
                                Object... params)

Sets the error message considering localization.

Parameters:

messageKey - A String key associated with the message in properties file to retrieve the message text. In case there is no value for such a key in the property file, the message key itself will be taken as the message text. This parameter is set as the error code in the error response only if the error code is not explicitly set using setErrorCode API.

params - Variable length array of objects for this message. These objects will be converted to strings and substituted in the messageText in place of parameter placeholders. In case there are no parameters, do not pass any objects for this argument.

Returns:

An ErrorResponseBuilder object containing the message.

response

ErrorResponse response()

Returns an instance of ErrorResponse object.

Returns:

An ErrorResponse object

addContainerMessages

ErrorResponseBuilder addContainerMessages(Severity... severities)

Adds the non-leading container messages with the given severities to the ErrorResponse. Note that if no severity is passed, all the non-leading container messages will be added to the error response.

Parameters:

severities - A variable length argument which denotes the severity of the messages which have to be added from the MessageContainer to the error response.

Returns:

An ErrorResponsBuilder which would build an ErrorResponse with the container messages added as per severity.

addErrorDetail

ErrorResponseBuilder addErrorDetail(String messageKey,
                                    String target,
                                    Object... params)

Adds a new error detail. Severity is considered ERROR hence not taken as an argument. The message text of the error detail will be obtained from a properties file based on the messageKey parameter. The messageKey parameter also becomes the "code" of the error detail. Parameters is taken through a variable length array of objects. These objects will be stringified and substituted in the messageText in place of parameter place holders. In case there are no parameters, just don't pass any objects for this argument.

Parameters:

messageKey - associated with the message, used as the key to a properties file to retrieve the message text.

target - Target for which this error detail applies.

params - Variable length array of parameters for this message.

Returns:

setErrorCode

ErrorResponseBuilder setErrorCode(String errorCode)

Sets the error code in the ErrorResponseBuilder object.

Parameters:

errorCode - A String representing the error code

Returns:

An ErrorResponseBuilder object containing the error code