Packages

class SftpApi extends FtpApi[SSHClient, SftpSettings] with SftpSourceParams

Source
FtpApi.scala
Linear Supertypes
SftpSourceParams, SftpDefaultSettings, SftpSource, FtpSourceFactory[SSHClient, SftpSettings], FtpApi[SSHClient, SftpSettings], AnyRef, Any
Known Subclasses
Sftp
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SftpApi
  2. SftpSourceParams
  3. SftpDefaultSettings
  4. SftpSource
  5. FtpSourceFactory
  6. FtpApi
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SftpApi()

Type Members

  1. type S = SftpSettings
    Definition Classes
    SftpSourceParams

Value Members

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

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

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

    path

    the file path

    connectionSettings

    connection settings

    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 CompletionStage of IOResult

    Definition Classes
    SftpApi → FtpApi
  2. def fromPath(path: String, connectionSettings: S, chunkSize: Int = DefaultChunkSize): Source[ByteString, CompletionStage[IOResult]]

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

    Java 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 CompletionStage of IOResult

    Definition Classes
    SftpApi → FtpApi
  3. def fromPath(path: String, connectionSettings: S): Source[ByteString, CompletionStage[IOResult]]

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

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

    path

    the file path

    connectionSettings

    connection settings

    returns

    A Source of ByteString that materializes to a CompletionStage of IOResult

    Definition Classes
    SftpApi → FtpApi
  4. def fromPath(host: String, username: String, password: String, path: String): Source[ByteString, CompletionStage[IOResult]]

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

    Java 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 CompletionStage of IOResult

    Definition Classes
    SftpApi → FtpApi
  5. def fromPath(host: String, path: String): Source[ByteString, CompletionStage[IOResult]]

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

    Java 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 CompletionStage of IOResult

    Definition Classes
    SftpApi → FtpApi
  6. def ls(basePath: String, connectionSettings: S, branchSelector: Predicate[FtpFile], emitTraversedDirectories: Boolean): Source[FtpFile, NotUsed]

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

    Java 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 predicate for pruning the tree. Takes a remote folder and return true if you want to enter that remote folder. Default behaviour is full 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
  7. def ls(basePath: String, connectionSettings: S, branchSelector: Predicate[FtpFile]): Source[FtpFile, NotUsed]

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

    Java 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 predicate for pruning the tree. Takes a remote folder and return true if you want to enter that remote folder. Default behaviour is full 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
  8. def ls(basePath: String, connectionSettings: S): Source[FtpFile, NotUsed]

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

    Java 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
  9. def ls(host: String, username: String, password: String, basePath: String): Source[FtpFile, NotUsed]

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

    Java 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
  10. def ls(host: String, username: String, password: String): Source[FtpFile, NotUsed]

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

    Java 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
  11. def ls(host: String, basePath: String): Source[FtpFile, NotUsed]

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

    Java 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
  12. def ls(host: String): Source[FtpFile, NotUsed]

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

    Java 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
  13. def mkdir(basePath: String, name: String, connectionSettings: S): Source[Done, NotUsed]

    Java API for creating a directory in a given path

    Java 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 Done

    Definition Classes
    SftpApi → FtpApi
  14. def mkdirAsync(basePath: String, name: String, connectionSettings: S, system: ClassicActorSystemProvider): CompletionStage[Done]

    Java API for creating a directory in a given path

    Java API for creating a directory in a given path

    basePath

    path to start with

    name

    name of a directory to create

    connectionSettings

    connection settings

    system

    actor system

    returns

    CompletionStage of pekko.Done indicating a materialized, asynchronous request

    Definition Classes
    SftpApi → FtpApi
  15. def move(destinationPath: Function[FtpFile, String], connectionSettings: S): Sink[FtpFile, CompletionStage[IOResult]]

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

    Java 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 CompletionStage of IOResult

    Definition Classes
    SftpApi → FtpApi
  16. def remove(connectionSettings: S): Sink[FtpFile, CompletionStage[IOResult]]

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

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

    connectionSettings

    connection settings

    returns

    A Sink of FtpFile that materializes to a CompletionStage of IOResult

    Definition Classes
    SftpApi → FtpApi
  17. def sshClient(): SSHClient
    Definition Classes
    SftpSource
  18. def toPath(path: String, connectionSettings: S): Sink[ByteString, CompletionStage[IOResult]]

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

    Java API: creates a Sink of ByteString to some file path. If a file already exists at the specified target path, it will get overwritten.

    path

    the file path

    connectionSettings

    connection settings

    returns

    A Sink of ByteString that materializes to a CompletionStage of IOResult

    Definition Classes
    SftpApi → FtpApi
  19. def toPath(path: String, connectionSettings: S, append: Boolean): Sink[ByteString, CompletionStage[IOResult]]

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

    Java 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 CompletionStage of IOResult

    Definition Classes
    SftpApi → FtpApi

Deprecated Value Members

  1. def mkdirAsync(basePath: String, name: String, connectionSettings: S, mat: Materializer): CompletionStage[Done]

    Java API for creating a directory in a given path

    Java 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

    CompletionStage of pekko.Done indicating a materialized, asynchronous request

    Definition Classes
    SftpApi → FtpApi
    Deprecated

    pass in the actor system instead of the materializer, since Alpakka 3.0.0