Class TenantIdAccessor

Namespace

Cratis.Arc.Tenancy

Assembly

Cratis.Arc.Core.dll

Represents the current tenant accessor and explicit ITenantScope.

[Singleton]
public class TenantIdAccessor : ITenantIdAccessor, ITenantScope

Inheritance

object

TenantIdAccessor

Implements

ITenantIdAccessor

ITenantScope

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

MethodCalls.CallGenericMethod<TOut, T>(T, Expression<Func<T, Func<TOut>>>, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1>(T, Expression<Func<T, Func<T1, TOut>>>, T1, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2>(T, Expression<Func<T, Func<T1, T2, TOut>>>, T1, T2, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2, T3>(T, Expression<Func<T, Func<T1, T2, T3, TOut>>>, T1, T2, T3, params Type[])

ConverterExtensions.ConvertTo(object, Type)

ConceptExtensions.GetConceptValue(object)

ConceptExtensions.IsConcept(object)

JsonValueExtensions.ToJsonValue(object?)

ObservableExtensions.InvokeAndWrapWithSubject<TResult>(object, Func<CancellationToken, IObservable<TResult>>)

ObservableExtensions.InvokeAndWrapWithTransformSubject<TResult, TSource>(object, Func<CancellationToken, IObservable<TSource>>, Func<TSource, TResult>)

Constructors

TenantIdAccessor(ITenantIdResolver)

Represents the current tenant accessor and explicit ITenantScope.

public TenantIdAccessor(ITenantIdResolver tenantIdResolver)

Parameters

tenantIdResolver ITenantIdResolver

The ITenantIdResolver to use for resolving tenant IDs.

Properties

Current

Gets the current TenantId.

public TenantId Current { get; }

Property Value

TenantId

Methods

Begin(TenantId)

Selects a tenant until the returned scope is disposed, including during an HTTP request.

public IDisposable Begin(TenantId tenant)

Parameters

tenant TenantId

The tenant to select.

Returns

IDisposable

A scope that restores the previously selected tenant on disposal. Disposal is idempotent; disposing an outer scope before an inner scope leaves the inner tenant selected, then restores resolution when the inner scope ends.

Remarks

A selected tenant takes precedence over the configured resolver, but does not authorize access to that tenant. Resolve tenant-scoped dependencies in a DI scope created after beginning this tenant scope.

Exceptions

ArgumentNullException

The tenant is null.

ArgumentException

The tenant ID is empty or whitespace.

ExplicitTenantScopeRequiresArcAccessor

The effective tenant accessor does not support explicit scopes (raised when resolving this service).