Type Members

1.  final case class ConnectionError(message: String, cause: Throwable) extends IOException with Product with Serializable
2.  final case class FileTransferIncompleteError(message: String) extends IOException with Product with Serializable
3.  type Ftp = Has[FtpAccessors[Client]]
4.  trait FtpAccessors[+A] extends AnyRef
5.  final case class FtpCredentials(username: String, password: String) extends Product with Serializable

   Credential used during ftp authentication

   Credential used during ftp authentication

   username

   identifier of the user in plain text

   password

   secure secret of the user in plain text

6.  final case class FtpResource(path: String, size: Long, lastModified: Long, permissions: Set[PosixFilePermission], isDirectory: Option[Boolean]) extends Product with Serializable

   Represent a file / directory / symbolic link on a ftp server

   Represent a file / directory / symbolic link on a ftp server

   path

   location on the resource on the ftp server

   size

   size in bytes

   lastModified

   last modified date as a timestamp

   permissions

   linux file system permissions

   isDirectory

   boolean flag: 'true' if it is a directory, 'false' if it is a file. In some situation we cannot determine the type of the resource

7.  final case class InvalidPathError(message: String) extends IOException with Product with Serializable
8.  final case class KeyFileSftpIdentity(privateKey: Path, passphrase: Option[String] = None) extends SftpIdentity with Product with Serializable

   SFTP identity for authenticating using private/public key file

   SFTP identity for authenticating using private/public key file

   privateKey

   private key file to use when connecting

   passphrase

   password to use to decrypt private key file

9.  final case class RawKeySftpIdentity(privateKey: String, passphrase: Option[String] = None, publicKey: Option[String] = None) extends SftpIdentity with Product with Serializable

   SFTP identity for authenticating using private/public key value

   SFTP identity for authenticating using private/public key value

   privateKey

   private key value to use when connecting

   passphrase

   password to use to decrypt private key

   publicKey

   public key value to use when connecting

10.  type SFtp = Has[FtpAccessors[Client]]
11.  final case class SecureFtpSettings(host: String, port: Int, credentials: FtpCredentials, sftpIdentity: Option[SftpIdentity], strictHostKeyChecking: Boolean, knownHosts: Option[String], proxy: Option[Proxy], sshConfig: Config) extends Product with Serializable

    Settings to connect to a secure Ftp server (Ftp over ssh)

    Settings to connect to a secure Ftp server (Ftp over ssh)

    host

    hostname of ftp server (ipAddress / dnsName)

    port

    port of communication used by the server

    credentials

    auth credentials

    sftpIdentity

    private/public key config to use when connecting

    strictHostKeyChecking

    sets whether to use strict host key checking.

    knownHosts

    known hosts file to be used when connecting

    sshConfig

    configuration of ssh client

12.  sealed trait SftpIdentity extends AnyRef
13.  type StubFtp = Has[FtpAccessors[Unit]]
14.  final case class UnsecureFtpSettings(host: String, port: Int, credentials: FtpCredentials, binary: Boolean, passiveMode: Boolean, proxy: Option[Proxy], secure: Boolean, dataTimeout: Option[Duration] = None, controlEncoding: Option[String] = None) extends Product with Serializable

    Settings to connect unsecure Ftp server

    Settings to connect unsecure Ftp server

    host

    hostname of ftp server (ipAddress / dnsName)

    port

    port of communication used by the server

    credentials

    credentials (username and password)

    binary

    specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false)

    passiveMode

    specifies whether to use passive mode connections. Default is active mode (false)

    proxy

    An optional proxy to use when connecting with these settings

    secure

    Use FTP over SSL

    dataTimeout

    Sets the timeout to use when reading from the data connection.

    controlEncoding

    character encoding to be used by the FTP control connection, auto-detects UTF-8 if None