LiteX.Storage.Core 4.0.0

Abstract interface to implement any kind of basic blob storage services (e.g. Azure, Amazon, Google, Local FileSystem) for any type of application (ASP.NET Core, .Net Standard 2.x).

There is a newer version of this package available.
See the version list below for details.
Install-Package LiteX.Storage.Core -Version 4.0.0
dotnet add package LiteX.Storage.Core --version 4.0.0
<PackageReference Include="LiteX.Storage.Core" Version="4.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add LiteX.Storage.Core --version 4.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

LiteXStorage

Abstract interface to implement any kind of basic blob storage services (e.g. Azure, Amazon, Google, Local FileSystem) for any type of application (ASP.NET Core, .Net Standard 2.x).

Add a dependency

Nuget

Run the nuget command for installing the client as,

  • Install-Package LiteX.Storage.Core
  • Install-Package LiteX.Storage.Azure
  • Install-Package LiteX.Storage.Amazon
  • Install-Package LiteX.Storage.Google
  • Install-Package LiteX.Storage.Local
  • Install-Package LiteX.Storage.Kvpbase

Configuration

AppSettings

{
  //LiteX Azure Storage settings
  "AzureBlobConfig": {
    "AzureBlobStorageConnectionString": "--- REPLACE WITH YOUR AZURE CONNECTION STRING ---",
    "AzureBlobStorageContainerName": "--- REPLACE WITH YOUR AZURE CONTAINER NAME ---",
    "AzureBlobStorageEndPoint": "--- REPLACE WITH YOUR AZURE END POINT ---"
  },

  //LiteX Amazon Storage settings
  "AmazonBlobConfig": {
    "AmazonAwsAccessKeyId": "--- REPLACE WITH YOUR AMAZON ACCESS KEY ID ---",
    "AmazonAwsSecretAccessKey": "--- REPLACE WITH YOUR AMAZON SECRET ACCESS KEY ---",
    "AmazonBucketName": "--- REPLACE WITH YOUR AZURE AMAZON BUCKET NAME ---"
  },

  //LiteX Google Storage settings
  "GoogleCloudBlobConfig": {
    "GoogleProjectId": "--- REPLACE WITH YOUR GOOGLE PROJECT ID ---",
    "GoogleJsonAuthPath": "--- REPLACE WITH YOUR GOOGLE JSON AUTH PATH ---",
    "GoogleBucketName": "--- REPLACE WITH YOUR GOOGLE BUCKET NAME ---"
  },

  //LiteX Kvpbase Storage settings
  "KvpbaseBlobConfig": {
    "KvpbaseApiKey": "--- REPLACE WITH YOUR KVPBASE API KEY ---",
    "KvpbaseContainer": "--- REPLACE WITH YOUR KVPBASE CONTAINER ---",
    "KvpbaseEndpoint": "--- REPLACE WITH YOUR KVPBASE END POINT ---",
    "KvpbaseUserGuid": "--- REPLACE WITH YOUR KVPBASE USERGUID ---"
  },

  //LiteX Local File System Storage settings
  "FileSystemBlobConfig": {
    "Directory": "--- REPLACE WITH YOUR LOCAL FILE SYSTEM DIRECTORY ---"
  }
}

