sealed trait FtpApi[FtpClient] extends AnyRef
- Self Type
- FtpApi[FtpClient] with FtpSourceFactory[FtpClient]
- Source
- FtpApi.scala
- Alphabetic
- By Inheritance
- FtpApi
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
abstract
type
S <: RemoteFileSettings
The refined RemoteFileSettings type.
Abstract Value Members
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
fromPath(path: String, connectionSettings: (FtpApi.this)#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
-
def
fromPath(path: String, connectionSettings: (FtpApi.this)#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
-
def
fromPath(path: String, connectionSettings: (FtpApi.this)#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
-
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
-
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
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
ls(basePath: String, connectionSettings: (FtpApi.this)#S, branchSelector: Predicate[FtpFile], emitTraversedDirectories: Boolean): Source[FtpFile, NotUsed]
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
-
def
ls(basePath: String, connectionSettings: (FtpApi.this)#S, branchSelector: Predicate[FtpFile]): Source[FtpFile, NotUsed]
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
- def ls(basePath: String, connectionSettings: (FtpApi.this)#S): Source[FtpFile, NotUsed]
- def ls(host: String, username: String, password: String, basePath: String): Source[FtpFile, NotUsed]
-
def
ls(host: String, username: String, password: String): Source[FtpFile, NotUsed]
Java API: creates a Source of FtpFiles from the remote user
root
directory. - def ls(host: String, basePath: String): Source[FtpFile, NotUsed]
-
def
ls(host: String): Source[FtpFile, NotUsed]
Java API: creates a Source of FtpFiles from the remote user
root
directory. -
def
move(destinationPath: Function[FtpFile, String], connectionSettings: (FtpApi.this)#S): Sink[FtpFile, CompletionStage[IOResult]]
Java API: creates a Sink of a FtpFile that moves a file to some file path.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def remove(connectionSettings: (FtpApi.this)#S): Sink[FtpFile, CompletionStage[IOResult]]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toPath(path: String, connectionSettings: (FtpApi.this)#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
-
def
toPath(path: String, connectionSettings: (FtpApi.this)#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
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )