ITenantInvalidator<TKey> interface

Namespace: Tenantry · Package: Tenantry.Core · API reference

Clears everything Tenantry keeps for a tenant when the tenant changes: its cached copy (with CacheTenants) and what each ITenantInvalidationHandler<TKey> keeps, such as Tenantry.Caching's entries, cached responses and Tenantry.Options' values. Call it when a tenant is suspended, renamed or deleted, or its identifiers or settings change.

AddTenantry registers it as a singleton. What it clears is in memory in each instance of the application, or in a cache it shares: other instances keep their own copies until they expire or are invalidated there.

app.MapPost("/admin/tenants/{id}/suspend", async (Guid id, AppDbContext db, ITenantInvalidator<Guid> tenants, CancellationToken ct) =>
{
    await db.Tenants.Where(t => t.Id == id).ExecuteUpdateAsync(s => s.SetProperty(t => t.IsActive, false), ct);
    await tenants.InvalidateAsync(id, ct);
});

public interface ITenantInvalidator<in TKey> where TKey : IEquatable<TKey>, IParsable<TKey>

Type parametersCopy Anchor Link

• TKey: The tenant identifier type. See ITenantDescriptor<TKey> for constraints.

MethodsCopy Anchor Link

InvalidateAllAsync(CancellationToken)Copy Anchor Link

Clears what Tenantry keeps for every tenant.

ValueTask InvalidateAllAsync(CancellationToken cancellationToken = default)

Parameters:

• cancellationToken CancellationToken: Cancels the invalidation.

Returns: ValueTask: A task that completes when every handler has run.

Exceptions:

• Exception: A handler threw (several: AggregateException), after every handler ran.

InvalidateAsync(TKey, CancellationToken)Copy Anchor Link

Clears what Tenantry keeps for the tenant tenantId.

ValueTask InvalidateAsync(TKey tenantId, CancellationToken cancellationToken = default)

Parameters:

• tenantId TKey: The id of the tenant that changed.
• cancellationToken CancellationToken: Cancels the invalidation.

Returns: ValueTask: A task that completes when every handler has run.

Exceptions:

• ArgumentNullException: tenantId is null.
• ArgumentException: tenantId is one Tenantry reserves for "no tenant": the key type's default (Guid.Empty, 0) or an empty string.
• Exception: A handler threw (several: AggregateException), after every handler ran.