Startup Configuration

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        #region LiteX Storage (Azure)

        // 1. Use default configuration from appsettings.json's 'AzureBlobConfig'
        services.AddLiteXAzureBlobService();

        //OR
        // 2. Load configuration settings using options.
        services.AddLiteXAzureBlobService(option =>
        {
            //option. = "";
        });

        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var azureBlobConfig = new AzureBlobConfig();
        services.AddLiteXAzureBlobService(azureBlobConfig);

        #endregion

        #region LiteX Storage (Amazon)

        // 1. Use default configuration from appsettings.json's 'AmazonBlobConfig'
        services.AddLiteXAmazonBlobService();

        //OR
        // 2. Load configuration settings using options.
        services.AddLiteXAmazonBlobService(option =>
        {
            //option. = "";
        });

        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var amazonBlobConfig = new AmazonBlobConfig();
        services.AddLiteXAmazonBlobService(amazonBlobConfig);

        #endregion

        #region LiteX Storage (Google)

        // 1. Use default configuration from appsettings.json's 'GoogleCloudBlobConfig'
        services.AddLiteXGoogleCloudBlobService();

        //OR
        // 2. Load configuration settings using options.
        services.AddLiteXGoogleCloudBlobService(option =>
        {
            //option. = "";
        });

        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var googleCloudBlobConfig = new GoogleCloudBlobConfig();
        services.AddLiteXGoogleCloudBlobService(googleCloudBlobConfig);

        #endregion

        #region LiteX Storage (Kvpbase)

        services.AddLiteXKvpbaseBlobService();

        services.AddLiteXKvpbaseBlobService(option =>
        {
            //option. = "";
        });

        var kvpbaseBlobConfig = new KvpbaseBlobConfig();
        services.AddLiteXKvpbaseBlobService(kvpbaseBlobConfig);

        #endregion

        #region LiteX Storage (FileSystem-Local)

        services.AddLiteXFileSystemBlobService();

        services.AddLiteXFileSystemBlobService(option =>
        {
            //option. = "";
        });

        var fileSystemBlobConfig = new FileSystemBlobConfig();
        services.AddLiteXFileSystemBlobService(fileSystemBlobConfig);

        #endregion
    }
}

Usage

Controller or Business layer

[Route("api/[controller]")]
public class CustomerController : Controller
{
    private readonly IBlobService _blobService;

    public CustomerController(IBlobService blobService)
    {
        _blobService = blobService;
    }

    public IActionResult UploadFile(IFormFile file)
    {
        string blobName = file.FileName;
        Stream stream = file.OpenReadStream();
        string contentType = file.ContentType;
        BlobProperties properties = new BlobProperties { ContentType = contentType };

        bool isUploaded = _blobService.UploadBlob(blobName, stream, properties);
        //bool isUploaded = await _blobService.UploadBlobAsync(blobName, stream, properties);

        return Ok();
    }

    public IActionResult GetBlobFile(string blobName)
    {
        Stream stream = _blobService.GetBlob(blobName);
        //Stream stream = await _blobService.GetBlobAsync(blobName);

        return Ok();
    }

    public IActionResult GetBlobUrl(string blobName)
    {
        string blobUrl = _blobService.GetBlobUrl(blobName);
        //string blobUrl = await _blobService.GetBlobUrlAsync(blobName);

        return Ok();
    }

    public IActionResult GetBlobSasUrl(string blobName)
    {
        string blobUrl = _blobService.GetBlobSasUrl(blobName, DateTimeOffset.UtcNow.AddHours(2), BlobUrlAccess.Read);
        //string blobUrl = await _blobService.GetBlobSasUrlAsync(blobName, DateTimeOffset.UtcNow.AddHours(2), BlobUrlAccess.Read);

        return Ok();
    }

    public IActionResult DeleteBlobFile(string blobName)
    {
        bool isDeleted = _blobService.DeleteBlob(blobName);
        //bool isDeleted = await _blobService.DeleteBlobAsync(blobName);

        return Ok();
    }

    public IActionResult GetBlobMetadata(string blobName)
    {
        BlobDescriptor blobDescriptor = _blobService.GetBlobDescriptor(blobName);
        //BlobDescriptor blobDescriptor =  await _blobService.GetBlobDescriptorAsync(blobName);
        var metadata = blobDescriptor.Metadata;

        return Ok();
    }

    public IActionResult SetBlobMetadata(string blobName)
    {
        IDictionary<string, string> metadata = new Dictionary<string, string>();

        BlobProperties properties = new BlobProperties()
        {
            ContentType = "",
            Metadata = metadata,
            ContentDisposition = "",
            Security = BlobSecurity.Public
        };

        bool isSet = _blobService.SetBlobProperties(blobName, properties);
        //bool isSet = await _blobService.SetBlobPropertiesAsync(blobName, properties);

        return Ok();
    }

    public IActionResult GetBlobs()
    {
        List<BlobDescriptor> blobs = _blobService.GetBlobs().ToList();
        //List<BlobDescriptor> blobs = await _blobService.GetBlobsAsync().ToList();

        return Ok();
    }
}

LiteXStorage

