Franz.Common.Headers 3.0.0

dotnet add package Franz.Common.Headers --version 3.0.0
                    
NuGet\Install-Package Franz.Common.Headers -Version 3.0.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Franz.Common.Headers" Version="3.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Franz.Common.Headers" Version="3.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Franz.Common.Headers" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Franz.Common.Headers --version 3.0.0
                    
#r "nuget: Franz.Common.Headers, 3.0.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Franz.Common.Headers@3.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Franz.Common.Headers&version=3.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Franz.Common.Headers&version=3.0.0
                    
Install as a Cake Tool

Franz.Common.Headers

Transport-agnostic header contracts and configuration for propagating selected headers.

Overview

Transport-agnostic header contracts and configuration for propagating selected headers.

Installation

dotnet add package Franz.Common.Headers

Header context contract

IHeaderContextAccessor exposes headers in a serialization-friendly representation:

public interface IHeaderContextAccessor
{
    IDictionary<string, string[]> ListAll();
    bool TryGetValue(string key, out string[]? value);
    bool TryGetValue<T>(string key, out T value);
}

The raw overload returns all values as a string array. The generic overload attempts to deserialize the value to the requested type; consumers should handle a failed conversion explicitly. The interface is transport-agnostic and does not depend on ASP.NET Core's StringValues.

Header propagation registration

The package exposes AddHeaderPropagation(HeaderPropagationSetting) in Franz.Common.Headers.Extensions.

using Franz.Common.Headers;
using Franz.Common.Headers.Extensions;

var setting = new HeaderPropagationSetting();
// Configure the setting's propagation entries for the application.
services.AddHeaderPropagation(setting);

Registration adds IHeaderPropagationRegistrer using a no-duplicate singleton registration and registers the supplied setting as IHeaderPropagationSetting. The settings instance is registered as a singleton; configure it fully before registration and do not mutate it concurrently at runtime.

Configuration model

  • HeaderPropagationOptions.Headers is an initialized collection of header names.
  • HeaderPropagationSetting is the concrete configuration supplied at registration.
  • IHeaderPropagationSetting and IHeaderPropagationRegistrer define the contracts used by the propagation integration.
  • HeaderConstants centralizes header-name constants.

This package does not itself add ASP.NET Core middleware or configure an IHttpClientFactory pipeline. HTTP-specific integration belongs to the HTTP packages.

Security and correctness

Propagate only headers explicitly required by downstream services. Never blindly forward credentials, cookies, or untrusted identity claims across trust boundaries. Normalize header-name handling consistently and define behavior for missing, repeated, and malformed values.

License

MIT. See LICENSE.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (10)

Showing the top 5 NuGet packages that depend on Franz.Common.Headers:

Package Downloads
Franz.Common.Messaging

Shared utility library for the Franz Framework.

Franz.Common.Http.Headers

Shared utility library for the Franz Framework.

Franz.Common.Http.MultiTenancy

Shared utility library for the Franz Framework.

Franz.Common.Messaging.MultiTenancy

Shared utility library for the Franz Framework.

Franz.Common.Messaging.Identity

Shared utility library for the Franz Framework.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
3.0.0 288 11/10/2026
2.3.4 604 11/1/2026
2.3.3 547 10/28/2026
2.3.2 348 10/27/2026
2.3.1 405 10/26/2026
2.3.0 515 7/21/2026
2.2.19 391 7/19/2026
2.2.18 391 7/19/2026
2.2.17 1,045 7/12/2026
2.2.16 407 7/2/2026
2.2.15 392 6/29/2026
2.2.14 410 6/29/2026
2.2.13 400 6/29/2026
2.2.12 397 6/28/2026
2.2.11 404 6/28/2026
2.2.10 398 6/28/2026
2.2.9 394 6/28/2026
2.2.8 389 6/28/2026
2.2.7 405 6/7/2026
2.2.6 398 6/6/2026
Loading failed