GaEpd.FileService 2.0.0

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package GaEpd.FileService --version 2.0.0                
NuGet\Install-Package GaEpd.FileService -Version 2.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="GaEpd.FileService" Version="2.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add GaEpd.FileService --version 2.0.0                
#r "nuget: GaEpd.FileService, 2.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.
// Install GaEpd.FileService as a Cake Addin
#addin nuget:?package=GaEpd.FileService&version=2.0.0

// Install GaEpd.FileService as a Cake Tool
#tool nuget:?package=GaEpd.FileService&version=2.0.0                

Georgia EPD-IT File Service Library

This library was created by Georgia EPD-IT to provide common file services for our web applications.

How to install

Nuget

To install, search for "GaEpd.FileService" in the NuGet package manager or run the following command:

dotnet add package GaEpd.FileService

What's included

An IFileService interface is provided to abstract out common file persistence operations along with three useful implementations:

In Memory

builder.Services.AddSingleton<IFileService, InMemoryFileService>();

File System

The basePath is required and defines where the files will be stored.

builder.Services.AddTransient<IFileService, FileSystemFileService>(_ =>
    new FileSystemFileService(basePath));

If a Windows Identity is required to access the desired file system, include the username, domain, and password in the constructor.

builder.Services.AddTransient<IFileService, FileSystemFileService>(_ =>
    new FileSystemFileService(basePath, userName, domain, password));

Azure Blob Storage

Requires an Azure account and an existing Blob Storage container. (The Azure Blob service does not attempt to create the container if it does not exist.) The basePath is optional and is added to file names as a path segment.

builder.Services.AddSingleton<IFileService, AzureBlobFileService>(_ =>
    new AzureBlobFileService(accountName, container, basePath));

Warning: At the moment, the SaveFileAsync() method throws an exception when using Azure Blob Storage if the file already exists.

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

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.1.1 2,115 3/5/2024
3.1.0 467 1/25/2024
3.0.0 120 1/24/2024
2.1.0 159 1/16/2024
2.0.0 152 1/2/2024
1.0.0 267 10/25/2023

v2.0.0
- Upgrade to .NET 8.0.
v1.0.0
- Initial release.