Ssh2Connections::SftpConnection Class Reference

class for SFTP connections; returns an object of class Qore::SSH2::SFTPClient for acquiring files from or posting files to SFTP servers More...

Inheritance diagram for Ssh2Connections::SftpConnection:

Public Member Functions
	constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	creates the SftpConnection object More...
string	getType ()
	returns "sftp"
*hash	getRuntimeOptions ()
	returns runtime options More...
Public Member Functions inherited from Ssh2Connections::AbstractSsh2Connection
	constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	creates the SftpConnection object More...
hash	getOptions ()
	returns valid options More...

Static Public Member Functions
static SftpConnection	make (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	static constructor

Private Member Functions
Qore::SSH2::SFTPClient	getImpl (bool connect=True, *hash rtopts)
	returns a Qore::SSH2::SFTPClient object More...

Detailed Description

class for SFTP connections; returns an object of class Qore::SSH2::SFTPClient for acquiring files from or posting files to SFTP servers

supports the following option:

• "keyfile": a path to a private key file in PEM format to use for key-based authentication (environment variables can be prefixed with "$" in the path (or optionally enclosed in curly brackets as in "${var}") and will be substituted with the value of the environment variable)

additionally, the following runtime options are supported in getImpl():

• "path": overrides the path component in the URL at runtime
• "path_add": appends the given string to the path component of the URL at runtime

Member Function Documentation

constructor()

Ssh2Connections::SftpConnection::constructor	(	string	name,
		string	desc,
		string	url,
		bool	monitor,
		*hash	opts,
		hash	urlh
	)

creates the SftpConnection object

Parameters

name	the name of the connection
desc	connection description
url	connection URL
monitor	monitoring flag
opts	connection options
urlh	broken down URL hash (as returned by Qore::parse_url())

getImpl()

Qore::SSH2::SFTPClient Ssh2Connections::SftpConnection::getImpl ( bool  connect = True, *hash  rtopts  )

private

returns a Qore::SSH2::SFTPClient object

Parameters

connect	if True, then Qore::SSH2::SFTPClient::connect() is called and also if there is any path in the URL then Qore::SSH2::SFTPClient::chdir() is called on that path
rtopts	this object takes the following runtime options: "path": overrides the path component in the URL at runtime "path_add": appends the given string to the path component of the URL at runtime

Returns

a Qore::SSH2::SFTPClient object

getRuntimeOptions()

*hash Ssh2Connections::SftpConnection::getRuntimeOptions

(

)

returns runtime options

return a hash with the following keys reflecting support for the corresponding runtime options in getImpl():

• "path": overrides the path component in the URL at runtime
• "path_add": appends the given string to the path component of the URL at runtime