TenantIncomingStep<TKey> class

Namespace: Tenantry.Pro.Rebus.Steps · Package: Tenantry.Pro.Rebus · API reference

Rebus incoming pipeline step that restores the tenant scope from a message header.

The step reads the tenantry-tenant-id header set by TenantOutgoingStep<TKey>, looks the tenant up in ITenantStore<TKey>, and activates a tenant scope for the duration of the handler's execution.

If no header is present, or the tenant cannot be found, the message is processed without a tenant scope.

public sealed class TenantIncomingStep<TKey> : IIncomingStep, IStep where TKey : IEquatable<TKey>, IParsable<TKey>

Type parametersCopy Anchor Link

• TKey: The tenant identifier type.

Implements IIncomingStep, IStep.

ConstructorsCopy Anchor Link

TenantIncomingStep(ITenantScope<TKey>, ITenantStoreAccessor<TKey>, MissingTenantBehavior, ILogger<TenantIncomingStep<TKey>>)Copy Anchor Link

Rebus incoming pipeline step that restores the tenant scope from a message header.

public TenantIncomingStep(ITenantScope<TKey> tenantScope, ITenantStoreAccessor<TKey> storeAccessor, MissingTenantBehavior onMissingTenant, ILogger<TenantIncomingStep<TKey>> logger)

Parameters:

• tenantScope ITenantScope<TKey>: Runs each handler under the message's tenant.
• storeAccessor ITenantStoreAccessor<TKey>: Looks up the message's tenant before it is handled.
• onMissingTenant MissingTenantBehavior: What to do with a message that carries no tenant, or one the store does not know.
• logger ILogger<TenantIncomingStep<TKey>>: Logs messages handled without a tenant.

The step reads the tenantry-tenant-id header set by TenantOutgoingStep<TKey>, looks the tenant up in ITenantStore<TKey>, and activates a tenant scope for the duration of the handler's execution.

If no header is present, or the tenant cannot be found, the message is processed without a tenant scope.

MethodsCopy Anchor Link

Process(IncomingStepContext, Func<Task>)Copy Anchor Link

Reads the tenant from the message's headers and runs the rest of the pipeline in that tenant's scope, or applies the missing-tenant behaviour when the message has no known tenant.

public Task Process(IncomingStepContext context, Func<Task> next)

Parameters:

• context IncomingStepContext: The incoming message's step context.
• next Func<Task>: Runs the rest of the incoming pipeline.

Returns: Task: A task that completes when the rest of the pipeline has run.