Table of Contents

Interface ISchemaRegistryConnectionBuilder

Namespace
Excalibur.Dispatch.Transport.Kafka
Assembly
Excalibur.Dispatch.Transport.Kafka.dll

Defines connection configuration methods for a Schema Registry builder.

public interface ISchemaRegistryConnectionBuilder
Extension Methods

Methods

BasicAuth(string, string)

Configures basic authentication credentials.

IConfluentSchemaRegistryBuilder BasicAuth(string username, string password)

Parameters

username string

The username.

password string

The password.

Returns

IConfluentSchemaRegistryBuilder

The builder for fluent chaining.

Remarks

Basic auth is sent as a Base64-encoded header. Use SSL/TLS to protect credentials in transit.

Exceptions

ArgumentException

Thrown when username or password is null or whitespace.

ConfigureSsl(Action<ISchemaRegistrySslBuilder>)

Configures SSL/TLS settings for the Schema Registry connection.

IConfluentSchemaRegistryBuilder ConfigureSsl(Action<ISchemaRegistrySslBuilder> configure)

Parameters

configure Action<ISchemaRegistrySslBuilder>

The SSL configuration action.

Returns

IConfluentSchemaRegistryBuilder

The builder for fluent chaining.

Exceptions

ArgumentNullException

Thrown when configure is null.

SchemaRegistryUrl(string)

Sets the Schema Registry URL.

IConfluentSchemaRegistryBuilder SchemaRegistryUrl(string url)

Parameters

url string

The Schema Registry URL (e.g., "http://localhost:8081").

Returns

IConfluentSchemaRegistryBuilder

The builder for fluent chaining.

Remarks

For high availability, use SchemaRegistryUrls(params string[]) to specify multiple URLs.

Exceptions

ArgumentException

Thrown when url is null or whitespace.

SchemaRegistryUrls(params string[])

Sets multiple Schema Registry URLs for high availability.

IConfluentSchemaRegistryBuilder SchemaRegistryUrls(params string[] urls)

Parameters

urls string[]

The Schema Registry URLs.

Returns

IConfluentSchemaRegistryBuilder

The builder for fluent chaining.

Remarks

The client will attempt to connect to URLs in order, failing over to the next if the current URL is unavailable.

Exceptions

ArgumentException

Thrown when urls is null or empty.