Abstract interface to implement any kind of basic blob storage services (e.g. Azure, Amazon, Google, Local FileSystem) for any type of application (ASP.NET Core, .Net Standard 2.x).

Add a dependency

Nuget

Run the nuget command for installing the client as,

  • Install-Package LiteX.Storage.Core
  • Install-Package LiteX.Storage.Azure
  • Install-Package LiteX.Storage.Amazon
  • Install-Package LiteX.Storage.Google
  • Install-Package LiteX.Storage.Local
  • Install-Package LiteX.Storage.Kvpbase

Configuration

AppSettings

{
  //LiteX Azure Storage settings
  "AzureBlobConfig": {
    "AzureBlobStorageConnectionString": "--- REPLACE WITH YOUR AZURE CONNECTION STRING ---",
    "AzureBlobStorageContainerName": "--- REPLACE WITH YOUR AZURE CONTAINER NAME ---",
    "AzureBlobStorageEndPoint": "--- REPLACE WITH YOUR AZURE END POINT ---"
  },

  //LiteX Amazon Storage settings
  "AmazonBlobConfig": {
    "AmazonAwsAccessKeyId": "--- REPLACE WITH YOUR AMAZON ACCESS KEY ID ---",
    "AmazonAwsSecretAccessKey": "--- REPLACE WITH YOUR AMAZON SECRET ACCESS KEY ---",
    "AmazonBucketName": "--- REPLACE WITH YOUR AZURE AMAZON BUCKET NAME ---"
  },

  //LiteX Google Storage settings
  "GoogleCloudBlobConfig": {
    "GoogleProjectId": "--- REPLACE WITH YOUR GOOGLE PROJECT ID ---",
    "GoogleJsonAuthPath": "--- REPLACE WITH YOUR GOOGLE JSON AUTH PATH ---",
    "GoogleBucketName": "--- REPLACE WITH YOUR GOOGLE BUCKET NAME ---"
  },

  //LiteX Kvpbase Storage settings
  "KvpbaseBlobConfig": {
    "KvpbaseApiKey": "--- REPLACE WITH YOUR KVPBASE API KEY ---",
    "KvpbaseContainer": "--- REPLACE WITH YOUR KVPBASE CONTAINER ---",
    "KvpbaseEndpoint": "--- REPLACE WITH YOUR KVPBASE END POINT ---",
    "KvpbaseUserGuid": "--- REPLACE WITH YOUR KVPBASE USERGUID ---"
  },

  //LiteX Local File System Storage settings
  "FileSystemBlobConfig": {
    "Directory": "--- REPLACE WITH YOUR LOCAL FILE SYSTEM DIRECTORY ---"
  }
}

Startup Configuration

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        #region LiteX Storage (Azure)

        // 1. Use default configuration from appsettings.json's 'AzureBlobConfig'
        services.AddLiteXAzureBlobService();

        //OR
        // 2. Load configuration settings using options.
        services.AddLiteXAzureBlobService(option =>
        {
            //option. = "";
        });

        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var azureBlobConfig = new AzureBlobConfig();
        services.AddLiteXAzureBlobService(azureBlobConfig);

        #endregion

        #region LiteX Storage (Amazon)

        // 1. Use default configuration from appsettings.json's 'AmazonBlobConfig'
        services.AddLiteXAmazonBlobService();

        //OR
        // 2. Load configuration settings using options.
        services.AddLiteXAmazonBlobService(option =>
        {
            //option. = "";
        });

        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var amazonBlobConfig = new AmazonBlobConfig();
        services.AddLiteXAmazonBlobService(amazonBlobConfig);

        #endregion

        #region LiteX Storage (Google)

        // 1. Use default configuration from appsettings.json's 'GoogleCloudBlobConfig'
        services.AddLiteXGoogleCloudBlobService();

        //OR
        // 2. Load configuration settings using options.
        services.AddLiteXGoogleCloudBlobService(option =>
        {
            //option. = "";
        });

        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var googleCloudBlobConfig = new GoogleCloudBlobConfig();
        services.AddLiteXGoogleCloudBlobService(googleCloudBlobConfig);

        #endregion

        #region LiteX Storage (Kvpbase)

        services.AddLiteXKvpbaseBlobService();

        services.AddLiteXKvpbaseBlobService(option =>
        {
            //option. = "";
        });

        var kvpbaseBlobConfig = new KvpbaseBlobConfig();
        services.AddLiteXKvpbaseBlobService(kvpbaseBlobConfig);

        #endregion

        #region LiteX Storage (FileSystem-Local)

        services.AddLiteXFileSystemBlobService();

        services.AddLiteXFileSystemBlobService(option =>
        {
            //option. = "";
        });

        var fileSystemBlobConfig = new FileSystemBlobConfig();
        services.AddLiteXFileSystemBlobService(fileSystemBlobConfig);

        #endregion
    }
}

