Packages

object Ftp extends FtpApi[FTPClient, FtpSettings] with FtpSourceParams

Source
FtpApi.scala
Linear Supertypes
FtpSourceParams, FtpDefaultSettings, FtpSource, FtpSourceFactory[FTPClient, FtpSettings], FtpApi[FTPClient, FtpSettings], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Ftp
  2. FtpSourceParams
  3. FtpDefaultSettings
  4. FtpSource
  5. FtpSourceFactory
  6. FtpApi
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type S = FtpSettings
    Definition Classes
    FtpSourceParams

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 val FtpBrowserSourceName: String("FtpBrowserSource")
    Attributes
    protected
    Definition Classes
    FtpSource
  6. final val FtpDirectorySource: String("FtpDirectorySource")
    Attributes
    protected
    Definition Classes
    FtpSource
  7. final val FtpIOSinkName: String("FtpIOSink")
    Attributes
    protected
    Definition Classes
    FtpSource
  8. final val FtpIOSourceName: String("FtpIOSource")
    Attributes
    protected
    Definition Classes
    FtpSource
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. def createBrowserGraph(_basePath: String, _connectionSettings: FtpSettings, _branchSelector: (FtpFile) => Boolean, _emitTraversedDirectories: Boolean)(implicit _ftpLike: FtpLike[FTPClient, FtpSettings]): FtpBrowserGraphStage[FTPClient, FtpSettings]
    Attributes
    protected[this]
    Definition Classes
    FtpSourceFactory
  12. def createBrowserGraph(_basePath: String, _connectionSettings: FtpSettings, _branchSelector: (FtpFile) => Boolean)(implicit _ftpLike: FtpLike[FTPClient, FtpSettings]): FtpBrowserGraphStage[FTPClient, FtpSettings]
    Attributes
    protected[this]
    Definition Classes
    FtpSourceFactory
  13. def createIOSink(_path: String, _connectionSettings: FtpSettings, _append: Boolean)(implicit _ftpLike: FtpLike[FTPClient, FtpSettings]): FtpIOSinkStage[FTPClient, FtpSettings]
    Attributes
    protected[this]
    Definition Classes
    FtpSourceFactory
  14. def createIOSource(_path: String, _connectionSettings: FtpSettings, _chunkSize: Int, _offset: Long)(implicit _ftpLike: FtpLike[FTPClient, FtpSettings]): FtpIOSourceStage[FTPClient, FtpSettings]
    Attributes
    protected[this]
    Definition Classes
    FtpSourceFactory
  15. def createIOSource(_path: String, _connectionSettings: FtpSettings, _chunkSize: Int)(implicit _ftpLike: FtpLike[FTPClient, FtpSettings]): FtpIOSourceStage[FTPClient, FtpSettings]
    Attributes
    protected[this]
    Definition Classes
    FtpSourceFactory
  16. def createMkdirGraph(baseDirectoryPath: String, dirName: String, currentConnectionSettings: FtpSettings)(implicit _ftpLike: FtpLike[FTPClient, FtpSettings]): FtpDirectoryOperationsGraphStage[FTPClient, FtpSettings]
    Attributes
    protected[this]
    Definition Classes
    FtpSourceFactory
  17. def createMoveSink(_destinationPath: (FtpFile) => String, _connectionSettings: FtpSettings)(implicit _ftpLike: FtpLike[FTPClient, FtpSettings]): GraphStageWithMaterializedValue[SinkShape[FtpFile], Future[IOResult]] with FtpMoveSink[FTPClient, FtpSettings]
    Attributes
    protected[this]
    Definition Classes
    FtpSourceFactory
  18. def createRemoveSink(_connectionSettings: FtpSettings)(implicit _ftpLike: FtpLike[FTPClient, FtpSettings]): GraphStageWithMaterializedValue[SinkShape[FtpFile], Future[IOResult]] with FtpRemoveSink[FTPClient, FtpSettings]
    Attributes
    protected[this]
    Definition Classes
    FtpSourceFactory
  19. def defaultSettings(hostname: String, username: Option[String] = None, password: Option[String] = None): FtpSettings
    Attributes
    protected
    Definition Classes
    FtpDefaultSettings
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  23. 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
    FtpFtpApi
  24. 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
    FtpFtpApi
  25. 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
    FtpFtpApi
  26. 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
    FtpFtpApi
  27. 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
    FtpFtpApi
  28. val ftpBrowserSourceName: String
    Attributes
    protected
    Definition Classes
    FtpSource → FtpSourceFactory
  29. val ftpClient: () => FTPClient
    Attributes
    protected
    Definition Classes
    FtpSource → FtpSourceFactory
  30. val ftpDirectorySourceName: String
    Attributes
    protected
    Definition Classes
    FtpSource → FtpSourceFactory
  31. val ftpIOSinkName: String
    Attributes
    protected
    Definition Classes
    FtpSource → FtpSourceFactory
  32. val ftpIOSourceName: String
    Attributes
    protected
    Definition Classes
    FtpSource → FtpSourceFactory
  33. val ftpLike: FtpLike[FTPClient, S]
    Attributes
    protected[this]
    Definition Classes
    FtpSourceParams
  34. def func[T, R](f: (T) => R): Function[T, R]
    Attributes
    protected[javadsl]
    Definition Classes
    FtpApi
  35. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  36. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. 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
    FtpFtpApi
  39. 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
    FtpFtpApi
  40. 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
    FtpFtpApi
  41. 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
    FtpFtpApi
  42. 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
    FtpFtpApi
  43. 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
    FtpFtpApi
  44. 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
    FtpFtpApi
  45. 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
    FtpFtpApi
  46. 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
    FtpFtpApi
  47. 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
    FtpFtpApi
  48. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  49. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  50. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  51. 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
    FtpFtpApi
  52. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  53. 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
    FtpFtpApi
  54. 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
    FtpFtpApi
  55. def toString(): String
    Definition Classes
    AnyRef → Any
  56. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

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
    FtpFtpApi
    Deprecated

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

Inherited from FtpSourceParams

Inherited from FtpDefaultSettings

Inherited from FtpSource

Inherited from FtpSourceFactory[FTPClient, FtpSettings]

Inherited from FtpApi[FTPClient, FtpSettings]

Inherited from AnyRef

Inherited from Any

Ungrouped