Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##: Int

   Definition Classes

   AnyRef → Any

3.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

4.  final val DefaultChunkSize: Int(8192)

   Attributes

   protected[this]

   Definition Classes

   FtpSourceFactory

5.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

6.  def clone(): AnyRef

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws(classOf[java.lang.CloneNotSupportedException]) @native()

7.  def createBrowserGraph(_basePath: String, _connectionSettings: SftpSettings, _branchSelector: (FtpFile) => Boolean, _emitTraversedDirectories: Boolean)(implicit _ftpLike: FtpLike[SSHClient, SftpSettings]): FtpBrowserGraphStage[SSHClient, SftpSettings]

   Attributes

   protected[this]

   Definition Classes

   FtpSourceFactory

8.  def createBrowserGraph(_basePath: String, _connectionSettings: SftpSettings, _branchSelector: (FtpFile) => Boolean)(implicit _ftpLike: FtpLike[SSHClient, SftpSettings]): FtpBrowserGraphStage[SSHClient, SftpSettings]

   Attributes

   protected[this]

   Definition Classes

   FtpSourceFactory

9.  def createIOSink(_path: String, _connectionSettings: SftpSettings, _append: Boolean)(implicit _ftpLike: FtpLike[SSHClient, SftpSettings]): FtpIOSinkStage[SSHClient, SftpSettings]

   Attributes

   protected[this]

   Definition Classes

   FtpSourceFactory

10.  def createIOSource(_path: String, _connectionSettings: SftpSettings, _chunkSize: Int, _offset: Long)(implicit _ftpLike: FtpLike[SSHClient, SftpSettings]): FtpIOSourceStage[SSHClient, SftpSettings]

    Attributes

    protected[this]

    Definition Classes

    FtpSourceFactory

11.  def createIOSource(_path: String, _connectionSettings: SftpSettings, _chunkSize: Int)(implicit _ftpLike: FtpLike[SSHClient, SftpSettings]): FtpIOSourceStage[SSHClient, SftpSettings]

    Attributes

    protected[this]

    Definition Classes

    FtpSourceFactory

12.  def createMkdirGraph(baseDirectoryPath: String, dirName: String, currentConnectionSettings: SftpSettings)(implicit _ftpLike: FtpLike[SSHClient, SftpSettings]): FtpDirectoryOperationsGraphStage[SSHClient, SftpSettings]

    Attributes

    protected[this]

    Definition Classes

    FtpSourceFactory

13.  def createMoveSink(_destinationPath: (FtpFile) => String, _connectionSettings: SftpSettings)(implicit _ftpLike: FtpLike[SSHClient, SftpSettings]): GraphStageWithMaterializedValue[SinkShape[FtpFile], Future[IOResult]] with FtpMoveSink[SSHClient, SftpSettings]

    Attributes

    protected[this]

    Definition Classes

    FtpSourceFactory

14.  def createRemoveSink(_connectionSettings: SftpSettings)(implicit _ftpLike: FtpLike[SSHClient, SftpSettings]): GraphStageWithMaterializedValue[SinkShape[FtpFile], Future[IOResult]] with FtpRemoveSink[SSHClient, SftpSettings]

    Attributes

    protected[this]

    Definition Classes

    FtpSourceFactory

15.  def defaultSettings(hostname: String, username: Option[String] = None, password: Option[String] = None): SftpSettings

    Attributes

    protected

    Definition Classes

    SftpDefaultSettings

16.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

17.  def equals(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef → Any

18.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.Throwable])

19.  def fromPath(path: String, connectionSettings: S, chunkSize: Int, offset: Long): Source[ByteString, Future[IOResult]]

    Scala API: creates a Source of ByteString from some file path.

    Scala API: creates a Source of ByteString from some file path.

    path

    the file path

    connectionSettings

    connection setting

    chunkSize

    the size of transmitted ByteString chunks

    offset

    the offset into the remote file at which to start the file transfer

    returns

    A Source of ByteString that materializes to a Future of IOResult

    Definition Classes

    SftpApi → FtpApi

20.  def fromPath(path: String, connectionSettings: S, chunkSize: Int = DefaultChunkSize): Source[ByteString, Future[IOResult]]

    Scala API: creates a Source of ByteString from some file path.

    Scala API: creates a Source of ByteString from some file path.

    path

    the file path

    connectionSettings

    connection settings

    chunkSize

    the size of transmitted ByteString chunks

    returns

    A Source of ByteString that materializes to a Future of IOResult

    Definition Classes

    SftpApi → FtpApi

