Packages

sealed trait FtpApi[FtpClient, S <: RemoteFileSettings] extends AnyRef

Self Type
FtpApi[FtpClient, S] with FtpSourceFactory[FtpClient, S]
Annotations
@DoNotInherit()
Source
FtpApi.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FtpApi
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract 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

  2. abstract 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

  3. abstract 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

  4. abstract 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

  5. abstract 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

  6. abstract 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

  7. abstract 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

  8. abstract 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

  9. abstract 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

  10. abstract 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

  11. abstract 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

  12. abstract 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

  13. abstract 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

  14. abstract 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 akka.Done indicating a materialized, asynchronous request

  15. abstract 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

  16. abstract 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

  17. abstract 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

  18. abstract 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

Concrete 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 def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def func[T, R](f: (T) ⇒ R): Function[T, R]
    Attributes
    protected[javadsl]
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped