Package com.helger.photon.api

Interface IAPIExceptionMapper

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractAPIExceptionMapper

public interface IAPIExceptionMapper
extends Serializable

API exception mapper to convert exceptions into reasonable HTTP responses. It is called from inside APIInvoker in case an exception is thrown. See IAPIDescriptor for the assignment.

Since:

8.1.3

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
com.helger.commons.state.EHandled	applyExceptionOnResponse(InvokableAPIDescriptor aInvokableDescriptor, com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope, com.helger.servlet.response.UnifiedResponse aUnifiedResponse, Throwable aThrowable)

Method Detail

applyExceptionOnResponse

@Nonnull
com.helger.commons.state.EHandled applyExceptionOnResponse(@Nonnull
                                                           InvokableAPIDescriptor aInvokableDescriptor,
                                                           @Nonnull
                                                           com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope,
                                                           @Nonnull
                                                           com.helger.servlet.response.UnifiedResponse aUnifiedResponse,
                                                           @Nonnull
                                                           Throwable aThrowable)

Parameters:

aInvokableDescriptor - The current invokable descriptor. Never null.

aRequestScope - The current request scope. Never null.

aUnifiedResponse - The current response. Never null.

aThrowable - The thrown Exception. Never null.

Returns:

EHandled.HANDLED to indicate that the exception was handled and should NOT be re-thrown.