Alpakka 1.1.2 - akka.stream.alpakka.ftp.scaladsl.Sftp

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

def apply(customSshClient: SSHClient): SftpApi

Scala API: creates a akka.stream.alpakka.ftp.scaladsl.SftpApi

customSshClient: custom ssh client
returns: A akka.stream.alpakka.ftp.scaladsl.SftpApi

final def asInstanceOf[T0]: T0

Definition Classes: Any

def clone(): AnyRef

Attributes: protected[java.lang]
Definition Classes: AnyRef
Annotations: @native() @HotSpotIntrinsicCandidate() @throws( ... )

def createBrowserGraph(_basePath: String, _connectionSettings: S, _branchSelector: (FtpFile) ⇒ Boolean, _emitTraversedDirectories: Boolean)(implicit _ftpLike: FtpLike[SSHClient, S]): FtpBrowserGraphStage[SSHClient, S]

Attributes: protected[this]
Definition Classes: FtpSourceFactory

def createBrowserGraph(_basePath: String, _connectionSettings: S, _branchSelector: (FtpFile) ⇒ Boolean)(implicit _ftpLike: FtpLike[SSHClient, S]): FtpBrowserGraphStage[SSHClient, S]

Attributes: protected[this]
Definition Classes: FtpSourceFactory

def createIOSink(_path: String, _connectionSettings: S, _append: Boolean)(implicit _ftpLike: FtpLike[SSHClient, S]): FtpIOSinkStage[SSHClient, S]

Attributes: protected[this]
Definition Classes: FtpSourceFactory

def createIOSource(_path: String, _connectionSettings: S, _chunkSize: Int, _offset: Long)(implicit _ftpLike: FtpLike[SSHClient, S]): FtpIOSourceStage[SSHClient, S]

Attributes: protected[this]
Definition Classes: FtpSourceFactory

def createIOSource(_path: String, _connectionSettings: S, _chunkSize: Int)(implicit _ftpLike: FtpLike[SSHClient, S]): FtpIOSourceStage[SSHClient, S]

Attributes: protected[this]
Definition Classes: FtpSourceFactory

def createMkdirGraph(baseDirectoryPath: String, dirName: String, currentConnectionSettings: S)(implicit _ftpLike: FtpLike[SSHClient, S]): FtpDirectoryOperationsGraphStage[SSHClient, S]

Attributes: protected[this]
Definition Classes: FtpSourceFactory

def createMoveSink(_destinationPath: (FtpFile) ⇒ String, _connectionSettings: S)(implicit _ftpLike: FtpLike[SSHClient, S]): GraphStageWithMaterializedValue[SinkShape[FtpFile], Future[IOResult]] with FtpMoveSink[SSHClient, S]

Attributes: protected[this]
Definition Classes: FtpSourceFactory

def createRemoveSink(_connectionSettings: S)(implicit _ftpLike: FtpLike[SSHClient, S]): GraphStageWithMaterializedValue[SinkShape[FtpFile], Future[IOResult]] with FtpRemoveSink[SSHClient, S]

Attributes: protected[this]
Definition Classes: FtpSourceFactory

def defaultSettings(hostname: String, username: Option[String], password: Option[String]): SftpSettings

Attributes: protected
Definition Classes: SftpDefaultSettings

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, Future[IOResult]]

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

path: the file path
connectionSettings: connection setting
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 Future of IOResult

Definition Classes: FtpApi

def fromPath(path: String, connectionSettings: S, chunkSize: Int = DefaultChunkSize): Source[ByteString, Future[IOResult]]

Scala 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 Future of IOResult

Definition Classes: FtpApi

def fromPath(host: String, username: String, password: String, path: String): Source[ByteString, Future[IOResult]]

Scala 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 Future of IOResult

Definition Classes: FtpApi

def fromPath(host: String, path: String): Source[ByteString, Future[IOResult]]

Scala 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 Future of IOResult

Definition Classes: FtpApi

val ftpBrowserSourceName: String

Attributes: protected
Definition Classes: SftpSource → FtpSourceFactory

