TypedRest for .NET 1.3.5
build type-safe fluent-style REST API clients
TypedRest.Endpoints.Generic.CachingEndpointBase Class Reference

Base class for building endpoints that use ETags and Last-Modified timestamps for caching and to avoid lost updates. More...

Inheritance diagram for TypedRest.Endpoints.Generic.CachingEndpointBase:
TypedRest.Endpoints.EndpointBase TypedRest.Endpoints.ICachingEndpoint TypedRest.Endpoints.IEndpoint TypedRest.Endpoints.IEndpoint TypedRest.Endpoints.Generic.CollectionEndpoint< TEntity, TElementEndpoint > TypedRest.Endpoints.Generic.ElementEndpoint< TEntity > TypedRest.Endpoints.Reactive.StreamingCollectionEndpoint< TEntity, TElementEndpoint > TypedRest.Endpoints.Reactive.PollingEndpoint< TEntity >

Protected Member Functions

 CachingEndpointBase (IEndpoint referrer, Uri relativeUri)
 Creates a new endpoint with a relative URI. More...
 
 CachingEndpointBase (IEndpoint referrer, string relativeUri)
 Creates a new endpoint with a relative URI. More...
 
async Task< HttpContent > GetContentAsync (CancellationToken cancellationToken, [CallerMemberName] string caller="unknown")
 Performs an HTTP GET request on the IEndpoint.Uri and caches the response if the server sends an HttpResponseHeaders.ETag. More...
 
async Task< HttpResponseMessage > PutContentAsync (HttpContent content, CancellationToken cancellationToken, [CallerMemberName] string caller="unknown")
 Performs an HttpMethod.Put request on the IEndpoint.Uri. Sets HttpRequestHeaders.IfMatch if there is a cached HttpResponseHeader.ETag to detect lost updates. More...
 
async Task< HttpResponseMessage > DeleteContentAsync (CancellationToken cancellationToken, [CallerMemberName] string caller="unknown")
 Performs an HttpMethod.Delete request on the IEndpoint.Uri. Sets HttpRequestHeaders.IfMatch if there is a cached ETag to detect lost updates. More...
 
- Protected Member Functions inherited from TypedRest.Endpoints.EndpointBase
 EndpointBase (Uri uri, HttpClient httpClient, MediaTypeFormatter serializer, IErrorHandler errorHandler, ILinkExtractor linkExtractor)
 Creates a new endpoint with an absolute URI. More...
 
 EndpointBase (IEndpoint referrer, Uri relativeUri)
 Creates a new endpoint with a relative URI. More...
 
 EndpointBase (IEndpoint referrer, string relativeUri)
 Creates a new endpoint with a relative URI. More...
 
virtual async Task< HttpResponseMessage > HandleAsync (Func< Task< HttpResponseMessage > > request, [CallerMemberName] string caller="unknown")
 Handles various cross-cutting concerns regarding a response message such as discovering links and handling errors. More...
 
Activity? StartActivity ([CallerMemberName] string caller="unknown")
 Starts a new Activity if there is any listener registered (e.g. OpenTelemetry), returns null otherwise. More...
 
virtual void HandleCapabilities (HttpResponseMessage response)
 Handles allowed HTTP methods and other capabilities reported by the server. More...
 
bool? IsMethodAllowed (HttpMethod method)
 Shows whether the server has indicated that a specific HTTP method is currently allowed. More...
 

Properties

ResponseCacheResponseCache [getset]
 
- Properties inherited from TypedRest.Endpoints.EndpointBase
Uri Uri [get]
 
HttpClient HttpClient [get]
 
MediaTypeFormatter Serializer [get]
 
IErrorHandler ErrorHandler [get]
 
ILinkExtractor LinkExtractor [get]
 
- Properties inherited from TypedRest.Endpoints.IEndpoint
Uri Uri [get]
 The HTTP URI of the remote resource.
 
HttpClient HttpClient [get]
 The HTTP client used to communicate with the remote resource.
 
MediaTypeFormatter Serializer [get]
 Controls the serialization of entities sent to and received from the server.
 
IErrorHandler ErrorHandler [get]
 Handles errors in responses.
 
ILinkExtractor LinkExtractor [get]
 Extracts links from responses.
 
- Properties inherited from TypedRest.Endpoints.ICachingEndpoint
ResponseCacheResponseCache [getset]
 A cached copy of the last response.
 

Additional Inherited Members

- Public Member Functions inherited from TypedRest.Endpoints.EndpointBase
void SetDefaultLink (string rel, string? href)
 Registers one or more default links for a specific relation type. These links are used when no links with this relation type are provided by the server. This should only be called during initial setup of the endpoint. More...
 
void SetDefaultLinkTemplate (string rel, string? href)
 Registers a default link template for a specific relation type. This template is used when no template with this relation type is provided by the server. This should only be called during initial setup of the endpoint. More...
 
IReadOnlyList<(Uri uri, string? title)> GetLinks (string rel)
 Resolves all links with a specific relation type. Uses cached data from last response. More...
 
