me.alidg.errors

Class WebErrorHandlersBuilder

java.lang.Object

me.alidg.errors.WebErrorHandlersBuilder

public final class WebErrorHandlersBuilder
extends Object

A fluent builder responsible for creating WebErrorHandlers instances.

Author:

zarebski.m

Method Summary

Modifier and Type	Method and Description
WebErrorHandlers	build() Creates the WebErrorHandlers instance from the current builder state.
WebErrorHandlersBuilder	withDefaultWebErrorHandler(WebErrorHandler defaultWebErrorHandler) Represents the default web error handler we're gonna use when all other handlers refuse to handle an exception.
WebErrorHandlersBuilder	withErrorHandlers(Collection<WebErrorHandler> webErrorHandlers) Collection of error handlers to consult when facing a new exception.
WebErrorHandlersBuilder	withErrorHandlers(WebErrorHandler... webErrorHandlers) Collection of error handlers to consult when facing a new exception.
WebErrorHandlersBuilder	withErrorsProperties(ErrorsProperties errorsProperties) Determines the way we're gonna configure the error handling mechanism.
WebErrorHandlersBuilder	withExceptionLogger(ExceptionLogger exceptionLogger) Defines a way to logs exceptions before handling them.
WebErrorHandlersBuilder	withExceptionRefiner(ExceptionRefiner exceptionRefiner) Enables us to refine exceptions before kicking off the exception handling procedure.
WebErrorHandlersBuilder	withFingerprintProvider(FingerprintProvider fingerprintProvider) Responsible for calculating error fingerprints for handled exceptions.
WebErrorHandlersBuilder	withPostProcessors(Collection<WebErrorHandlerPostProcessor> webErrorHandlerPostProcessors) Collection of post processors to call after handling any given exception.
WebErrorHandlersBuilder	withPostProcessors(WebErrorHandlerPostProcessor... webErrorHandlerPostProcessors) Collection of post processors to call after handling any given exception.

Methods inherited from class java.lang.Object

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

Method Detail

withErrorsProperties

public WebErrorHandlersBuilder withErrorsProperties(@NonNull
                                                    ErrorsProperties errorsProperties)

Determines the way we're gonna configure the error handling mechanism.

Parameters:

errorsProperties - Non-null instance of ErrorsProperties. If not provided, default-constructed ErrorsProperties will be used.

Returns:

This builder.

See Also:

errorsProperties

withErrorHandlers

public WebErrorHandlersBuilder withErrorHandlers(@NonNull
                                                 Collection<WebErrorHandler> webErrorHandlers)

Collection of error handlers to consult when facing a new exception.

Parameters:

webErrorHandlers - Non-null collection of WebErrorHandler instances.

Returns:

This builder.

See Also:

webErrorHandlers

withErrorHandlers

public WebErrorHandlersBuilder withErrorHandlers(@NonNull
                                                 WebErrorHandler... webErrorHandlers)

Collection of error handlers to consult when facing a new exception.

Parameters:

webErrorHandlers - Varargs array of WebErrorHandler instances.

Returns:

This builder.

See Also:

webErrorHandlers

withDefaultWebErrorHandler

public WebErrorHandlersBuilder withDefaultWebErrorHandler(@NonNull
                                                          WebErrorHandler defaultWebErrorHandler)

Represents the default web error handler we're gonna use when all other handlers refuse to handle an exception.

Parameters:

defaultWebErrorHandler - Non-null instance of WebErrorHandler. If not provided, LastResortWebErrorHandler will be used.

Returns:

This builder.

See Also:

defaultWebErrorHandler

withExceptionRefiner

public WebErrorHandlersBuilder withExceptionRefiner(@NonNull
                                                    ExceptionRefiner exceptionRefiner)

Enables us to refine exceptions before kicking off the exception handling procedure.

Parameters:

exceptionRefiner - Non-null instance of ExceptionRefiner. If not provided, ExceptionRefiner.NoOp will be used.

Returns:

This builder.

See Also:

exceptionRefiner

withExceptionLogger

public WebErrorHandlersBuilder withExceptionLogger(@NonNull
                                                   ExceptionLogger exceptionLogger)

Defines a way to logs exceptions before handling them.

Parameters:

exceptionLogger - Non-null instance of ExceptionLogger. If not provided, ExceptionLogger.NoOp will be used.

Returns:

This builder.

See Also:

exceptionLogger

withPostProcessors

public WebErrorHandlersBuilder withPostProcessors(@NonNull
                                                  Collection<WebErrorHandlerPostProcessor> webErrorHandlerPostProcessors)

Collection of post processors to call after handling any given exception.

Parameters:

webErrorHandlerPostProcessors - Non-null collection of WebErrorHandlerPostProcessor instances.

Returns:

This builder.

See Also:

webErrorHandlerPostProcessors

withPostProcessors

public WebErrorHandlersBuilder withPostProcessors(@NonNull
                                                  WebErrorHandlerPostProcessor... webErrorHandlerPostProcessors)

Collection of post processors to call after handling any given exception.

Parameters:

webErrorHandlerPostProcessors - Varargs array of WebErrorHandlerPostProcessor instances.

Returns:

This builder.

See Also:

webErrorHandlerPostProcessors

withFingerprintProvider

public WebErrorHandlersBuilder withFingerprintProvider(@NonNull
                                                       FingerprintProvider fingerprintProvider)

Responsible for calculating error fingerprints for handled exceptions.

Parameters:

fingerprintProvider - Non-null instance of FingerprintProvider. If not provided, UuidFingerprintProvider will be used.

Returns:

This builder.

See Also:

exceptionLogger

build

@NonNull
public WebErrorHandlers build()

Creates the WebErrorHandlers instance from the current builder state.

Returns:

Instance of WebErrorHandlers.