21.  def fromPath(host: String, username: String, password: String, path: String): Source[ByteString, Future[IOResult]]

    Scala API: creates a Source of ByteString from some file path.

    Scala API: creates a Source of ByteString from some file path.

    host

    FTP, FTPS or SFTP host

    username

    username

    password

    password

    path

    the file path

    returns

    A Source of ByteString that materializes to a Future of IOResult

    Definition Classes

    SftpApi → FtpApi

22.  def fromPath(host: String, path: String): Source[ByteString, Future[IOResult]]

    Scala API: creates a Source of ByteString from some file path.

    Scala API: creates a Source of ByteString from some file path.

    host

    FTP, FTPS or SFTP host

    path

    the file path

    returns

    A Source of ByteString that materializes to a Future of IOResult

    Definition Classes

    SftpApi → FtpApi

23.  val ftpBrowserSourceName: String

    Attributes

    protected

    Definition Classes

    SftpSource → FtpSourceFactory

24.  val ftpClient: (SftpSettings) => SSHClient

    Attributes

    protected

    Definition Classes

    SftpSource → FtpSourceFactory

25.  val ftpDirectorySourceName: String

    Attributes

    protected

    Definition Classes

    SftpSource → FtpSourceFactory

26.  val ftpIOSinkName: String

    Attributes

    protected

    Definition Classes

    SftpSource → FtpSourceFactory

27.  val ftpIOSourceName: String

    Attributes

    protected

    Definition Classes

    SftpSource → FtpSourceFactory

28.  val ftpLike: FtpLike[SSHClient, S]

    Attributes

    protected[this]

    Definition Classes

    SftpSourceParams

29.  final def getClass(): Class[_ <: AnyRef]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

30.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

31.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

32.  def ls(basePath: String, connectionSettings: S, branchSelector: (FtpFile) => Boolean, emitTraversedDirectories: Boolean): Source[FtpFile, NotUsed]

    Scala API: creates a Source of FtpFiles from a base path.

    Scala API: creates a Source of FtpFiles from a base path.

    basePath

    Base path from which traverse the remote file server

    connectionSettings

    connection settings

    branchSelector

    a function for pruning the tree. Takes a remote folder and return true if you want to enter that remote folder. Default behaviour is fully recursive which is equivalent with calling this function with [ls(basePath,connectionSettings,f=>true)]. Calling [ls(basePath,connectionSettings,f=>false)] will emit only the files and folder in non-recursive fashion

    emitTraversedDirectories

    whether to include entered directories in the stream

    returns

    A Source of FtpFiles

    Definition Classes

    SftpApi → FtpApi

33.  def ls(basePath: String, connectionSettings: S, branchSelector: (FtpFile) => Boolean): Source[FtpFile, NotUsed]

    Scala API: creates a Source of FtpFiles from a base path.

    Scala API: creates a Source of FtpFiles from a base path.

    basePath

    Base path from which traverse the remote file server

    connectionSettings

    connection settings

    branchSelector

    a function for pruning the tree. Takes a remote folder and return true if you want to enter that remote folder. Default behaviour is fully recursive which is equivalent with calling this function with [ls(basePath,connectionSettings,f=>true)]. Calling [ls(basePath,connectionSettings,f=>false)] will emit only the files and folder in non-recursive fashion

    returns

    A Source of FtpFiles

    Definition Classes

    SftpApi → FtpApi

34.  def ls(basePath: String, connectionSettings: S): Source[FtpFile, NotUsed]

    Scala API: creates a Source of FtpFiles from a base path.

    Scala API: creates a Source of FtpFiles from a base path.

    basePath

    Base path from which traverse the remote file server

    connectionSettings

    connection settings

    returns

    A Source of FtpFiles

    Definition Classes

    SftpApi → FtpApi

35.  def ls(host: String, username: String, password: String, basePath: String): Source[FtpFile, NotUsed]

    Scala API: creates a Source of FtpFiles from a base path.

    Scala API: creates a Source of FtpFiles from a base path.

    host

    FTP, FTPS or SFTP host

    username

    username

    password

    password

    basePath

    Base path from which traverse the remote file server

    returns

    A Source of FtpFiles

    Definition Classes

    SftpApi → FtpApi

