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

Class AbstractExceptionMapper<ClassT extends AbstractExceptionMapper<ClassT>>

java.lang.Object

com.sap.cloud.sdk.cloudplatform.servlet.response.AbstractExceptionMapper<ClassT>

Type Parameters:

ClassT - The type of the implementing class.

Direct Known Subclasses:

JaxRsExceptionMapper, SpringExceptionMapper

public abstract class AbstractExceptionMapper<ClassT extends AbstractExceptionMapper<ClassT>>
extends Object

Base class to be used by different the exception handling of different frameworks.

Provides different methods to modify the underlying Exception mapping.

Constructor Summary

Constructors

Constructor and Description
AbstractExceptionMapper()

Method Summary

Modifier and Type	Method and Description
ErrorResponseBuilder	getErrorResponseBuilder()
<ThrowableT extends Throwable & WithErrorResponse> ClassT	logAsError(Class<ThrowableT> throwableClass) Only sets the error log level for any Throwable of the given type.
<ThrowableT extends Throwable & WithErrorResponse> ClassT	logAsInfo(Class<ThrowableT> throwableClass) Only sets the info log level for any Throwable of the given type.
<ThrowableT extends Throwable & WithErrorResponse> ClassT	logAsLevel(Class<ThrowableT> throwableClass, LogLevel logLevel) Only sets a specific server-side log level for any Throwable of the given type.
<ThrowableT extends Throwable & WithErrorResponse> ClassT	logAsWarning(Class<ThrowableT> throwableClass) Only sets the warning log level for any Throwable of the given type.
<ThrowableT extends Throwable> ClassT	removeMapping(Class<ThrowableT> tClass) Removes the mapping for the given Throwable class.
protected abstract ClassT	self() Getter for this.
protected ResponseWithErrorCode	toResponseWithErrorCode(Throwable throwable) Wraps the given Throwable into a ResponseWithErrorCode, using the mappings stored in the ErrorResponseBuilder.
<ThrowableT extends Throwable> ClassT	withMapper(ResponseMapper<ThrowableT> mapper) Adds the given ResponseMapper for the Throwable specified insider the mapper.
<ThrowableT extends Throwable & WithErrorResponse> ClassT	withMapper(ResponseMapper<ThrowableT> responseMapper, LogLevel logLevel) Adds the given ResponseMapper for the Throwable specified insider the mapper.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExceptionMapper

public AbstractExceptionMapper()

Method Detail

self

protected abstract ClassT self()

Getter for this. Needed to facilitate a fluent interface in the implementing classes.

Returns:

this

toResponseWithErrorCode

protected ResponseWithErrorCode toResponseWithErrorCode(Throwable throwable)

Wraps the given Throwable into a ResponseWithErrorCode, using the mappings stored in the ErrorResponseBuilder.

Parameters:

throwable - The Throwable to handle.

Returns:

The ResponseWithErrorCode for the given Throwable.

removeMapping

public <ThrowableT extends Throwable> ClassT removeMapping(Class<ThrowableT> tClass)

Removes the mapping for the given Throwable class.

Type Parameters:

ThrowableT - The type of the class to be removed.

Parameters:

tClass - The class to remove the mapping for.

Returns:

this

withMapper

public <ThrowableT extends Throwable> ClassT withMapper(ResponseMapper<ThrowableT> mapper)

Adds the given ResponseMapper for the Throwable specified insider the mapper.

Type Parameters:

ThrowableT - The type of the Throwable the mapper handles.

Parameters:

mapper - The mapper to add.

Returns:

this

withMapper

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

Adds the given ResponseMapper for the Throwable specified insider the mapper. Also adds a custom LogLevel used to server-side log any Throwable of the specified type.

Type Parameters:

ThrowableT - The type of the exception to be handled.

Parameters:

responseMapper - The mapper to add.

logLevel - The LogLevel to use for server-side logging of the Throwable.

Returns:

this

logAsLevel

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

Only sets a specific server-side log level for any Throwable of the given type.

Type Parameters:

ThrowableT - The type of the Throwable to log.

Parameters:

throwableClass - The class of Throwable which should be logged with a specific LogLevel.

logLevel - The LogLevel to use.

Returns:

this

logAsError

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

Only sets the error log level for any Throwable of the given type.

Type Parameters:

ThrowableT - The type of the Throwable to log.

Parameters:

throwableClass - The class of Throwable which should be logged as error.

Returns:

this

logAsWarning

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

Only sets the warning log level for any Throwable of the given type.

Type Parameters:

ThrowableT - The type of the Throwable to log.

Parameters:

throwableClass - The class of Throwable which should be logged as warning.

Returns:

this

logAsInfo

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

Only sets the info log level for any Throwable of the given type.

Type Parameters:

ThrowableT - The type of the Throwable to log.

Parameters:

throwableClass - The class of Throwable which should be logged as info.

Returns:

this

getErrorResponseBuilder

@Nonnull
public ErrorResponseBuilder getErrorResponseBuilder()