Robot Framework SSH Library
SSHLibrary.javaclient.SFTPClient Class Reference
Inheritance diagram for SSHLibrary.javaclient.SFTPClient:
SSHLibrary.abstractclient.AbstractSFTPClient SSHLibrary.javaclient.SCPTransferClient

Public Member Functions

def __init__ (self, ssh_client, encoding)
 
- Public Member Functions inherited from SSHLibrary.abstractclient.AbstractSFTPClient
def __init__ (self, encoding)
 
def is_file (self, path)
 Checks if the path points to a regular file on the remote host. More...
 
def is_dir (self, path)
 Checks if the path points to a directory on the remote host. More...
 
def list_dir (self, path, pattern=None, absolute=False)
 Gets the item names, or optionally the absolute paths, on the given path on the remote host. More...
 
def list_files_in_dir (self, path, pattern=None, absolute=False)
 Gets the file names, or optionally the absolute paths, of the regular files on the given path on the remote host. More...
 
def list_dirs_in_dir (self, path, pattern=None, absolute=False)
 Gets the directory names, or optionally the absolute paths, on the given path on the remote host. More...
 
def get_directory (self, source, destination, scp_preserve_time, path_separator='/', recursive=False)
 
def build_destination (self, source, destination, path_separator)
 Add parent directory from source to destination path if destination is '. More...
 
def get_parent_folder (self, source, path_separator)
 
def get_file (self, source, destination, scp_preserve_times, path_separator='/')
 Downloads file(s) from the remote host to the local machine. More...
 
def put_directory (self, source, destination, scp_preserve_times, mode, newline, path_separator='/', recursive=False)
 Uploads directory(-ies) from the local machine to the remote host, optionally with subdirectories included. More...
 
def put_file (self, sources, destination, scp_preserve_times, mode, newline, path_separator='/')
 Uploads the file(s) from the local machine to the remote host. More...
 
def create_local_ssh_tunnel (self, local_port, remote_host, remote_port, client)
 

Private Member Functions

def _list (self, path)
 
def _stat (self, path)
 
def _create_remote_file (self, destination, mode)
 
def _write_to_remote_file (self, remote_file, data, position)
 
def _close_remote_file (self, remote_file)
 
def _get_file (self, remote_path, local_path, scp_preserve_times)
 
def _absolute_path (self, path)
 
def _readlink (self, path)
 

Private Attributes

 _client
 

Detailed Description

Definition at line 153 of file javaclient.py.

Constructor & Destructor Documentation

◆ __init__()

def SSHLibrary.javaclient.SFTPClient.__init__ (   self,
  ssh_client,
  encoding 
)

Reimplemented in SSHLibrary.javaclient.SCPTransferClient.

Definition at line 155 of file javaclient.py.

Member Function Documentation

◆ _absolute_path()

def SSHLibrary.javaclient.SFTPClient._absolute_path (   self,
  path 
)
private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Definition at line 206 of file javaclient.py.

◆ _close_remote_file()

def SSHLibrary.javaclient.SFTPClient._close_remote_file (   self,
  remote_file 
)
private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Definition at line 182 of file javaclient.py.

◆ _create_remote_file()

def SSHLibrary.javaclient.SFTPClient._create_remote_file (   self,
  destination,
  mode 
)
private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Definition at line 169 of file javaclient.py.

◆ _get_file()

def SSHLibrary.javaclient.SFTPClient._get_file (   self,
  remote_path,
  local_path,
  scp_preserve_times 
)
private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Reimplemented in SSHLibrary.javaclient.SCPTransferClient.

Definition at line 185 of file javaclient.py.

◆ _list()

def SSHLibrary.javaclient.SFTPClient._list (   self,
  path 
)
private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Definition at line 160 of file javaclient.py.

◆ _readlink()

def SSHLibrary.javaclient.SFTPClient._readlink (   self,
  path 
)
private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Definition at line 209 of file javaclient.py.

◆ _stat()

def SSHLibrary.javaclient.SFTPClient._stat (   self,
  path 
)
private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Definition at line 165 of file javaclient.py.

◆ _write_to_remote_file()

def SSHLibrary.javaclient.SFTPClient._write_to_remote_file (   self,
  remote_file,
  data,
  position 
)
private

Reimplemented from SSHLibrary.abstractclient.AbstractSFTPClient.

Definition at line 179 of file javaclient.py.

Member Data Documentation

◆ _client

SSHLibrary.javaclient.SFTPClient._client
private

Definition at line 156 of file javaclient.py.


The documentation for this class was generated from the following file: