Class HttpConnectionResolver

Namespace: Cratis.Arc.Connections

Assembly: Cratis.Arc.Core.dll

Represents an IConnectionResolver that resolves by calling an HTTP endpoint.

[IgnoreConvention]
public class HttpConnectionResolver : IConnectionResolver

Inheritance: object

HttpConnectionResolver

Implements: IConnectionResolver

Inherited Members: object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods: MethodCalls.CallGenericMethod<TOut, T>(T, Expression<Func<T, Func<TOut>>>, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1>(T, Expression<Func<T, Func<T1, TOut>>>, T1, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2>(T, Expression<Func<T, Func<T1, T2, TOut>>>, T1, T2, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2, T3>(T, Expression<Func<T, Func<T1, T2, T3, TOut>>>, T1, T2, T3, params Type[])

ConverterExtensions.ConvertTo(object, Type)

ConceptExtensions.GetConceptValue(object)

ConceptExtensions.IsConcept(object)

JsonValueExtensions.ToJsonValue(object?)

ObservableExtensions.InvokeAndWrapWithSubject<TResult>(object, Func<CancellationToken, IObservable<TResult>>)

ObservableExtensions.InvokeAndWrapWithTransformSubject<TResult, TSource>(object, Func<CancellationToken, IObservable<TSource>>, Func<TSource, TResult>)

Remarks

The request is posted as JSON — { "storage": "SqlServer", "purpose": "Runtime", "scope": { "tenant": "acme" } } — and the endpoint answers with a ResolvedConnection as JSON, where every property is optional. An endpoint answering 204 No Content leaves the configured connection as it is. Any other unsuccessful status fails.

With Authentication configured, every request carries Authorization: Bearer with a cached token. When the endpoint answers 401 Unauthorized, the token is dropped and the request is sent once more with a fresh one.

The answer typically carries credentials. It is never logged or persisted, and neither are bearer tokens.

Constructors

HttpConnectionResolver(HttpConnectionResolverOptions, HttpClient)

Initializes a new instance of the HttpConnectionResolver class.

public HttpConnectionResolver(HttpConnectionResolverOptions options, HttpClient httpClient)

Parameters

options HttpConnectionResolverOptions: The HttpConnectionResolverOptions.
httpClient HttpClient: The HttpClient to call the endpoint with.

Remarks

Supports ClientCredentials authentication, with tokens requested through httpClient.

Exceptions

HttpConnectionResolverEndpointNotConfigured: No endpoint is configured.
HttpConnectionResolverAuthorizationHeaderConflict: Both an Authorization header and authentication are configured.
HttpConnectionResolverAuthenticationNotSupported: No provider can provide tokens for the configured authentication.

HttpConnectionResolver(HttpConnectionResolverOptions, HttpClient, IEnumerable<IConnectionResolverAccessTokenProvider>, TimeProvider)

Represents an IConnectionResolver that resolves by calling an HTTP endpoint.

public HttpConnectionResolver(HttpConnectionResolverOptions options, HttpClient httpClient, IEnumerable<IConnectionResolverAccessTokenProvider> accessTokenProviders, TimeProvider timeProvider)

Parameters

options HttpConnectionResolverOptions: The HttpConnectionResolverOptions.
httpClient HttpClient: The HttpClient to call the endpoint with.
accessTokenProviders IEnumerable<IConnectionResolverAccessTokenProvider>: The IConnectionResolverAccessTokenProvider instances to choose from when authentication is configured. The first that can provide is used.
timeProvider TimeProvider: The TimeProvider token expiry is checked against.

Remarks

The answer typically carries credentials. It is never logged or persisted, and neither are bearer tokens.

Exceptions

HttpConnectionResolverEndpointNotConfigured: No endpoint is configured.
HttpConnectionResolverAuthorizationHeaderConflict: Both an Authorization header and authentication are configured.
HttpConnectionResolverAuthenticationNotSupported: No provider can provide tokens for the configured authentication.

Methods

Resolve(ConnectionRequest, CancellationToken)

Resolve a connection.

public Task<ResolvedConnection> Resolve(ConnectionRequest request, CancellationToken cancellationToken = default)

Parameters

request ConnectionRequest: The ConnectionRequest to resolve for.
cancellationToken CancellationToken: Optional CancellationToken.

Returns

Task<ResolvedConnection>: The ResolvedConnection. Use Unchanged to keep the configured connection.

Exceptions

HttpConnectionResolverEndpointNotConfigured: No endpoint is configured.
HttpConnectionResolverAuthorizationHeaderConflict: Both an Authorization header and authentication are configured.
HttpConnectionResolverAuthenticationNotSupported: No provider can provide tokens for the configured authentication.