Class MiddlewarePresetExtensions
- Namespace
- Microsoft.Extensions.DependencyInjection
- Assembly
- Excalibur.Dispatch.dll
Extension methods for adding middleware presets and fine-grained stacks to the dispatch pipeline.
public static class MiddlewarePresetExtensions
- Inheritance
-
MiddlewarePresetExtensions
- Inherited Members
Methods
UseDevelopmentMiddleware(IDispatchBuilder)
Adds development middleware preset: logging (verbose), validation, exception mapping.
public static IDispatchBuilder UseDevelopmentMiddleware(this IDispatchBuilder builder)
Parameters
builderIDispatchBuilderThe dispatch builder.
Returns
- IDispatchBuilder
The builder for fluent configuration.
Remarks
This preset is optimized for development scenarios with verbose logging and detailed error information. Not recommended for production due to potential performance and security implications.
Middleware included:
- LoggingMiddleware (Debug level)
- ValidationMiddleware
- ExceptionMappingMiddleware
UseFullMiddleware(IDispatchBuilder)
Adds full middleware preset: logging, validation, retry, exception mapping.
public static IDispatchBuilder UseFullMiddleware(this IDispatchBuilder builder)
Parameters
builderIDispatchBuilderThe dispatch builder.
Returns
- IDispatchBuilder
The builder for fluent configuration.
Remarks
This preset includes core middleware with sensible defaults. Use when you want comprehensive error handling and resilience.
Middleware included (in pipeline order):
- LoggingMiddleware (Information level, completion only)
- ValidationMiddleware
- RetryMiddleware
- ExceptionMappingMiddleware
For full observability (metrics and tracing), pair with
AddDispatchObservability() from the Excalibur.Dispatch.Observability package.
UseProductionMiddleware(IDispatchBuilder)
Adds production middleware preset: retry and exception mapping.
public static IDispatchBuilder UseProductionMiddleware(this IDispatchBuilder builder)
Parameters
builderIDispatchBuilderThe dispatch builder.
Returns
- IDispatchBuilder
The builder for fluent configuration.
Remarks
This preset provides core resilience and error handling for production scenarios.
Middleware included:
- RetryMiddleware
- ExceptionMappingMiddleware
For full production observability (metrics and tracing), pair with
AddDispatchObservability() from the Excalibur.Dispatch.Observability package.
UseResilienceStack(IDispatchBuilder)
Adds the resilience middleware stack: timeout, retry, and circuit breaker.
public static IDispatchBuilder UseResilienceStack(this IDispatchBuilder builder)
Parameters
builderIDispatchBuilderThe dispatch builder.
Returns
- IDispatchBuilder
The builder for fluent configuration.
Remarks
Composes the following middleware in order:
- TimeoutMiddleware -- enforces timeout (outermost)
- RetryMiddleware -- retries transient failures
- CircuitBreakerMiddleware -- protects downstream from cascading failure
UseSecurityStack(IDispatchBuilder)
Adds the security middleware stack: authentication, authorization, and tenant identity.
public static IDispatchBuilder UseSecurityStack(this IDispatchBuilder builder)
Parameters
builderIDispatchBuilderThe dispatch builder.
Returns
- IDispatchBuilder
The builder for fluent configuration.
Remarks
Composes the following middleware in order:
- AuthenticationMiddleware -- validates caller identity
- AuthorizationMiddleware -- enforces permissions
- TenantIdentityMiddleware -- resolves tenant context
UseValidationStack(IDispatchBuilder)
Adds the validation middleware stack: validation and exception mapping.
public static IDispatchBuilder UseValidationStack(this IDispatchBuilder builder)
Parameters
builderIDispatchBuilderThe dispatch builder.
Returns
- IDispatchBuilder
The builder for fluent configuration.
Remarks
Composes the following middleware in order:
- ValidationMiddleware -- validates message payloads
- ExceptionMappingMiddleware -- maps exceptions to structured results
WithDefaults(IDispatchBuilder)
Applies sensible default middleware to the dispatch pipeline.
public static IDispatchBuilder WithDefaults(this IDispatchBuilder builder)
Parameters
builderIDispatchBuilderThe dispatch builder.
Returns
- IDispatchBuilder
The builder for fluent configuration.
Remarks
This method applies the recommended default middleware stack for most applications:
- ValidationMiddleware -- validates message payloads (stage: Validation)
- LoggingMiddleware -- audit logging (stage: Logging)
- TimeoutMiddleware -- pipeline-level timeout (stage: PreProcessing)
- RetryMiddleware -- retries transient failures (stage: ErrorHandling)
- ExceptionMappingMiddleware -- maps exceptions to structured results (stage: PostProcessing)
For additional security middleware, chain UseSecurityStack(IDispatchBuilder).
For observability (metrics/tracing), use AddDispatchObservability() from the Observability package.