Uri Link (string rel)
 Resolves a single link with a specific relation type. Uses cached data from last response if possible. Tries lazy lookup with HTTP HEAD on cache miss. More...
 
UriTemplate GetLinkTemplate (string rel)
 Retrieves a link template with a specific relation type. Prefer IEndpoint.LinkTemplate(string,object) when possible. More...
 
Uri LinkTemplate (string rel, IDictionary< string, object > variables)
 Resolves a link template with a specific relation type. Uses cached data from last response if possible. Tries lazy lookup with HTTP HEAD on cache miss. More...
 
Uri LinkTemplate (string rel, object variables)
 Resolves a link template with a specific relation type. More...
 
override string ToString ()
 
- Static Protected Member Functions inherited from TypedRest.Endpoints.EndpointBase
static Func< IEndpoint, Uri, TEndpoint > GetConstructor< TEndpoint > ()
 Returns a constructor for TEndpoint as a function with a referrer an a relative URI as input. More...
 

Detailed Description

Base class for building endpoints that use ETags and Last-Modified timestamps for caching and to avoid lost updates.

Constructor & Destructor Documentation

◆ CachingEndpointBase() [1/2]

TypedRest.Endpoints.Generic.CachingEndpointBase.CachingEndpointBase ( IEndpoint  referrer,
Uri  relativeUri 
)
inlineprotected

Creates a new endpoint with a relative URI.

Parameters
referrerThe endpoint used to navigate to this one.
relativeUriThe URI of this endpoint relative to the referrer 's. Add a ./ prefix here to imply a trailing slash referrer 's URI.

◆ CachingEndpointBase() [2/2]

TypedRest.Endpoints.Generic.CachingEndpointBase.CachingEndpointBase ( IEndpoint  referrer,
string  relativeUri 
)
inlineprotected

Creates a new endpoint with a relative URI.

Parameters
referrerThe endpoint used to navigate to this one.
relativeUriThe URI of this endpoint relative to the referrer 's. Add a ./ prefix here to imply a trailing slash referrer 's URI.

Member Function Documentation

◆ DeleteContentAsync()

async Task< HttpResponseMessage > TypedRest.Endpoints.Generic.CachingEndpointBase.DeleteContentAsync ( CancellationToken  cancellationToken,
[CallerMemberName] string  caller = "unknown" 
)
inlineprotected

Performs an HttpMethod.Delete request on the IEndpoint.Uri. Sets HttpRequestHeaders.IfMatch if there is a cached ETag to detect lost updates.

Parameters
cancellationTokenUsed to cancel the request.
callerThe name of the method calling this method.
Returns
The response message.
Exceptions
InvalidOperationExceptionThe content has changed since it was last retrieved with GetContentAsync. Your changes were rejected to prevent a lost update.
InvalidDataExceptionHttpStatusCode.BadRequest
AuthenticationExceptionHttpStatusCode.Unauthorized
UnauthorizedAccessExceptionHttpStatusCode.Forbidden
KeyNotFoundExceptionHttpStatusCode.NotFound or HttpStatusCode.Gone
HttpRequestExceptionOther non-success status code.

◆ GetContentAsync()

async Task< HttpContent > TypedRest.Endpoints.Generic.CachingEndpointBase.GetContentAsync ( CancellationToken  cancellationToken,
[CallerMemberName] string  caller = "unknown" 
)
inlineprotected

Performs an HTTP GET request on the IEndpoint.Uri and caches the response if the server sends an HttpResponseHeaders.ETag.

Sends If-None-Match header if there is already a cached ETag.

Parameters
cancellationTokenUsed to cancel the request.
callerThe name of the method calling this method.
Returns
The response of the request or the cached response if the server responded with HttpStatusCode.NotModified.
Exceptions
AuthenticationExceptionHttpStatusCode.Unauthorized
UnauthorizedAccessExceptionHttpStatusCode.Forbidden
KeyNotFoundExceptionHttpStatusCode.NotFound or HttpStatusCode.Gone or empty response body
HttpRequestExceptionOther non-success status code.

◆ PutContentAsync()

async Task< HttpResponseMessage > TypedRest.Endpoints.Generic.CachingEndpointBase.PutContentAsync ( HttpContent  content,
CancellationToken  cancellationToken,
[CallerMemberName] string  caller = "unknown" 
)
inlineprotected

Performs an HttpMethod.Put request on the IEndpoint.Uri. Sets HttpRequestHeaders.IfMatch if there is a cached HttpResponseHeader.ETag to detect lost updates.

Parameters
contentThe content to send to the server.
cancellationTokenUsed to cancel the request.
callerThe name of the method calling this method.
Returns
The response message.
Exceptions
InvalidOperationExceptionThe content has changed since it was last retrieved with GetContentAsync. Your changes were rejected to prevent a lost update.
InvalidDataExceptionHttpStatusCode.BadRequest
AuthenticationExceptionHttpStatusCode.Unauthorized
UnauthorizedAccessExceptionHttpStatusCode.Forbidden
KeyNotFoundExceptionHttpStatusCode.NotFound or HttpStatusCode.Gone
HttpRequestExceptionOther non-success status code.

The documentation for this class was generated from the following file: