| Qore RestClientDataProvider Module Reference 2.0.1

Loading...
Searching...
No Matches
RestClientDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
24
26 namespace RestClientDataProvider {
28 const AppName = "GenericRest";
29
31 class RestClientDataProvider : public RestClientDataProviderBase {
32
33 public:
35 const ProviderInfo = ...;
36
37
39 const ConstructorOptions = ...;
40
41
42 protected:
43 const ChildMap = ...;
44
45
46 public:
47
49 constructor(*hash<auto> options);
50
51
53 constructor(RestClient rest) ;
54
55
57 string getName();
58
59
61 *string getDesc();
62
63
65 *list<hash<DataProviderSummaryInfo>> getChildProviderSummaryInfo();
66
67
69 setLogger(*LoggerInterface logger);
70
71
73 static RestClient getRestConnection(hash<auto> options);
74
76 static hash<auto> makeRequest(RestClient rest, string meth, auto body, string path, *hash<auto> hdr);
77
79 static hash<auto> processRestOptions(hash<auto> options);
80
82
84 protected:
85 *list<string> getChildProviderNamesImpl();
86 public:
87
88
90
94 protected:
95 *AbstractDataProvider getChildProviderImpl(string name);
96 public:
97
98
100 protected:
101 hash<DataProviderInfo> getStaticInfoImpl();
102 public:
103
104};
105};
RestClientDataProvider::RestClientDataProviderBase
The REST client data provider class, provides API classes as children.
Definition RestClientDataProviderBase.qc.dox.h:28
RestClientDataProvider::RestClientDataProviderBase::rest
RestClient::RestClient rest
The REST client object.
Definition RestClientDataProviderBase.qc.dox.h:33
RestClientDataProvider::RestClientDataProvider::makeRequest
static hash< auto > makeRequest(RestClient rest, string meth, auto body, string path, *hash< auto > hdr)
Makes a REST request and returns the response.
RestClientDataProvider::RestClientDataProvider::getChildProviderNamesImpl
*list< string > getChildProviderNamesImpl()
Returns a list of child data provider names, if any.
RestClientDataProvider::RestClientDataProvider::getChildProviderImpl
*AbstractDataProvider getChildProviderImpl(string name)
Returns the given child provider or NOTHING if the given child is unknown.
RestClientDataProvider::RestClientDataProvider::getStaticInfoImpl
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
RestClientDataProvider::RestClientDataProvider::ConstructorOptions
const ConstructorOptions
Constructor arguments.
Definition RestClientDataProvider.qc.dox.h:39
RestClientDataProvider::RestClientDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
RestClientDataProvider::RestClientDataProvider::getDesc
*string getDesc()
Returns the data provider description.
RestClientDataProvider::RestClientDataProvider::constructor
constructor(RestClient rest)
Creates the object from a REST connection.
RestClientDataProvider::RestClientDataProvider::getName
string getName()
Returns the data provider name.
RestClientDataProvider::RestClientDataProvider::setLogger
setLogger(*LoggerInterface logger)
Accepts a LoggerInterface object for logging (or clears it)
RestClientDataProvider::RestClientDataProvider::getChildProviderSummaryInfo
*list< hash< DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
RestClientDataProvider::RestClientDataProvider::processRestOptions
static hash< auto > processRestOptions(hash< auto > options)
Processes common REST options.
RestClientDataProvider::RestClientDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition RestClientDataProvider.qc.dox.h:35
RestClientDataProvider::RestClientDataProvider::getRestConnection
static RestClient getRestConnection(hash< auto > options)
Returns a REST connection.
RestClientDataProvider
Qore RestClientDataProvider module definition.
Definition RestClientCallDataProvider.qc.dox.h:26
RestClientDataProvider::AppName
const AppName
Application name.
Definition RestClientDataProvider.qc.dox.h:28
RestClient