Class ExceptionMappingMiddleware
- Namespace
- Excalibur.Dispatch.Middleware.ErrorHandling
- Assembly
- Excalibur.Dispatch.dll
Middleware that catches exceptions from downstream handlers and converts them to problem details.
[AppliesTo(MessageKinds.All)]
public sealed class ExceptionMappingMiddleware : IDispatchMiddleware
- Inheritance
-
ExceptionMappingMiddleware
- Implements
- Inherited Members
- Extension Methods
Remarks
This middleware intercepts exceptions thrown during message processing and uses the IExceptionMapper service to convert them to RFC 7807 Problem Details format.
Important: OperationCanceledException is never mapped and is always re-thrown to allow proper cancellation propagation.
Constructors
ExceptionMappingMiddleware(IExceptionMapper, ILogger<ExceptionMappingMiddleware>)
Middleware that catches exceptions from downstream handlers and converts them to problem details.
public ExceptionMappingMiddleware(IExceptionMapper mapper, ILogger<ExceptionMappingMiddleware> logger)
Parameters
mapperIExceptionMapperThe exception mapper service.
loggerILogger<ExceptionMappingMiddleware>The logger instance.
Remarks
This middleware intercepts exceptions thrown during message processing and uses the IExceptionMapper service to convert them to RFC 7807 Problem Details format.
Important: OperationCanceledException is never mapped and is always re-thrown to allow proper cancellation propagation.
Properties
Stage
Gets the pipeline stage where this middleware should execute.
public DispatchMiddlewareStage? Stage { get; }
Property Value
- DispatchMiddlewareStage?
The pipeline stage for this middleware.
Remarks
The stage determines the execution order of middleware in the pipeline. If null, the middleware will be registered at the end of the pipeline. Stages are processed in numeric order, allowing fine-grained control over middleware execution sequence.
Methods
InvokeAsync(IDispatchMessage, IMessageContext, DispatchRequestDelegate, CancellationToken)
Processes the message within the middleware pipeline.
public ValueTask<IMessageResult> InvokeAsync(IDispatchMessage message, IMessageContext context, DispatchRequestDelegate nextDelegate, CancellationToken cancellationToken)
Parameters
messageIDispatchMessageThe message being processed.
contextIMessageContextThe message context containing metadata and processing state.
nextDelegateDispatchRequestDelegateThe delegate to invoke the next middleware in the pipeline.
cancellationTokenCancellationTokenThe cancellation token to observe.
Returns
- ValueTask<IMessageResult>
A ValueTask<TResult> representing the result of message processing, potentially modified by this middleware. ValueTask can avoid allocating a Task for a synchronously completed result; other dispatch work can still allocate.
Remarks
Implementations can execute logic before calling nextDelegate, after calling it, or both. To short-circuit the pipeline, don't call nextDelegate and return an appropriate result. The context can be used to share data between middleware components. Respect the cancellation token to support timeouts and graceful shutdown.
Exceptions
- ArgumentNullException
Thrown when message, context, or nextDelegate is null.
- OperationCanceledException
Thrown when the operation is cancelled.