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...

#include <Ssh2Connections.qm.dox.h>

Inheritance diagram for Ssh2Connections::SftpConnection:

Public Member Methods
	constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
	creates the SftpConnection object More...
string	getType ()
	returns "sftp"
*hash< auto >	getRuntimeOptions ()
	returns runtime options More...
Public Member Methods inherited from Ssh2Connections::AbstractSsh2Connection
	constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
	creates the AbstractSsh2Connection object More...

Public Attributes
const	ConnectionScheme
	Connection entry info.

Private Member Methods
Qore::SSH2::SFTPClient	getImpl (bool connect=True, *hash< auto > rtopts)
	returns a Qore::SSH2::SFTPClient object More...
hash< ConnectionSchemeInfo >	getConnectionSchemeInfoImpl ()
	Returns the ConnectionSchemeInfo hash for this object.

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	description,
		string	url,
		hash< auto >	attributes = {},
		hash< auto >	options = {}
	)

creates the SftpConnection object

Parameters

name	the name of the connection
description	connection description
url	connection URL (potentially with password info)
attributes	various attributes. See below
options	connection options

See AbstractConnection::constructor() for attributes and options reference.

getImpl()

Qore::SSH2::SFTPClient Ssh2Connections::SftpConnection::getImpl ( bool  connect = True, *hash< auto >  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< auto > 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

---

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

• doxygen/qlib/Ssh2Connections/Ssh2Connections.qm.dox.h