janalyse-ssh
API
Generated with
janalyse-ssh/fr.janalyse.ssh/SSHFtp

SSHFtp

fr.janalyse.ssh.SSHFtp
See theSSHFtp companion object
class SSHFtp(implicit ssh: SSH) extends TransfertOperations, SSHLazyLogging

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def cd(path: String): Unit

Change the working directory on the remote system

Change the working directory on the remote system

Value parameters

path

The new working directory, relative to the current one

Attributes

def chgrp(gid: Int, path: String): Unit

Change file group

Change file group

Value parameters

gid

New Owner Group Identifier

path

The path of the remote file or directory to change group

Attributes

def chmod(permissions: String, path: String): Unit

Change file modes

Change file modes

Value parameters

path

The path of the remote file or directory to change permissions

permissions

The new permissions in octal string format

Attributes

def chmod(permissions: Int, path: String): Unit

Change file modes

Change file modes

Value parameters

path

The path of the remote file or directory to change permissions

permissions

The new permissions

Attributes

def chown(uid: Int, path: String): Unit

Change file owner

Change file owner

Value parameters

path

The path of the remote file or directory to change owner

uid

New Owner User Identifier

Attributes

def close(): Unit
override def get(filename: String): Option[String]

get remote file content as an optional String

get remote file content as an optional String

Value parameters

remoteFilename

file content to get

Attributes

Returns

Some content or None if file was not found

Definition Classes
override def getBytes(filename: String): Option[Array[Byte]]

get remote file content as an optional bytes array

get remote file content as an optional bytes array

Value parameters

remoteFilename

file content to get

Attributes

Returns

Some content or None if file was not found

Definition Classes
def getStream(filename: String): Option[InputStream]

get remote file content as an optional InputStream

get remote file content as an optional InputStream

Value parameters

filename

file content to get

Attributes

Returns

Some content or None if file was not found

def ls(path: String): List[LsEntry]

List contents of a remote directory

List contents of a remote directory

Value parameters

path

The path of the directory on the remote system

Attributes

def mkdir(path: String): Unit

Creates a directory on a remote system

Creates a directory on a remote system

Value parameters

path

The name of the directory to create

Attributes

override def put(data: String, remoteFilename: String): Unit

upload string content to a remote file, if file already exists, it is overwritten

upload string content to a remote file, if file already exists, it is overwritten

Value parameters

data

content to upload in the remote file

remoteDestination

remote destination

Attributes

Definition Classes
override def putBytes(data: Array[Byte], remoteFilename: String): Unit

upload bytes array content to a remote file, if file already exists, it is overwritten

upload bytes array content to a remote file, if file already exists, it is overwritten

Value parameters

data

content to upload in the remote file

remoteDestination

remote destination

Attributes

Definition Classes
override def putFromStream(data: InputStream, howmany: Int, remoteDestination: String): Unit

upload bytes coming from the input stream to a remote file, if file already exists, it is overwritten

upload bytes coming from the input stream to a remote file, if file already exists, it is overwritten

Value parameters

data

input stream

howmany

how much data to write to remote destination

remoteDestination

remote destination

Attributes

Definition Classes
def putFromStream(data: InputStream, remoteDestination: String): Unit
def pwd(): String

Print Working Directory: returns the current remote directory in absolute form.

Print Working Directory: returns the current remote directory in absolute form.

Attributes

def realpath(path: String): String

converts a remote path to its absolute (and to a certain degree canonical) version.

converts a remote path to its absolute (and to a certain degree canonical) version.

Attributes

override def receive(remoteFilename: String, outputStream: OutputStream): Unit

Copy a remote file to a local one

Copy a remote file to a local one

Value parameters

outputStream

Destination stream (local system)

remoteFilename

Source file name (on remote system)

Attributes

Definition Classes
def rename(origin: String, dest: String): Unit

Rename a remote file or directory

Rename a remote file or directory

Value parameters

dest

Destination (new) remote file name

origin

Original remote file name

Attributes

def rm(path: String): Unit

Remove a file from a remote system

Remove a file from a remote system

Value parameters

path

The path of the remote file to remove

Attributes

def rmdir(path: String): Unit

Remove a directory from a remote system

Remove a directory from a remote system

Value parameters

path

The path of the directory to remove

Attributes

override def send(localFile: File, remoteFilename: String): Unit

Copy a local file to a remote one

Copy a local file to a remote one

Value parameters

fromLocalFile

Source file (local system)

remoteDestination

Destination file name (on remote system)

Attributes

Definition Classes

Inherited methods

def localmd5sum(filename: String): Option[String]

locale file md5sum

locale file md5sum

Value parameters

filename

file name

Attributes

Returns

md5sum as an optional String, or None if filename was not found

Inherited from:
CommonOperations
def receive(filename: String): Unit

Copy a remote file to a local one using the same filename

Copy a remote file to a local one using the same filename

Value parameters

filename

file name

Attributes

Inherited from:
TransfertOperations
def receive(remoteFilename: String, localFilename: String): Unit

Copy a remote file to a local one

Copy a remote file to a local one

Value parameters

localFilename

Destination file name (local system)

remoteFilename

Source file name (on remote system)

Attributes

Inherited from:
TransfertOperations
def receive(remoteFilename: String, toLocalFile: File): Unit

Copy a remote file to a local one

Copy a remote file to a local one

Value parameters

remoteFilename

Source file name (on remote system)

toLocalFile

Destination file (local system)

Attributes

Inherited from:
TransfertOperations
def receiveNcompress(remoteFilename: String, localDirectory: File, localBasename: String): File

Copy and compress (if required) a remote file to a local one

Copy and compress (if required) a remote file to a local one

Value parameters

localDirectory

Destination directory

localFilename

Destination file name (local system), compressed extension may be added to it

remoteFilename

Source file name (on remote system)

Attributes

Returns

local file used

Inherited from:
TransfertOperations
def receiveNcompress(remoteFilename: String, localFilename: String): File

Copy and compress (if required) a remote file to a local one

Copy and compress (if required) a remote file to a local one

Value parameters

localFilename

Destination filename (without compressed extension)

remoteFilename

Source file name (on remote system)

Attributes

Returns

local file used

Inherited from:
TransfertOperations
def send(filename: String): Unit

Copy a local file to a remote one using the same name

Copy a local file to a remote one using the same name

Value parameters

filename

file name

Attributes

Inherited from:
TransfertOperations
def send(fromLocalFilename: String, remoteDestination: String): Unit

Copy a local file to a remote one

Copy a local file to a remote one

Value parameters

fromLocalFilename

Source file name (local system)

remoteDestination

Destination file name (on remote system)

Attributes

Inherited from:
TransfertOperations

Inherited fields

val logger: Logger

Attributes

Inherited from:
SSHLazyLogging
Generated with