object Ftp extends FtpApi[FTPClient, FtpSettings] with FtpSourceParams
- Source
- FtpApi.scala
- Alphabetic
- By Inheritance
- Ftp
- FtpSourceParams
- FtpDefaultSettings
- FtpSource
- FtpSourceFactory
- FtpApi
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
type
S = FtpSettings
- Definition Classes
- FtpSourceParams
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
val
DefaultChunkSize: Int(8192)
- Attributes
- protected[this]
- Definition Classes
- FtpSourceFactory
-
final
val
FtpBrowserSourceName: String("FtpBrowserSource")
- Attributes
- protected
- Definition Classes
- FtpSource
-
final
val
FtpDirectorySource: String("FtpDirectorySource")
- Attributes
- protected
- Definition Classes
- FtpSource
-
final
val
FtpIOSinkName: String("FtpIOSink")
- Attributes
- protected
- Definition Classes
- FtpSource
-
final
val
FtpIOSourceName: String("FtpIOSource")
- Attributes
- protected
- Definition Classes
- FtpSource
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
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
-
def
createBrowserGraph(_basePath: String, _connectionSettings: FtpSettings, _branchSelector: (FtpFile) ⇒ Boolean)(implicit _ftpLike: FtpLike[FTPClient, FtpSettings]): FtpBrowserGraphStage[FTPClient, FtpSettings]
- Attributes
- protected[this]
- Definition Classes
- FtpSourceFactory
-
def
createIOSink(_path: String, _connectionSettings: FtpSettings, _append: Boolean)(implicit _ftpLike: FtpLike[FTPClient, FtpSettings]): FtpIOSinkStage[FTPClient, FtpSettings]
- Attributes
- protected[this]
- Definition Classes
- FtpSourceFactory
-
def
createIOSource(_path: String, _connectionSettings: FtpSettings, _chunkSize: Int, _offset: Long)(implicit _ftpLike: FtpLike[FTPClient, FtpSettings]): FtpIOSourceStage[FTPClient, FtpSettings]
- Attributes
- protected[this]
- Definition Classes
- FtpSourceFactory
-
def
createIOSource(_path: String, _connectionSettings: FtpSettings, _chunkSize: Int)(implicit _ftpLike: FtpLike[FTPClient, FtpSettings]): FtpIOSourceStage[FTPClient, FtpSettings]
- Attributes
- protected[this]
- Definition Classes
- FtpSourceFactory
-
def
createMkdirGraph(baseDirectoryPath: String, dirName: String, currentConnectionSettings: FtpSettings)(implicit _ftpLike: FtpLike[FTPClient, FtpSettings]): FtpDirectoryOperationsGraphStage[FTPClient, FtpSettings]
- Attributes
- protected[this]
- Definition Classes
- FtpSourceFactory
-
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
-
def
createRemoveSink(_connectionSettings: FtpSettings)(implicit _ftpLike: FtpLike[FTPClient, FtpSettings]): GraphStageWithMaterializedValue[SinkShape[FtpFile], Future[IOResult]] with FtpRemoveSink[FTPClient, FtpSettings]
- Attributes
- protected[this]
- Definition Classes
- FtpSourceFactory
-
def
defaultSettings(hostname: String, username: Option[String] = None, password: Option[String] = None): FtpSettings
- Attributes
- protected
- Definition Classes
- FtpDefaultSettings
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
-
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
-
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
-
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
-
val
ftpBrowserSourceName: String
- Attributes
- protected
- Definition Classes
- FtpSource → FtpSourceFactory
-
val
ftpClient: () ⇒ FTPClient
- Attributes
- protected
- Definition Classes
- FtpSource → FtpSourceFactory
-
val
ftpDirectorySourceName: String
- Attributes
- protected
- Definition Classes
- FtpSource → FtpSourceFactory
-
val
ftpIOSinkName: String
- Attributes
- protected
- Definition Classes
- FtpSource → FtpSourceFactory
-
val
ftpIOSourceName: String
- Attributes
- protected
- Definition Classes
- FtpSource → FtpSourceFactory
-
val
ftpLike: FtpLike[FTPClient, S]
- Attributes
- protected[this]
- Definition Classes
- FtpSourceParams
- def func[T, R](f: (T) ⇒ R): Function[T, R]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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.
- 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: 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: 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
rootdirectory. - 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
rootdirectory. -
def
mkdir(basePath: String, name: String, connectionSettings: S): Source[Done, NotUsed]
Java API for creating a directory in a given path
-
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
-
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.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def remove(connectionSettings: S): Sink[FtpFile, CompletionStage[IOResult]]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
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
-
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
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )