Franz.Common.Messaging.Identity 1.6.19

Franz.Common.Messaging.Identity

A library within the Franz Framework designed to integrate identity management with messaging workflows. This package provides tools for handling authorization contexts, building identity-based message structures, and ensuring seamless communication between identity and messaging services.

Features

• Identity Context Integration:
  • IdentityContextAccessor for managing identity-specific data within messaging workflows.
• Authorization Message Builder:
  • AuthorizationMessageBuilder for constructing messages with embedded authorization data.
• Service Registration:
  • ServiceCollectionExtensions for simplifying the setup of identity-aware messaging services.

Version Information

• Current Version: 1.6.19
• Part of the private Franz Framework ecosystem.

Dependencies

This package relies on:

• Franz.Common.Headers: For managing and propagating headers in messaging workflows.
• Franz.Common.Identity: Core utilities for identity and authorization management.
• Franz.Common.Messaging: Provides foundational messaging utilities and abstractions.

Installation

From Private Azure Feed

Since this package is hosted privately, configure your NuGet client:

dotnet nuget add source "https://your-private-feed-url" \
  --name "AzurePrivateFeed" \
  --username "YourAzureUsername" \
  --password "YourAzurePassword" \
  --store-password-in-clear-text

Install the package:

dotnet add package Franz.Common.Messaging.Identity  

Usage

1. Access Identity Context in Messaging

Use IdentityContextAccessor to retrieve identity-related data in messaging workflows:

using Franz.Common.Messaging.Identity;

public class MyService
{
    private readonly IdentityContextAccessor _identityContextAccessor;

    public MyService(IdentityContextAccessor identityContextAccessor)
    {
        _identityContextAccessor = identityContextAccessor;
    }

    public string GetUserId()
    {
        return _identityContextAccessor.User?.FindFirst("sub")?.Value;
    }
}

2. Build Authorization Messages

Leverage AuthorizationMessageBuilder to create messages with embedded authorization data:

using Franz.Common.Messaging.Identity;

var builder = new AuthorizationMessageBuilder();
var message = builder.WithUserId("12345")
                     .WithRoles(new[] { "Admin", "User" })
                     .Build();

3. Register Identity-Aware Messaging Services

Use ServiceCollectionExtensions to register identity-aware messaging components:

using Franz.Common.Messaging.Identity.Extensions;

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMessagingWithIdentity();
    }
}

Integration with Franz Framework

The Franz.Common.Messaging.Identity package integrates seamlessly with:

• Franz.Common.Messaging: Provides messaging abstractions and utilities.
• Franz.Common.Identity: Extends identity and authorization support into messaging workflows.
• Franz.Common.Headers: Facilitates header management for identity-based messages.

Contributing

This package is part of a private framework. Contributions are limited to the internal development team. If you have access, follow these steps:

1. Clone the repository. @ https://github.com/bestacio89/Franz.Common/
2. Create a feature branch.
3. Submit a pull request for review.

License

This library is licensed under the MIT License. See the LICENSE file for more details.

Changelog

Version 1.2.65

• Introduced IdentityContextAccessor for managing identity contexts in messaging workflows.
• Added AuthorizationMessageBuilder for constructing identity-aware messages.
• Integrated ServiceCollectionExtensions for simplified registration of identity-aware messaging services.

Version 1.3

• Upgraded to .NET 9.0.8
• Added new features and improvements
• Separated business concepts from mediator concepts
• Now compatible with both the in-house mediator and MediatR