Class HttpFaultResolverDecoratorExtensions

Namespace

Cuemon.AspNetCore.Diagnostics

Assembly

Cuemon.AspNetCore.dll

Extension methods for the HttpFaultResolver class hidden behind the IDecorator<T> interface.

public static class HttpFaultResolverDecoratorExtensions

Inheritance

object

HttpFaultResolverDecoratorExtensions

Methods

AddHttpFaultResolver<T>(IDecorator<IList<HttpFaultResolver>>, Func<T, HttpExceptionDescriptor>, Func<Exception, bool>)

Adds the specified function delegate exceptionDescriptorResolver and function delegate exceptionValidator to the enclosed IList{FaultResolver} of the decorator.

public static IDecorator<IList<HttpFaultResolver>> AddHttpFaultResolver<T>(this IDecorator<IList<HttpFaultResolver>> decorator, Func<T, HttpExceptionDescriptor> exceptionDescriptorResolver, Func<Exception, bool> exceptionValidator) where T : Exception

Parameters

decorator IDecorator<IList<HttpFaultResolver>>

The IDecorator<T> to extend.

exceptionDescriptorResolver Func<T, HttpExceptionDescriptor>

The function delegate that associates an Exception of type T with an HttpExceptionDescriptor.

exceptionValidator Func<Exception, bool>

The function delegate that evaluates an Exception.

Returns

IDecorator<IList<HttpFaultResolver>>

The IDecorator{IList{FaultResolver}} instance.

Type Parameters

T

The type of the Exception to associate with a HttpFaultResolver.

Exceptions

ArgumentNullException

decorator cannot be null.

AddHttpFaultResolver<T>(IDecorator<IList<HttpFaultResolver>>, int, string, string, Uri, Func<Exception, bool>)

Adds a new HttpExceptionDescriptor to the enclosed IList{FaultResolver} of the decorator from the parameters provided.

public static IDecorator<IList<HttpFaultResolver>> AddHttpFaultResolver<T>(this IDecorator<IList<HttpFaultResolver>> decorator, int statusCode, string code = null, string message = null, Uri helpLink = null, Func<Exception, bool> exceptionValidator = null) where T : Exception

Parameters

decorator IDecorator<IList<HttpFaultResolver>>

The IDecorator<T> to extend.

statusCode int

The status code of the HTTP request.

code string

The error code that uniquely identifies the type of failure.

message string

The message that explains the reason for the failure.

helpLink Uri

The optional link to a help page associated with this failure.

exceptionValidator Func<Exception, bool>

The function delegate that evaluates an Exception.

Returns

IDecorator<IList<HttpFaultResolver>>

The IDecorator{IList{FaultResolver}} instance.

Type Parameters

T

The type of the Exception to associate with a HttpFaultResolver.

Remarks

The following table shows the initial property values for the added instance of HttpExceptionDescriptor.

Parameter	Initial Value
code	code ?? ReasonPhrases.GetReasonPhrase(statusCode)
message	message ?? failure.Message

Exceptions

ArgumentNullException

decorator cannot be null.

AddHttpFaultResolver<T>(IDecorator<IList<HttpFaultResolver>>, string, Uri, Func<Exception, bool>)

Adds a new HttpExceptionDescriptor to the enclosed IList{FaultResolver} of the decorator from the parameters provided.

public static IDecorator<IList<HttpFaultResolver>> AddHttpFaultResolver<T>(this IDecorator<IList<HttpFaultResolver>> decorator, string message = null, Uri helpLink = null, Func<Exception, bool> exceptionValidator = null) where T : HttpStatusCodeException

Parameters

decorator IDecorator<IList<HttpFaultResolver>>

The IDecorator<T> to extend.

message string

The message that explains the reason for the failure.

helpLink Uri

The optional link to a help page associated with this failure.

exceptionValidator Func<Exception, bool>

The function delegate that evaluates an Exception.

Returns

IDecorator<IList<HttpFaultResolver>>

The IDecorator{IList{FaultResolver}} instance.

Type Parameters

T

The type of the HttpStatusCodeException to associate with a HttpFaultResolver.

Remarks

The following table shows the initial property values for the added instance of HttpExceptionDescriptor.

Parameter	Initial Value
message	message ?? failure.Message

Exceptions

ArgumentNullException

decorator cannot be null.

See Also

IDecorator<T>

Decorator<T>