val ftpClient: () ⇒ SSHClient

Attributes: protected
Definition Classes: SftpSource → FtpSourceFactory

val ftpDirectorySourceName: String

Attributes: protected
Definition Classes: SftpSource → FtpSourceFactory

val ftpIOSinkName: String

Attributes: protected
Definition Classes: SftpSource → FtpSourceFactory

val ftpIOSourceName: String

Attributes: protected
Definition Classes: SftpSource → FtpSourceFactory

val ftpLike: FtpLike[SSHClient, S]

Attributes: protected[this]
Definition Classes: SftpSourceParams

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: (FtpFile) ⇒ Boolean, emitTraversedDirectories: Boolean): Source[FtpFile, NotUsed]

Scala 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 function for pruning the tree. Takes a remote folder and return true if you want to enter that remote folder. Default behaviour is fully 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: FtpApi

def ls(basePath: String, connectionSettings: S, branchSelector: (FtpFile) ⇒ Boolean): Source[FtpFile, NotUsed]

Scala 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 function for pruning the tree. Takes a remote folder and return true if you want to enter that remote folder. Default behaviour is fully 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: FtpApi

def ls(basePath: String, connectionSettings: S): Source[FtpFile, NotUsed]

Scala 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: FtpApi

def ls(host: String, username: String, password: String, basePath: String): Source[FtpFile, NotUsed]

Scala 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: FtpApi

def ls(host: String, username: String, password: String): Source[FtpFile, NotUsed]

Scala 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: FtpApi

def ls(host: String, basePath: String): Source[FtpFile, NotUsed]

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

Scala 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: FtpApi

def ls(host: String): Source[FtpFile, NotUsed]

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

Scala 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: FtpApi

def mkdir(basePath: String, name: String, connectionSettings: S): Source[Done, NotUsed]

Scala 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 akka.Done

Definition Classes: FtpApi

def mkdirAsync(basePath: String, name: String, connectionSettings: S)(implicit mat: Materializer): Future[Done]

Scala 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: Future of akka.Done indicating a materialized, asynchronous request

Definition Classes: FtpApi

def move(destinationPath: (FtpFile) ⇒ String, connectionSettings: S): Sink[FtpFile, Future[IOResult]]

Scala 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 Future of IOResult

Definition Classes: FtpApi

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, Future[IOResult]]

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

connectionSettings: connection settings
returns: A Sink of FtpFile that materializes to a Future of IOResult

Definition Classes: FtpApi

final val sFtpBrowserSourceName: String("sFtpBrowserSource")

Attributes: protected
Definition Classes: SftpSource

final val sFtpDirectorySource: String("sFtpDirectorySource")

Attributes: protected
Definition Classes: SftpSource

final val sFtpIOSinkName: String("sFtpIOSink")

Attributes: protected
Definition Classes: SftpSource

final val sFtpIOSourceName: String("sFtpIOSource")

Attributes: protected
Definition Classes: SftpSource

def sshClient(): SSHClient

Definition Classes: SftpSource

final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes: AnyRef

def toPath(path: String, connectionSettings: S, append: Boolean = false): Sink[ByteString, Future[IOResult]]

Scala 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 Future of IOResult

Definition Classes: FtpApi

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: @native() @throws( ... )

final def wait(): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

Packages

Sftp

object Sftp extends SftpApi

Type Members

Value Members

Deprecated Value Members

Inherited from SftpApi

Inherited from SftpSourceParams

Inherited from SftpDefaultSettings

Inherited from SftpSource

Inherited from FtpSourceFactory[SSHClient]

Inherited from FtpApi[SSHClient]

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Sftp 

object Sftp extends SftpApi

Type Members

Value Members

Deprecated Value Members

Inherited from SftpApi

Inherited from SftpSourceParams

Inherited from SftpDefaultSettings

Inherited from SftpSource

Inherited from FtpSourceFactory[SSHClient]

Inherited from FtpApi[SSHClient]

Inherited from AnyRef

Inherited from Any

Ungrouped

Sftp