SftpClientDataProvider::SftpClientDataProvider Class Reference

The SFTP client data provider class, provides API classes as children. More...

#include <SftpClientDataProvider.qc.dox.h>

Inherits AbstractDataProvider.

Public Member Methods
void	constructor (soft< hash< auto > > options)
	Creates the object from constructor options.
void	constructor (SFTPClient sftp)
	Creates the object from an SFTP connection.
string	getName ()
	Returns the data provider name.
soft< string >	getDesc ()
	Returns the data provider description.
soft< list< hash< DataProviderSummaryInfo > > >	getChildProviderSummaryInfo ()
	Return data provider summary info.
soft< list< string > >	getChildProviderNamesImpl ()
	Returns a list of child data provider names, if any.
soft< AbstractDataProvider >	getChildProviderImpl (string name)
	Returns the given child provider or nothing if the given child is unknown.
hash< DataProviderInfo >	getStaticInfoImpl ()
	Returns data provider static info.

Static Public Member Methods
static SFTPClient	getSftpClientConnection (hash< auto > options)
	Returns an SFTP connection from constructor options.
static string	getPath (SFTPClient sftp, string path1)
	Returns the path based on the SftpClient's base path.

Public Attributes
const auto	ProviderInfo = ...
	Provider info.
const auto	ConstructorOptions = ...
	Constructor arguments.

Detailed Description

The SFTP client data provider class, provides API classes as children.

Member Function Documentation

getChildProviderImpl()

soft< AbstractDataProvider > SftpClientDataProvider::SftpClientDataProvider::getChildProviderImpl

(

string

name

)

Returns the given child provider or nothing if the given child is unknown.

Returns

the given child provider or nothing if the given child is unknown

See also

getChildProviderEx()

getChildProviderNamesImpl()

soft< list< string > > SftpClientDataProvider::SftpClientDataProvider::getChildProviderNamesImpl

(

)

Returns a list of child data provider names, if any.

Returns

a list of child data provider names, if any

---

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

• doxygen/qlib/SftpClientDataProvider/SftpClientDataProvider.qc.dox.h