Package com.sap.cds.services.application

Interface ErrorResponseEventContext

All Superinterfaces:

EventContext

public interface ErrorResponseEventContext
extends EventContext

EventContext for the event ApplicationLifecycleService.EVENT_ERROR_RESPONSE, that allows to handle transformation of exceptions and messages to an error response

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ErrorResponseEventContext.ErrorResponse	Error response generated by the event handler.

Method Summary

Modifier and Type	Method	Description
static ErrorResponseEventContext	create()	Creates an EventContext already overlayed with this interface.
ServiceException	getException()	Returns the ServiceException that caused the error being transformed into an error response.
ErrorResponseEventContext.ErrorResponse	getResult()	Returns the ErrorResponseEventContext.ErrorResponse with messages and target HTTP status.
void	setException(ServiceException exception)	Sets the ServiceException that should be transformed into an error response.
void	setResult(ErrorResponseEventContext.ErrorResponse errorResponse)	Sets the ErrorResponseEventContext.ErrorResponse with messages and target HTTP status.

Methods inherited from interface com.sap.cds.services.EventContext

as, get, getAuthenticationInfo, getCdsRuntime, getChangeSetContext, getEvent, getFeatureTogglesInfo, getMessages, getModel, getParameterInfo, getService, getServiceCatalog, getTarget, getUserInfo, isCompleted, keySet, put, setCompleted

Method Details

create

static ErrorResponseEventContext create()

Creates an EventContext already overlayed with this interface. The event is set to be ApplicationLifecycleService.EVENT_ERROR_RESPONSE

Returns:

the ErrorResponseEventContext

setException

void setException(ServiceException exception)

Sets the ServiceException that should be transformed into an error response.

Parameters:

exception - the ServiceException that should be transformed into an error response.

getException

ServiceException getException()

Returns the ServiceException that caused the error being transformed into an error response.

Returns:

the ServiceException that should be transformed into an error response.

setResult

void setResult(ErrorResponseEventContext.ErrorResponse errorResponse)

Sets the ErrorResponseEventContext.ErrorResponse with messages and target HTTP status.

Parameters:

errorResponse - the ErrorResponseEventContext.ErrorResponse with messages and target HTTP status.

getResult

ErrorResponseEventContext.ErrorResponse getResult()

Returns the ErrorResponseEventContext.ErrorResponse with messages and target HTTP status.

Returns:

the ErrorResponseEventContext.ErrorResponse with messages and target HTTP status.