SftpClientDataProvider::SftpClientListDataProvider Class Reference

The SFTP client list data provider class. More...

#include <SftpClientListDataProvider.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.
auto	doRequestImpl (auto req, soft< hash< auto > > request_options)
	Makes a request and returns the response.
soft< AbstractDataProviderType >	getRequestTypeImpl ()
	Returns the description of a successful request message, if any.
soft< AbstractDataProviderType >	getResponseTypeImpl ()
	Returns the description of a response message, if this object represents a response message.
hash< DataProviderInfo >	getStaticInfoImpl ()
	Returns data provider static info.

Public Attributes
SFTPClient	sftp
	SFTP connection.
const auto	ProviderInfo = ...
	Provider info.
const auto	ProviderSummaryInfo = ...
	Provider summary info.
const auto	RequestType = ...
	Request type.
const auto	ResponseType = ...
	Response type.

Detailed Description

The SFTP client list data provider class.

Member Function Documentation

doRequestImpl()

auto SftpClientDataProvider::SftpClientListDataProvider::doRequestImpl	(	auto	req,
		soft< hash< auto > >	request_options
	)

Makes a request and returns the response.

Parameters

req	the request info
request_options	the request options; will be processed by validateRequestOptions()

Returns

the response to the request

Exceptions

LIST-ERROR

if the path cannot be read

getRequestTypeImpl()

soft< AbstractDataProviderType > SftpClientDataProvider::SftpClientListDataProvider::getRequestTypeImpl

(

)

Returns the description of a successful request message, if any.

Returns

the request type for this provider

getResponseTypeImpl()

soft< AbstractDataProviderType > SftpClientDataProvider::SftpClientListDataProvider::getResponseTypeImpl

(

)

Returns the description of a response message, if this object represents a response message.

Returns

the response type for this response message

---

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

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