Tgstation.Server.Host.IO.FileDownloader Class Reference

More...

Inheritance diagram for Tgstation.Server.Host.IO.FileDownloader:

Collaboration diagram for Tgstation.Server.Host.IO.FileDownloader:

Public Member Functions
	FileDownloader (IAbstractHttpClientFactory httpClientFactory, ILogger< FileDownloader > logger)
	Initializes a new instance of the FileDownloader class.
IFileStreamProvider	DownloadFile (Uri url, string? bearerToken)
	Downloads a file from a given url . Parameters url The URL to download. bearerToken Optional string to use as the "Bearer" value in the optional "Authorization" header for the request. Returns A new IFileStreamProvider for the downloaded file.

Private Attributes
readonly IAbstractHttpClientFactory	httpClientFactory
	The IAbstractHttpClientFactory for the FileDownloader.
readonly ILogger< FileDownloader >	logger
	The ILogger for the FileDownloader.

Detailed Description

Definition at line 13 of file FileDownloader.cs.

Constructor & Destructor Documentation

FileDownloader()

Tgstation.Server.Host.IO.FileDownloader.FileDownloader	(	IAbstractHttpClientFactory	httpClientFactory,
		ILogger< FileDownloader >	logger
	)

Initializes a new instance of the FileDownloader class.

Parameters

httpClientFactory	The value of httpClientFactory.
logger	The value of logger.

Definition at line 30 of file FileDownloader.cs.

        {
            this.httpClientFactory = httpClientFactory ?? throw new ArgumentNullException(nameof(httpClientFactory));
            this.logger = logger ?? throw new ArgumentNullException(nameof(logger));
        }

References Tgstation.Server.Host.IO.FileDownloader.httpClientFactory, and Tgstation.Server.Host.IO.FileDownloader.logger.

Member Function Documentation

DownloadFile()

IFileStreamProvider Tgstation.Server.Host.IO.FileDownloader.DownloadFile	(	Uri	url,
		string?	bearerToken
	)

Downloads a file from a given url .

Parameters

url	The URL to download.
bearerToken	Optional string to use as the "Bearer" value in the optional "Authorization" header for the request.

Returns

A new IFileStreamProvider for the downloaded file.

Implements Tgstation.Server.Host.IO.IFileDownloader.

Definition at line 37 of file FileDownloader.cs.

        {
            ArgumentNullException.ThrowIfNull(url);
 
            logger.LogDebug("Starting download of {url}...", url);
            var httpClient = httpClientFactory.CreateClient();
            try
            {
                var request = new HttpRequestMessage(
                    HttpMethod.Get,
                    url);
                try
                {
                    if (bearerToken != null)
                        request.Headers.Authorization = new AuthenticationHeaderValue(ApiHeaders.BearerAuthenticationScheme, bearerToken);
 
                    return new RequestFileStreamProvider(httpClient, request);
                }
                catch
                {
                    request.Dispose();
                    throw;
                }
            }
            catch
            {
                httpClient.Dispose();
                throw;
            }
        }

References Tgstation.Server.Api.ApiHeaders.BearerAuthenticationScheme, Tgstation.Server.Common.Http.IAbstractHttpClientFactory.CreateClient(), Tgstation.Server.Host.IO.FileDownloader.httpClientFactory, and Tgstation.Server.Host.IO.FileDownloader.logger.

Here is the call graph for this function:

Member Data Documentation

httpClientFactory

readonly IAbstractHttpClientFactory Tgstation.Server.Host.IO.FileDownloader.httpClientFactory

private

The IAbstractHttpClientFactory for the FileDownloader.

Definition at line 18 of file FileDownloader.cs.

Referenced by Tgstation.Server.Host.IO.FileDownloader.DownloadFile(), and Tgstation.Server.Host.IO.FileDownloader.FileDownloader().

logger

readonly ILogger<FileDownloader> Tgstation.Server.Host.IO.FileDownloader.logger

private

The ILogger for the FileDownloader.

Definition at line 23 of file FileDownloader.cs.

Referenced by Tgstation.Server.Host.IO.FileDownloader.DownloadFile(), and Tgstation.Server.Host.IO.FileDownloader.FileDownloader().

---

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

• src/Tgstation.Server.Host/IO/FileDownloader.cs