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

Class ErrorResponseBuilder

java.lang.Object

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

public class ErrorResponseBuilder
extends Object

Builder translating Throwables to ResponseWithErrorCodes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_STACK_TRACE_LEVEL The maximum stack trace level to recurse into during error response building.
protected IdentityHashMap<Class<?>,ResponseMapper<?>>	responseMappers

Constructor Summary

Constructors

Constructor and Description
ErrorResponseBuilder()

Method Summary

Modifier and Type	Method and Description
ResponseWithErrorCode	build(Throwable throwable)
protected int	getMaxStackTraceLevel()
<ThrowableT extends Throwable & WithErrorResponse> ErrorResponseBuilder	logAsError(Class<ThrowableT> throwableClass) Defines the use of log level "error" for the given type of Throwable.
<ThrowableT extends Throwable & WithErrorResponse> ErrorResponseBuilder	logAsInfo(Class<ThrowableT> throwableClass) Defines the use of log level "info" for the given type of Throwable.
<ThrowableT extends Throwable & WithErrorResponse> ErrorResponseBuilder	logAsLevel(Class<ThrowableT> throwableClass, LogLevel logLevel) Defines the log level to use for the given type of Throwable.
<ThrowableT extends Throwable & WithErrorResponse> ErrorResponseBuilder	logAsWarning(Class<ThrowableT> throwableClass) Defines the use of log level "warning" for the given type of Throwable.
static ErrorResponseBuilder	newBuilder() Creates a new default error response builder.
<ThrowableT extends Throwable> ErrorResponseBuilder	removeMapping(Class<ThrowableT> throwableClass) Removes the mapping for a given type of Throwable.
protected ResponseWithErrorCode	toResponse(Throwable throwable)
protected ResponseWithErrorCode	toResponse(Throwable throwable, int stackTraceLevel)
ErrorResponseBuilder	withMapper(ResponseMapper<?> responseMapper) Use the given ResponseMapper for building the error response.
<ThrowableT extends Throwable & WithErrorResponse> ErrorResponseBuilder	withMapper(ResponseMapper<ThrowableT> responseMapper, LogLevel logLevel) Use the given ResponseMapper for building the error response.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_STACK_TRACE_LEVEL

public static final int MAX_STACK_TRACE_LEVEL

The maximum stack trace level to recurse into during error response building.

See Also:

Constant Field Values

responseMappers

protected final IdentityHashMap<Class<?>,ResponseMapper<?>> responseMappers

Constructor Detail

ErrorResponseBuilder

public ErrorResponseBuilder()

Method Detail

newBuilder

@Nonnull
public static ErrorResponseBuilder newBuilder()

Creates a new default error response builder.

Returns:

The new builder.

withMapper

@Nonnull
public ErrorResponseBuilder withMapper(@Nonnull
                                                ResponseMapper<?> responseMapper)

Use the given ResponseMapper for building the error response.

Parameters:

responseMapper - The response mapper to use.

Returns:

The builder for the error response.

withMapper

@Nonnull
public <ThrowableT extends Throwable & WithErrorResponse> ErrorResponseBuilder withMapper(@Nonnull
                                                                                                   ResponseMapper<ThrowableT> responseMapper,
                                                                                                   @Nonnull
                                                                                                   LogLevel logLevel)

Use the given ResponseMapper for building the error response.

Parameters:

responseMapper - The response mapper to use.

logLevel - The log level to use with the given response mapper.

Returns:

The builder for the error response.

logAsLevel

@Nonnull
public <ThrowableT extends Throwable & WithErrorResponse> ErrorResponseBuilder logAsLevel(@Nonnull
                                                                                                   Class<ThrowableT> throwableClass,
                                                                                                   @Nonnull
                                                                                                   LogLevel logLevel)

Defines the log level to use for the given type of Throwable.

Parameters:

throwableClass - The Throwable class.

logLevel - The log level to use.

Returns:

The builder for the error response.

logAsError

public <ThrowableT extends Throwable & WithErrorResponse> ErrorResponseBuilder logAsError(Class<ThrowableT> throwableClass)

Defines the use of log level "error" for the given type of Throwable.

Parameters:

throwableClass - The Throwable class.

Returns:

The builder for the error response.

logAsWarning

public <ThrowableT extends Throwable & WithErrorResponse> ErrorResponseBuilder logAsWarning(Class<ThrowableT> throwableClass)

Defines the use of log level "warning" for the given type of Throwable.

Parameters:

throwableClass - The Throwable class.

Returns:

The builder for the error response.

logAsInfo

public <ThrowableT extends Throwable & WithErrorResponse> ErrorResponseBuilder logAsInfo(Class<ThrowableT> throwableClass)

Defines the use of log level "info" for the given type of Throwable.

Parameters:

throwableClass - The Throwable class.

Returns:

The builder for the error response.

removeMapping

public <ThrowableT extends Throwable> ErrorResponseBuilder removeMapping(@Nonnull
                                                                         Class<ThrowableT> throwableClass)

Removes the mapping for a given type of Throwable.

Parameters:

throwableClass - The Throwable class.

Returns:

The builder for the error response.

build

public ResponseWithErrorCode build(@Nonnull
                                   Throwable throwable)

getMaxStackTraceLevel

protected int getMaxStackTraceLevel()

toResponse

protected ResponseWithErrorCode toResponse(@Nonnull
                                           Throwable throwable,
                                           int stackTraceLevel)

toResponse

protected ResponseWithErrorCode toResponse(@Nonnull
                                           Throwable throwable)