Tolitech.Application 1.0.0-preview.10

Tolitech.Application

Overview

Tolitech.Application is a modern .NET library providing essential interfaces and utilities for Clean Architecture-based applications, including Unit of Work, user context, request context, and advanced enumeration handling.

Features

• Unit of Work Interface (IUnitOfWork): Manages operations as a single transaction, including methods for saving changes, starting, committing, and rolling back transactions, and integration with Tolitech.Results.
• User Context (IUserContext): Provides information about the authenticated user, such as identifier, username, roles, and utility methods for identifier conversion.
• Request Context (IRequestContext): Supplies contextual information about the request, such as client IP and User-Agent.
• IsolationLevel Enumeration: Enum for controlling transaction isolation level, allowing specification of locking behavior.
• Enumeration Utilities:
  • EnumItem: Structure representing an enumeration item with value, name, and description.
  • EnumExtensions: Extension methods for retrieving descriptions and localized names of enums.
  • EnumUtility: Retrieves collections of EnumItem for any enum, with localization support.
• Clean Architecture Alignment: Promotes separation between application, domain, and infrastructure layers.
• Extensibility: Easily integrates with custom repositories and data sources.

Characteristics

• Designed for maintainability and scalability
• Integrates with Tolitech.Results for standardized operation results
• Easily testable and mockable for unit testing

Main Interfaces

IUnitOfWork

public interface IUnitOfWork : IDisposable
{
    Task<int> SaveChangesInTransactionAsync(CancellationToken cancellationToken);
    Task<int> SaveChangesAsync(CancellationToken cancellationToken);
    Task<int> SaveChangesAsync(bool publishDomainEvents, CancellationToken cancellationToken);
    Task BeginTransactionAsync(CancellationToken cancellationToken);
    Task BeginTransactionAsync(IsolationLevel isolationLevel, CancellationToken cancellationToken);
    Task CommitAsync(CancellationToken cancellationToken);
    Task RollbackAsync(CancellationToken cancellationToken);
    Task CommitOrRollbackAsync(Result result, CancellationToken cancellationToken);
}

IUserContext

public interface IUserContext
{
    bool IsAuthenticated { get; }
    string? UserIdentifier { get; }
    string? Username { get; }
    IList<string> GetRoleNames();
    T? GetUserId<T>();
}

IRequestContext

public interface IRequestContext
{
    IPAddress? RemoteIpAddress { get; }
    StringValues? UserAgent { get; }
}

IsolationLevel Enumeration

Controls transaction isolation level:

public enum IsolationLevel
{
    Unspecified = -1,
    Chaos = 16,
    ReadUncommitted = 256,
    ReadCommitted = 4096,
    RepeatableRead = 65536,
    Serializable = 1048576,
    Snapshot = 16777216,
}

Enumeration Utilities

• EnumItem: Structure representing an enumeration item with value, name, and description.
• EnumExtensions: Extension methods for retrieving descriptions and localized names of enums.
• EnumUtility: Retrieves collections of EnumItem for any enum, with localization support.

Usage Example

// Retrieving metadata from an enumeration
var items = EnumUtility.GetEnumValues<IsolationLevel>();
foreach (var item in items)
{
    Console.WriteLine($"Value: {item.Value}, Name: {item.Name}, Description: {item.Description}");
}

How to Integrate

1. Reference Tolitech.Application in your project.
2. Implement the interfaces as needed (IUnitOfWork, IUserContext, IRequestContext).
3. Use the enumeration utilities to display or manipulate enums in advanced scenarios.
4. Use transaction methods to ensure consistency and atomicity.

Summary

Tolitech.Application streamlines transactional management, user/request context, and enumeration handling, enforcing separation of concerns and making it an essential building block for modern .NET applications.