36.  def ls(host: String, username: String, password: String): Source[FtpFile, NotUsed]

    Scala API: creates a Source of FtpFiles from the remote user root directory.

    Scala API: creates a Source of FtpFiles from the remote user root directory.

    host

    FTP, FTPS or SFTP host

    username

    username

    password

    password

    returns

    A Source of FtpFiles

    Definition Classes

    SftpApi → FtpApi

37.  def ls(host: String, basePath: String): Source[FtpFile, NotUsed]

    Scala API: creates a Source of FtpFiles from a base path.

    Scala API: creates a Source of FtpFiles from a base path. By default, anonymous credentials will be used.

    host

    FTP, FTPS or SFTP host

    basePath

    Base path from which traverse the remote file server

    returns

    A Source of FtpFiles

    Definition Classes

    SftpApi → FtpApi

38.  def ls(host: String): Source[FtpFile, NotUsed]

    Scala API: creates a Source of FtpFiles from the remote user root directory.

    Scala API: creates a Source of FtpFiles from the remote user root directory. By default, anonymous credentials will be used.

    host

    FTP, FTPS or SFTP host

    returns

    A Source of FtpFiles

    Definition Classes

    SftpApi → FtpApi

39.  def mkdir(basePath: String, name: String, connectionSettings: S): Source[Done, NotUsed]

    Scala API for creating a directory in a given path

    Scala API for creating a directory in a given path

    basePath

    path to start with

    name

    name of a directory to create

    connectionSettings

    connection settings

    returns

    Source of pekko.Done

    Definition Classes

    SftpApi → FtpApi

40.  def mkdirAsync(basePath: String, name: String, connectionSettings: S)(implicit system: ClassicActorSystemProvider): Future[Done]

    Scala API for creating a directory in a given path

    Scala API for creating a directory in a given path

    basePath

    path to start with

    name

    name of a directory to create

    connectionSettings

    connection settings

    returns

    Future of pekko.Done indicating a materialized, asynchronous request

    Definition Classes

    SftpApi → FtpApi

41.  def move(destinationPath: (FtpFile) => String, connectionSettings: S): Sink[FtpFile, Future[IOResult]]

    Scala API: creates a Sink of a FtpFile that moves a file to some file path.

    Scala API: creates a Sink of a FtpFile that moves a file to some file path.

    destinationPath

    a function that returns path to where the FtpFile is moved.

    connectionSettings

    connection settings

    returns

    A Sink of FtpFile that materializes to a Future of IOResult

    Definition Classes

    SftpApi → FtpApi

42.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

43.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

44.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

45.  def remove(connectionSettings: S): Sink[FtpFile, Future[IOResult]]

    Scala API: creates a Sink of a FtpFile that removes a file.

    Scala API: creates a Sink of a FtpFile that removes a file.

    connectionSettings

    connection settings

    returns

    A Sink of FtpFile that materializes to a Future of IOResult

    Definition Classes

    SftpApi → FtpApi

46.  final val sFtpBrowserSourceName: String("sFtpBrowserSource")

    Attributes

    protected

    Definition Classes

    SftpSource

47.  final val sFtpDirectorySource: String("sFtpDirectorySource")

    Attributes

    protected

    Definition Classes

    SftpSource

48.  final val sFtpIOSinkName: String("sFtpIOSink")

    Attributes

    protected

    Definition Classes

    SftpSource

49.  final val sFtpIOSourceName: String("sFtpIOSource")

    Attributes

    protected

    Definition Classes

    SftpSource

50.  def sshClient(): SSHClient

    Definition Classes

    SftpSource

51.  final def synchronized[T0](arg0: => T0): T0

    Definition Classes

    AnyRef

52.  def toPath(path: String, connectionSettings: S, append: Boolean = false): Sink[ByteString, Future[IOResult]]

    Scala API: creates a Sink of ByteString to some file path.

    Scala API: creates a Sink of ByteString to some file path.

    path

    the file path

    connectionSettings

    connection settings

    append

    append data if a file already exists, overwrite the file if not

    returns

    A Sink of ByteString that materializes to a Future of IOResult

    Definition Classes

    SftpApi → FtpApi

53.  def toString(): String

    Definition Classes

    AnyRef → Any

54.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

55.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

56.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException]) @native()