SFTPOverSSHFileProvider: Read only file providers

In terminological/uk-covid-datatools: Functions for sourcing, cleaning and calculating Rt for uk covid timeseries data

Description

Read only file providers

Read only file providers

Super classes

ukcovidtools::AbstractFileProvider -> ukcovidtools::ReadOnlyFileProvider -> SFTPOverSSHFileProvider

Methods

Public methods

• SFTPOverSSHFileProvider$new()

• SFTPOverSSHFileProvider$finalize()

• SFTPOverSSHFileProvider$curlCommand()

• SFTPOverSSHFileProvider$getSession()

• SFTPOverSSHFileProvider$listFiles()

• SFTPOverSSHFileProvider$getFile()

• SFTPOverSSHFileProvider$print()

• SFTPOverSSHFileProvider$clone()

Inherited methods

• ukcovidtools::AbstractFileProvider$listAllFiles()

• ukcovidtools::AbstractFileProvider$relativePath()

• ukcovidtools::ReadOnlyFileProvider$processFiles()

---

Method new()

SFTP over SSH tunnel file provider

Usage

SFTPOverSSHFileProvider$new(
  config,
  hostName = config$hostName,
  ssh = config$ssh,
  sshkey = config$sshkey,
  user = config$user,
  password = config$password,
  ...
)

Arguments

ssh

- ssh tunnel host

sshkey

- ssh key file

user

- sftp username

password

- sftp password

...

for compatibility

hostname

- sftp host

Returns

the provider

---

Method finalize()

Usage

SFTPOverSSHFileProvider$finalize()

---

Method curlCommand()

Usage

SFTPOverSSHFileProvider$curlCommand(relativePath)

---

Method getSession()

Usage

SFTPOverSSHFileProvider$getSession()

---

Method listFiles()

Usage

SFTPOverSSHFileProvider$listFiles(directory = ".")

---

Method getFile()

Usage

SFTPOverSSHFileProvider$getFile(filename)

---

Method print()

Usage

SFTPOverSSHFileProvider$print()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

SFTPOverSSHFileProvider$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

terminological/uk-covid-datatools documentation built on June 24, 2021, 8:16 p.m.