32 const ProviderInfo = <DataProviderInfo>{
33 "type":
"HttpClientDataProvider",
34 "constructor_options": ConstructorOptions,
35 "supports_children":
True,
36 "children_can_support_apis":
True,
37 "children_can_support_records":
False,
38 "children_can_support_observers":
False,
42 const ConstructorOptions = {
43 "assume_encoding": <DataProviderOptionInfo>{
44 "type": AbstractDataProviderType::get(StringType),
45 "desc":
"Assumes the given encoding if the server does not send a `charset` value",
47 "connect_timeout": <DataProviderOptionInfo>{
48 "type": AbstractDataProviderType::get(IntType),
49 "desc":
"The connection timeout to use in milliseconds (default: 45 seconds)",
50 "default_value": 45000,
52 "error_passthru": <DataProviderOptionInfo>{
53 "type": AbstractDataProviderType::get(BoolType),
54 "desc":
"If `True` then HTTP status codes indicating errors will not cause an "
55 "`HTTP-CLIENT-RECEIVE-ERROR` exception to be raised, rather such responses will be "
56 "passed through to the caller like any other response",
57 "default_value":
False,
59 "http_version": <DataProviderOptionInfo>{
60 "type": AbstractDataProviderType::get(StringType),
61 "desc":
"HTTP version to use (`1.0` or `1.1`, defaults to `1.1`)",
62 "default_value":
"1.1",
66 "desc":
"Use HTTP version \"1.0\"",
67 }, <AllowedValueInfo>{
69 "desc":
"Use HTTP version \"1.1\" (the default)",
73 "max_redirects": <DataProviderOptionInfo>{
74 "type": AbstractDataProviderType::get(IntType),
75 "desc":
"Maximum redirects to support",
77 "proxy": <DataProviderOptionInfo>{
78 "type": AbstractDataProviderType::get(StringType),
79 "desc":
"The proxy URL to use",
81 "redirect_passthru": <DataProviderOptionInfo>{
82 "type": AbstractDataProviderType::get(BoolType),
83 "desc":
"if `True` then redirect responses will be passed to the caller instead of processed",
84 "default_value":
False,
86 "ssl_cert_der": <DataProviderOptionInfo>{
87 "type": AbstractDataProviderType::get(BoolType),
88 "desc":
"If `True` then the data represented by `ssl_cert_location` will be assumed to be in binary "
90 "default_value":
False,
92 "ssl_cert_location": <DataProviderOptionInfo>{
93 "type": AbstractDataProviderType::get(StringType,
NOTHING, {
95 DTT_FromLocation:
True,
97 "desc":
"A path or location to an X.509 client certificate file",
99 "ssl_key_der": <DataProviderOptionInfo>{
100 "type": AbstractDataProviderType::get(BoolType),
101 "desc":
"If `True` then the data represented by `ssl_key_location` will be assumed to be in binary "
103 "default_value":
False,
105 "ssl_key_location": <DataProviderOptionInfo>{
106 "type": AbstractDataProviderType::get(StringType,
NOTHING, {
108 DTT_FromLocation:
True,
110 "desc":
"A path or location to a private key file for the X.509 client certificate",
112 "ssl_key_password": <DataProviderOptionInfo>{
113 "type": AbstractDataProviderType::get(StringType),
114 "desc":
"The password to the private key given with `ssl_key_path` (text PEM format only)",
117 "ssl_verify_cert": <DataProviderOptionInfo>{
118 "type": AbstractDataProviderType::get(BoolType),
119 "desc":
"if `True` then the server's certificate will only be accepted if it's verified",
120 "default_value":
False,
122 "timeout": <DataProviderOptionInfo>{
123 "type": AbstractDataProviderType::get(IntType),
124 "desc":
"Transfer timeout to use in milliseconds (default: 45 seconds)",
125 "default_value": 45000,
127 "url": <DataProviderOptionInfo>{
128 "type": AbstractDataProviderType::get(StringType),
129 "desc":
"A URL for an HTTP or HTTPS connection",
138 "call": Class::forName(
"HttpClientDataProvider::HttpClientCallDataProvider"),
139 "delete": Class::forName(
"HttpClientDataProvider::HttpClientDeleteDataProvider"),
140 "get": Class::forName(
"HttpClientDataProvider::HttpClientGetDataProvider"),
141 "head": Class::forName(
"HttpClientDataProvider::HttpClientHeadDataProvider"),
142 "options": Class::forName(
"HttpClientDataProvider::HttpClientOptionsDataProvider"),
143 "patch": Class::forName(
"HttpClientDataProvider::HttpClientPatchDataProvider"),
144 "post": Class::forName(
"HttpClientDataProvider::HttpClientPostDataProvider"),
145 "put": Class::forName(
"HttpClientDataProvider::HttpClientPutDataProvider"),
174 static hash<auto>
makeRequest(HTTPClient http,
string meth, *data body,
string path, *hash<auto> hdr);
*string getDesc()
Returns the data provider description.
*list< hash< DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
constructor(*hash< auto > options)
Creates the object from constructor options.
string getName()
Returns the data provider name.
*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(HTTPClient http)
Creates the object from an HTTP connection.
static HTTPClient getHttpConnection(hash< auto > options)
Returns an HTTP connection.
*list< string > getChildProviderNamesImpl()
Returns a list of child data provider names, if any.
static hash< auto > makeRequest(HTTPClient http, string meth, *data body, string path, *hash< auto > hdr)
Makes an HTTP request and returns the response.
Qore HttpClientDataProvider module definition.
Definition: HttpClientCallDataProvider.qc.dox.h:26