Usage

Controller or Business layer

[Route("api/[controller]")]
public class CustomerController : Controller
{
    private readonly IBlobService _blobService;

    public CustomerController(IBlobService blobService)
    {
        _blobService = blobService;
    }

    public IActionResult UploadFile(IFormFile file)
    {
        string blobName = file.FileName;
        Stream stream = file.OpenReadStream();
        string contentType = file.ContentType;
        BlobProperties properties = new BlobProperties { ContentType = contentType };

        bool isUploaded = _blobService.UploadBlob(blobName, stream, properties);
        //bool isUploaded = await _blobService.UploadBlobAsync(blobName, stream, properties);

        return Ok();
    }

    public IActionResult GetBlobFile(string blobName)
    {
        Stream stream = _blobService.GetBlob(blobName);
        //Stream stream = await _blobService.GetBlobAsync(blobName);

        return Ok();
    }

    public IActionResult GetBlobUrl(string blobName)
    {
        string blobUrl = _blobService.GetBlobUrl(blobName);
        //string blobUrl = await _blobService.GetBlobUrlAsync(blobName);

        return Ok();
    }

    public IActionResult GetBlobSasUrl(string blobName)
    {
        string blobUrl = _blobService.GetBlobSasUrl(blobName, DateTimeOffset.UtcNow.AddHours(2), BlobUrlAccess.Read);
        //string blobUrl = await _blobService.GetBlobSasUrlAsync(blobName, DateTimeOffset.UtcNow.AddHours(2), BlobUrlAccess.Read);

        return Ok();
    }

    public IActionResult DeleteBlobFile(string blobName)
    {
        bool isDeleted = _blobService.DeleteBlob(blobName);
        //bool isDeleted = await _blobService.DeleteBlobAsync(blobName);

        return Ok();
    }

    public IActionResult GetBlobMetadata(string blobName)
    {
        BlobDescriptor blobDescriptor = _blobService.GetBlobDescriptor(blobName);
        //BlobDescriptor blobDescriptor =  await _blobService.GetBlobDescriptorAsync(blobName);
        var metadata = blobDescriptor.Metadata;

        return Ok();
    }

    public IActionResult SetBlobMetadata(string blobName)
    {
        IDictionary<string, string> metadata = new Dictionary<string, string>();

        BlobProperties properties = new BlobProperties()
        {
            ContentType = "",
            Metadata = metadata,
            ContentDisposition = "",
            Security = BlobSecurity.Public
        };

        bool isSet = _blobService.SetBlobProperties(blobName, properties);
        //bool isSet = await _blobService.SetBlobPropertiesAsync(blobName, properties);

        return Ok();
    }

    public IActionResult GetBlobs()
    {
        List<BlobDescriptor> blobs = _blobService.GetBlobs().ToList();
        //List<BlobDescriptor> blobs = await _blobService.GetBlobsAsync().ToList();

        return Ok();
    }
}

Release Notes

Async support.
     Re-write again from scratch.
     Added new methods (e.g. create/delete container, SasUrl, GetBlobDescriptor, GetBlobs, Get/Set BlobProperties).
     Core logic changes.
     Use data stream instead of byte array.
     One default container/bucket specific.

  • .NETStandard 2.0

    • No dependencies.

Version History

Version Downloads Last updated
6.3.0 1,288 11/15/2018
6.2.0 189 10/10/2018
6.1.0 385 8/26/2018
6.0.0 166 7/22/2018
5.0.0 194 6/27/2018
4.0.0 190 6/2/2018
3.0.0 166 5/7/2018
2.0.0 223 4/25/2018
1.0.0 239 4/21/2018
Show less