docs
API
Generated with
docs/zio.ftp

zio.ftp

package zio.ftp

Members list

Type members

Classlikes

final case class ConnectionError(message: String, cause: Throwable) extends IOException

Attributes

Companion
object
Supertypes
trait Product
trait Equals
class IOException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object ConnectionError

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class FileTransferIncompleteError(message: String) extends IOException

Attributes

Supertypes
trait Product
trait Equals
class IOException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object Ftp

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Ftp.type
trait FtpAccessors[+A]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class SecureFtp
class UnsecureFtp
final case class FtpCredentials(username: String, password: String)

Credential used during ftp authentication

Credential used during ftp authentication

Value parameters

password

secure secret of the user in plain text

username

identifier of the user in plain text

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class FtpResource(path: String, size: Long, lastModified: Long, permissions: Set[PosixFilePermission], isDirectory: Option[Boolean])

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

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

Value parameters

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

lastModified

last modified date as a timestamp

path

location on the resource on the ftp server

permissions

linux file system permissions

size

size in bytes

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FtpResource

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class InvalidPathError(message: String) extends IOException

Attributes

Supertypes
trait Product
trait Equals
class IOException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
final case class KeyFileSftpIdentity(privateKey: Path, passphrase: Option[String]) extends SftpIdentity

SFTP identity for authenticating using private/public key file

SFTP identity for authenticating using private/public key file

Value parameters

passphrase

password to use to decrypt private key file

privateKey

private key file to use when connecting

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait SftpIdentity
class Object
trait Matchable
class Any
Show all
object KeyFileSftpIdentity

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed abstract class ProtectionLevel(val s: String)

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Clear
object Confidential
object Private
object Safe
object ProtectionLevel

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class RawKeySftpIdentity(privateKey: String, passphrase: Option[String], publicKey: Option[String]) extends SftpIdentity

SFTP identity for authenticating using private/public key value

SFTP identity for authenticating using private/public key value

Value parameters

passphrase

password to use to decrypt private key

privateKey

private key value to use when connecting

publicKey

public key value to use when connecting

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait SftpIdentity
class Object
trait Matchable
class Any
Show all
object RawKeySftpIdentity

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object SFtp

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
SFtp.type
sealed abstract class SecureFtp(unsafeClient: Client) extends FtpAccessors[Client]

Secure Ftp client wrapper

Secure Ftp client wrapper

All ftp methods exposed are lift into ZIO or ZStream, which required a Blocking Environment since the underlying java client only provide blocking methods.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object SecureFtp

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
SecureFtp.type
final case class SecureFtpSettings(host: String, port: Int, credentials: FtpCredentials, sftpIdentity: Option[SftpIdentity], strictHostKeyChecking: Boolean, knownHosts: Option[String], proxy: Option[Proxy], sshConfig: Config)

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

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

Value parameters

credentials

auth credentials

host

hostname of ftp server (ipAddress / dnsName)

knownHosts

known hosts file to be used when connecting

port

port of communication used by the server

sftpIdentity

private/public key config to use when connecting

sshConfig

configuration of ssh client

strictHostKeyChecking

sets whether to use strict host key checking.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SecureFtpSettings

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait SftpIdentity

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
final case class SslParams(isImplicit: Boolean, pbzs: Long, prot: ProtectionLevel)

Value parameters

isImplicit

// security mode (Implicit/Explicit)

pbzs

// Protection Buffer SiZe default value 0

prot

// data channel PROTection level default value C More informations regarding these settings https://enterprisedt.com/products/edtftpjssl/doc/manual/html/ftpscommands.html

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SslParams

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
SslParams.type
object StubFtp

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
StubFtp.type
object TestFtp

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
TestFtp.type
sealed abstract class UnsecureFtp(unsafeClient: Client) extends FtpAccessors[Client]

Unsecure Ftp client wrapper

Unsecure Ftp client wrapper

All ftp methods exposed are lift into ZIO or ZStream The underlying java client only provide blocking methods.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object UnsecureFtp

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final case class UnsecureFtpSettings(host: String, port: Int, credentials: FtpCredentials, binary: Boolean, passiveMode: Boolean, remoteVerificationEnabled: Boolean, proxy: Option[Proxy], sslParams: Option[SslParams], dataTimeout: Option[Duration], controlEncoding: Option[String])

Settings to connect unsecure Ftp server

Settings to connect unsecure Ftp server

Value parameters

binary

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

controlEncoding

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

credentials

credentials (username and password)

dataTimeout

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

host

hostname of ftp server (ipAddress / dnsName)

passiveMode

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

port

port of communication used by the server

proxy

An optional proxy to use when connecting with these settings

secure

Use FTP over SSL

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UnsecureFtpSettings

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Types

Value members

Concrete methods

def stub(path: Path): Layer[Any, StubFtp]
Generated with