Maurosoft.FileSystem.Adapters.Sftp 1.0.0

Maurosoft FileSystem

Builds

Introduction

Maurosoft FileSystem is a file system abstraction supporting multiple adapters.

Installation

Reference NuGet package Maurosoft.FileSystem (https://www.nuget.org/packages/Maurosoft.FileSystem).

For adapters other than the local file system (included in the Maurosoft.FileSystem package) please see the Supported adapters section.

Supported adapters

Adapter	Package	NuGet
Local adapter	Maurosoft.FileSystem
FTP	Maurosoft.FileSystem.Adapters.Ftp
Memory	Maurosoft.FileSystem.Adapters.Memory
SFTP	Maurosoft.FileSystem.Adapters.Sftp

Supported operations

For a full list of the supported operations please see the IFileSystem interface.

Usage

Instantiation

var adapters = new List<IAdapter>
{
    new LocalAdapter("adapterPrefix", "adapterRootPath")
};

// Instantiation option 1.
var fileSystem = new FileSystem(adapters);

// Instantiation option 2.
var fileSystem = new FileSystem();
fileSystem.Adapters = adapters;

Local adapter

var adapters = new List<IAdapter>
{
    new LocalAdapter("local1", "/var/files"),
    new LocalAdapter("local2", "D:\\Files")
};

var fileSystem = new FileSystem(adapters);

Memory adapter

var adapters = new List<IAdapter>
{
    new MemoryAdapter("memory1", "/"),
    new MemoryAdapter("memory2", "/")
};

var fileSystem = new FileSystem(adapters);

SFTP adapter

// SFTP connection.
var privateKeyFile = new PrivateKeyFile("/home/userName/.ssh/id_rsa");
var privateKeyAuthenticationMethod = new PrivateKeyAuthenticationMethod("userName", privateKeyFile);
var sftpConnectionInfo = new ConnectionInfo("hostName", "userName", privateKeyAuthenticationMethod);
var sftpClient = new SftpClient(sftpConnectionInfo);

var adapters = new List<IAdapter>
{
    new LocalAdapter("local", "/var/files"),
    new SftpAdapter("sftp", "/var/files", sftpClient)
};

var fileSystem = new FileSystem(adapters);

Example operations

// Sftp connection.
var privateKeyFile = new PrivateKeyFile("/home/userName/.ssh/id_rsa");
var privateKeyAuthenticationMethod = new PrivateKeyAuthenticationMethod("userName", privateKeyFile);
var sftpConnectionInfo = new ConnectionInfo("hostName", "userName", privateKeyAuthenticationMethod);
var sftpClient = new SftpClient(sftpConnectionInfo);

var adapters = new List<IAdapter>
{
    new LocalAdapter("local", "/var/files"),
    new SftpAdapter("sftp", "/var/files", sftpClient)
};

// Copies a file from the `local` adapter to the `sftp` adapter.
await fileSystem.CopyFileAsync("local://foo/bar.txt", "sftp://bar/foo.txt");

// Moves a file from the `sftp` adapter to the `local` adapter.
await fileSystem.MoveFileAsync("sftp://Foo/Bar.txt", "local://Bar/Foo.txt");

// Writes string contents to the `local` adapter.
await fileSystem.WriteFileAsync("local://foo/bar.txt", "Bar!");