Class FaultDescriptorFilter

Namespace

Cuemon.AspNetCore.Mvc.Filters.Diagnostics

Assembly

Cuemon.AspNetCore.Mvc.dll

A filter that, after an action has faulted, provides developer friendly information about an Exception along with a correct HttpStatusCode.

public class FaultDescriptorFilter : Configurable<MvcFaultDescriptorOptions>, IConfigurable<MvcFaultDescriptorOptions>, IExceptionFilter, IFilterMetadata

Inheritance

object

Configurable<MvcFaultDescriptorOptions>

FaultDescriptorFilter

Implements

IConfigurable<MvcFaultDescriptorOptions>

IExceptionFilter

IFilterMetadata

Inherited Members

Configurable<MvcFaultDescriptorOptions>.Options

Examples

The following example creates directly from configured packet-local options.

using System;
using Cuemon.AspNetCore.Diagnostics;
using Cuemon.AspNetCore.Mvc.Filters.Diagnostics;
using Cuemon.Diagnostics;
using Microsoft.Extensions.Options;

namespace MyApp.Examples;

public static class FaultDescriptorFilterExample
{
    public static void Demonstrate()
    {
        var options = Options.Create(new MvcFaultDescriptorOptions
        {
            MarkExceptionHandled = true,
            FaultDescriptor = PreferredFaultDescriptor.ProblemDetails,
            SensitivityDetails = FaultSensitivityDetails.Failure
        });

        var filter = new FaultDescriptorFilter(options);

        Console.WriteLine(filter.Options.MarkExceptionHandled);
        Console.WriteLine(filter.Options.FaultDescriptor);
    }
}

Constructors

FaultDescriptorFilter(IOptions<MvcFaultDescriptorOptions>)

Initializes a new instance of the FaultDescriptorFilter class.

public FaultDescriptorFilter(IOptions<MvcFaultDescriptorOptions> setup)

Parameters

setup IOptions<MvcFaultDescriptorOptions>

The MvcFaultDescriptorOptions which need to be configured.

Methods

OnException(ExceptionContext)

Called after an action has thrown an Exception.

public virtual void OnException(ExceptionContext context)

Parameters

context ExceptionContext

The ExceptionContext.

See Also

IExceptionFilter

ExceptionDescriptor

MvcFaultDescriptorOptions

RequestIdentifierMiddleware

CorrelationIdentifierMiddleware