Skip to content

api-reference-registration.md

Latest commit

 

History

History
71 lines (52 loc) · 5.49 KB

api-reference-registration.md

File metadata and controls

71 lines (52 loc) · 5.49 KB
Raw

API Reference: Registration

This document covers the dependency-injection entry point and the fluent registration builders. The entry point lives in the Microsoft.Extensions.DependencyInjection namespace so it is discoverable on IServiceCollection; the builders live in D20Tek.Vertically.Registration.

See the API Reference hub for the other reference documents.

Table of Contents

DI Registration Methods

The following extension method is defined in the ServiceCollectionExtensions static class and is available on any IServiceCollection instance.

Method Return Type Description
AddVertically(Action<IVerticallyBuilder> configure) IServiceCollection Registers D20Tek.Vertically handlers, validators, and pipeline behaviors. Configure registration through the supplied callback (for example builder.Handlers.RegisterFromAssembly(...) and builder.Behaviors.AddLogging()). Throws ArgumentNullException when services or configure is null.

IVerticallyBuilder

The root fluent builder passed to the AddVertically callback. It exposes grouped sub-builders plus direct access to the underlying service collection for slice-specific registrations.

Member Type Description
Services IServiceCollection The underlying service collection, for slice-specific service registrations.
Handlers IHandlerRegistrationBuilder Handler and validator registration (explicit, scanning, and feature discovery).
Behaviors IBehaviorRegistrationBuilder Global (all-handler) behavior configuration, applied in registration order.
ForCommand<TCommand>() IHandlerBehaviorScope Opens a per-handler behavior scope for the given command request type. Behaviors added here sit closest to the handler (innermost) by default.
ForQuery<TQuery>() IHandlerBehaviorScope Opens a per-handler behavior scope for the given query request type. Behaviors added here sit closest to the handler (innermost) by default.

IHandlerRegistrationBuilder

Fluent sub-builder for registering handlers and validators, either explicitly by type, by assembly scanning, or via IFeature discovery. Handlers and validators are registered with a Scoped lifetime. All methods return the same builder for chaining.

Method Type Constraint Description
AddCommandHandler<THandler>() THandler : class Registers a specific command handler implementing ICommandHandler<TCommand, TResult>.
AddQueryHandler<THandler>() THandler : class Registers a specific query handler implementing IQueryHandler<TQuery, TResult>.
AddValidator<TValidator>() TValidator : class Registers a specific validator implementing IValidator<T> or IAsyncValidator<T>.
RegisterFromAssembly(Assembly assembly) - Scans the given assembly, discovering IFeature implementers first (running their registration), then registering any remaining handlers and validators found.
RegisterFromAssemblies(params Assembly[] assemblies) - Scans multiple assemblies. See RegisterFromAssembly.

IBehaviorRegistrationBuilder

Fluent sub-builder for configuring global (all-handler) pipeline behaviors. Behaviors are applied as decorators around handlers in registration order (outermost first) and are resolved as singletons. All methods return the same builder for chaining.

Method Description
Add(Type openGenericBehaviorType) Adds a global custom behavior by its open generic type definition (for example typeof(MyBehavior<,>)). The type must implement IPipelineBehavior<TRequest, TResult>.
AddLogging() Adds the built-in logging behavior (request name and outcome).
AddTiming() Adds the built-in timing behavior (elapsed time around the handler).
AddExceptionToResult() Adds the built-in behavior that maps unexpected exceptions to a failure result.
AddValidation() Adds the built-in validation behavior that runs registered validators and short-circuits on validation errors.

IHandlerBehaviorScope

Fluent scope for configuring behaviors on a single handler, opened via ForCommand<TCommand>() or ForQuery<TQuery>(). Behaviors added here sit closest to the handler (innermost) by default, inside any global behaviors. The placement modifiers apply to the next behavior added. All methods return the same scope for chaining.

Method Description
Add(Type openGenericBehaviorType) Adds a per-handler custom behavior by its open generic type definition, using the currently pending placement (innermost by default). The type must implement IPipelineBehavior<TRequest, TResult>.
AddLogging() Adds the built-in logging behavior for this handler.
AddTiming() Adds the built-in timing behavior for this handler.
AddExceptionToResult() Adds the built-in exception-to-result behavior for this handler.
AddValidation() Adds the built-in validation behavior for this handler.
AtOutermost() Places the next added behavior outside all existing behaviors for this handler (runs first on the way in).
InsertBefore(Type anchorOpenGenericBehaviorType) Places the next added behavior immediately outside the given anchor behavior in this handler's pipeline.