Skyline.DataMiner.Core.ArtifactDownloader 2.0.0

Skyline.DataMiner.Core.ArtifactDownloader

Skyline.DataMiner.Core.ArtifactDownloader is a .NET library designed to simplify and streamline the process of downloading various artifacts (Low-Code Apps, Dashboards, and Catalog Items) from DataMiner systems and artifact catalogs. It offers a clean API to handle artifact retrieval efficiently.

📦 Features

• DataMiner Artifact Downloads: Download Low-Code Apps and Dashboards directly from DataMiner systems.
• Flexible Download Options: Retrieve artifacts as raw byte arrays or save them as .zip files.
• Error Handling: Robust exception handling for invalid inputs and connection issues.
• Extensible Service Interfaces: Clean and well-structured service interfaces for easy integration.

🚀 Getting Started

📥 Installation

Install the package via NuGet:

dotnet add package Skyline.DataMiner.Core.ArtifactDownloader

🔧 Usage

1. Connecting to DataMiner

using System.Net.Http;
using Skyline.ArtifactDownloader;
using Skyline.DataMiner.Net;

var slnetConnection = ConnectionSettings.GetConnection("your-dataminer-host");
var httpClient = new HttpClient();

var dataMinerService = Downloader.FromDataMiner(slnetConnection, httpClient);

2. Downloading a Low-Code App

using Skyline.ArtifactDownloader.Identifiers;

var appId = new LowCodeAppIdentifier("AppName", "1.0.0");
string savePath = @"C:\Downloads";

string filePath = await dataMinerService.DownloadLowCodeAppAsync(appId, savePath);
Console.WriteLine($"Low-Code App downloaded to: {filePath}");

3. Downloading a Dashboard

using Skyline.ArtifactDownloader.Identifiers;

var dashboardId = new DashboardIdentifier("DashboardName", "2.1.0");
string dashboardPath = @"C:\Downloads";

string filePath = await dataMinerService.DownloadDashboardAsync(dashboardId, dashboardPath);
Console.WriteLine($"Dashboard downloaded to: {filePath}");

🛠️ API Overview

Downloader Factory

IDataMinerService Downloader.FromDataMiner(IConnection slnetConnection, HttpClient downloadClient)

• Initializes a connection to the DataMiner system for artifact downloading.

IDataMinerService Interface

• DownloadLowCodeAppAsync:
  Download a Low-Code App as a byte array or .zip file.

• DownloadDashboardAsync:
  Download a Dashboard as a byte array or .zip file.

Task<byte[]> DownloadLowCodeAppAsync(LowCodeAppIdentifier id);
Task<string> DownloadLowCodeAppAsync(LowCodeAppIdentifier id, string directoryPath);
Task<byte[]> DownloadDashboardAsync(DashboardIdentifier id);
Task<string> DownloadDashboardAsync(DashboardIdentifier id, string directoryPath);

ICatalogService Interface (Future Support)

Planned support for downloading items directly from the Catalog Service.

Task<string> DownloadCatalogItemAsync(CatalogIdentifier id, string directoryPath);
Task<CatalogDownloadResult> DownloadCatalogItemAsync(CatalogIdentifier id);

⚠️ Error Handling

• DataMinerException: Thrown when the connection to DataMiner fails.
• ArtifactDownloadException: Thrown when the artifact cannot be downloaded.
• ArgumentNullException & ArgumentException: Input validation errors.

🤝 Contributing

Contributions are welcome! Feel free to submit issues or pull requests to improve the library.