Qore RestClientDataProvider Module Reference 2.0
Loading...
Searching...
No Matches
RestClientDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
26namespace RestClientDataProvider {
28const AppName = "GenericRest";
29
32
33public:
35 const ProviderInfo = ...;
36
37
39 const ConstructorOptions = ...;
40
41
42protected:
43 const ChildMap = ...;
44
45
46public:
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, *data body, string path, *hash<auto> hdr);
77
79 static hash<auto> processRestOptions(hash<auto> options);
80
82
84protected:
86public:
87
88
90
94protected:
95 *AbstractDataProvider getChildProviderImpl(string name);
96public:
97
98
100protected:
101 hash<DataProviderInfo> getStaticInfoImpl();
102public:
103
104};
105};
The REST client data provider class, provides API classes as children.
Definition RestClientDataProviderBase.qc.dox.h:28
*list< string > getChildProviderNamesImpl()
Returns a list of child data provider names, if any.
*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.
constructor(*hash< auto > options)
Creates the object from constructor options.
*string getDesc()
Returns the data provider description.
constructor(RestClient rest)
Creates the object from a REST connection.
string getName()
Returns the data provider name.
setLogger(*LoggerInterface logger)
Accepts a LoggerInterface object for logging (or clears it)
*list< hash< DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
static hash< auto > processRestOptions(hash< auto > options)
Processes common REST options.
static hash< auto > makeRequest(RestClient rest, string meth, *data body, string path, *hash< auto > hdr)
Makes a REST request and returns the response.
static RestClient getRestConnection(hash< auto > options)
Returns a REST connection.
Qore RestClientDataProvider module definition.
Definition RestClientCallDataProvider.qc.dox.h:26
const AppName
Application name.
Definition RestClientDataProvider.qc.dox.h:28