Indiko.Blocks.Configuration.Abstractions 2.1.2

Indiko.Blocks.Configuration.Abstractions

Core abstractions for configuration management in the Indiko framework, providing interfaces and factories for building custom configuration sources.

Overview

This package defines the core contracts and base types for implementing configuration blocks. It provides the foundation for loading configuration from various sources like files, environment variables, or external configuration stores.

Features

• IConfigurationBlock: Marker interface for configuration block implementations
• IBlockConfigurationBuilder: Interface for building configuration blocks
• ConfigurationBuilderFactory: Factory for creating configuration builders
• Constants: Common configuration-related constants
• Extensibility: Foundation for custom configuration sources

Installation

dotnet add package Indiko.Blocks.Configuration.Abstractions

Key Components

IConfigurationBlock

Marker interface identifying configuration blocks in the Indiko Blocks system.

public interface IConfigurationBlock : IBlock
{
    // Marker interface for configuration blocks
}

IBlockConfigurationBuilder

Interface for building configuration blocks.

public interface IBlockConfigurationBuilder
{
    IConfigurationBlock Build();
}

ConfigurationBuilderFactory

Factory class for creating configuration builder instances.

var factory = new ConfigurationBuilderFactory();
var builder = factory.CreateBuilder<MyConfigurationBuilder>();
var block = builder.Build();

Usage Example

Implementing a Custom Configuration Block

using Indiko.Blocks.Configuration.Abstractions.Interfaces;
using Indiko.Blocks.Common.Abstractions;

// Define the interface
public interface IMyConfigurationBlock : IConfigurationBlock
{
}

// Implement the builder
public class MyConfigurationBuilder : IBlockConfigurationBuilder
{
    public IConfigurationBlock Build()
    {
        return new MyConfigurationBlock();
    }
}

// Implement the block
public class MyConfigurationBlock : BlockBase, IMyConfigurationBlock
{
    public MyConfigurationBlock(IConfiguration configuration, ILogger logger) 
        : base(configuration, logger)
    {
    }

    public override void ConfigureServices(IServiceCollection services)
    {
        // Load configuration from your source
        services.Configure<MySettings>(configuration.GetSection("MySettings"));
        
        base.ConfigureServices(services);
    }
}

Using the Factory

var factory = new ConfigurationBuilderFactory();
var builder = factory.CreateBuilder<MyConfigurationBuilder>();
var configBlock = builder.Build();

Architecture

Configuration blocks in the Indiko framework:

1. Load Early: Configuration blocks typically have BlockLoadOrder(-1) to load before other blocks
2. Extend IConfiguration: Add configuration sources to the ASP.NET Core configuration system
3. Type-Safe Settings: Bind configuration to strongly-typed settings classes
4. Hot Reload: Support configuration changes without restarting the application

Integration with Blocks System

Configuration blocks integrate seamlessly with the Indiko Blocks management system:

// Configuration blocks are automatically discovered and loaded
BlockManager.ConfigureBlock<IConfigurationBlock>(
    block => block.ConfigureServices(services), 
    configuration, 
    logger
);

Block Load Order

Configuration blocks typically load before other blocks:

[BlockLoadOrder(-1)]  // Load early in the lifecycle
public class MyConfigurationBlock : BlockBase, IConfigurationBlock
{
    // Implementation
}

Best Practices

1. Load Order: Use BlockLoadOrder(-1) to ensure configuration loads early
2. Validation: Validate configuration settings during startup
3. Defaults: Provide sensible default values
4. Documentation: Document required configuration sections
5. Error Handling: Provide clear error messages for missing or invalid configuration

Target Framework

• .NET 10

Dependencies

• Indiko.Blocks.Common.Abstractions
• Microsoft.Extensions.Configuration.Abstractions

License

See LICENSE file in the repository root.

Related Packages

• Indiko.Blocks.Configuration.AppSettings - Load configuration from appsettings.json
• Indiko.Blocks.Configuration.Consul - Load configuration from HashiCorp Consul
• Indiko.Blocks.Common.Management - Block management system