FtpClientDataProvider.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
namespace FtpClientDataProvider {
class FtpClientDataProvider : public AbstractDataProvider {
public:
const ProviderInfo = <DataProviderInfo>{
"type": "FtpClientDataProvider",
"constructor_options": ConstructorOptions,
"supports_children": True,
"children_can_support_apis": True,
"children_can_support_records": False,
"children_can_support_observers": False,
};
const ConstructorOptions = {
"timeout": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(IntType),
"desc": "I/O timeout to use in milliseconds",
},
"url": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "A URL for an FTP or FTPS connection",
"required": True,
},
};
FtpClient ftp;
protected:
const ChildMap = {
"create-file": Class::forName("FtpClientDataProvider::FtpClientCreateFileDataProvider"),
"delete": Class::forName("FtpClientDataProvider::FtpClientDeleteDataProvider"),
"get-file": Class::forName("FtpClientDataProvider::FtpClientGetFileDataProvider"),
"list": Class::forName("FtpClientDataProvider::FtpClientListDataProvider"),
"mkdir": Class::forName("FtpClientDataProvider::FtpClientMkdirDataProvider"),
"move": Class::forName("FtpClientDataProvider::FtpClientMoveDataProvider"),
"stat": Class::forName("FtpClientDataProvider::FtpClientStatDataProvider"),
};
public:
constructor(*hash<auto> options);
constructor(FtpClient ftp);
string getName();
*string getDesc();
*list<hash<DataProviderSummaryInfo>> getChildProviderSummaryInfo();
static FtpClient getFtpClientConnection(hash<auto> options);
static string getPath(FtpClient ftp, string path1);
protected:
*list<string> getChildProviderNamesImpl();
public:
protected:
*AbstractDataProvider getChildProviderImpl(string name);
public:
protected:
hash<DataProviderInfo> getStaticInfoImpl();
public:
};
};
FtpClientDataProvider::FtpClientDataProvider::getName
string getName()
Returns the data provider name.
FtpClientDataProvider::FtpClientDataProvider::getChildProviderNamesImpl
*list< string > getChildProviderNamesImpl()
Returns a list of child data provider names, if any.
FtpClientDataProvider::FtpClientDataProvider::getChildProviderSummaryInfo
*list< hash< DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
FtpClientDataProvider::FtpClientDataProvider::getChildProviderImpl
*AbstractDataProvider getChildProviderImpl(string name)
Returns the given child provider or NOTHING if the given child is unknown.
FtpClientDataProvider::FtpClientDataProvider::getFtpClientConnection
static FtpClient getFtpClientConnection(hash< auto > options)
Returns an FTP connection from constructor options.
FtpClientDataProvider::FtpClientDataProvider::constructor
constructor(FtpClient ftp)
Creates the object from an FTP connection.
FtpClientDataProvider::FtpClientDataProvider::getDesc
*string getDesc()
Returns the data provider description.
FtpClientDataProvider::FtpClientDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
FtpClientDataProvider::FtpClientDataProvider::getStaticInfoImpl
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
FtpClientDataProvider::FtpClientDataProvider::getPath
static string getPath(FtpClient ftp, string path1)
Returns the path based on the FtpClient's base path.
True
const True
False
const False
FtpClientDataProvider
Qore FtpClientDataProvider module definition.
Definition: FtpClientCreateFileDataProvider.qc.dox.h:26