NBB.MultiTenancy.Abstractions

NBB.MultiTenancy.Abstractions

This package provides some abstractions for multi-tenant projects like

• Tenant - data structure that stores tenant information (eg. id, name, code)
• Tenant context - holds and provides access to the current tenant
• Tenant repository - provides functionality to retrieve tenant information from a store
• 'Tenant Configuration' - provides tenant specific configuration
• Tenancy options - configuration options for multi-tenant applications

NuGet install

dotnet add package NBB.MultiTenancy.Abstractions

Tenant Configuration

Abstractions:

The ITennantConfiguration derives from the IConfiguration so that you can use all the well known Microsoft.Extensions.Configuration apis

namespace NBB.MultiTenancy.Abstractions.Configuration;
public interface ITenantConfiguration : IConfiguration
{
}

Extensions:

The GetConnectionString extension:

public static string GetConnectionString(this ITenantConfiguration config, string name)

reads connection string configuration from:

• separate connection info segments:

   "ConnectionStrings": {
      "MyDatabase": {
        "Server": "myserver,3342",
        "Database": "mydb",
        "UserName": "myuser",
        "Password": "mypass",
        "OtherParams": "MultipleActiveResultSets=true"
      }

• or standalone string:

   "ConnectionStrings": {
      "MyDatabase": "Server=myserver,3342;Database=mydb;User Id=myuser;Password=mypass;MultipleActiveResultSets=true"

The GetValue<T> extension reads values or complex objects from configuration:

/// <summary>
    /// Extracts the value with the specified key and converts it to type T.
    /// or
    /// Attempts to bind the configuration instance to a new instance of type T.
    /// If this configuration section has a value, that will be used.
    /// Otherwise binding by matching property names against configuration keys recursively.
    /// </summary>
    public static T GetValue<T>(this ITenantConfiguration config, string key)
```csharp

### Service registration:
```csharp
services.AddDefaultTenantConfiguration();

The default tenant configuration uses:

• the MultiTenancy configuration section to read tenant specific configuration for the current tenant context, when TenancyType is set to "MultiTenant"
• the default configuration root when TenancyType is set to "MonoTenant"

The MultiTenancy:Defaults section provides common tenant configuration that will be merged with tenant specific configurations.