Qorus Integration Engine®  5.1.39_git
QorusApiDataProvider::QorusApiRestRequestDataProvider Class Reference

The Qorus API data provider for the data provider REST request API. More...

Inherits AbstractDataProvider.

Public Member Methods

string getName ()
 Returns the name of the data provider.
 
*string getDesc ()
 Returns the data provider description.
 
hash< DataProviderInfo > getStaticInfoImpl ()
 Returns data provider static info.
 

Static Public Member Methods

static private bool isConnectionIoError (hash< auto > req, hash< ExceptionInfo > ex)
 Returns True if the error is a connection I/O error.
 

Public Attributes

const ProviderInfo
 Provider info.
 
const RequestType = new QorusApiRestRequestRequestDataType()
 Request type.
 
const ResponseType = new QorusApiRestRequestResponseDataType()
 Response type.
 

Private Member Methods

auto doRequestImpl (auto req, *hash< auto > request_options)
 Makes a request and returned the response. More...
 
RestClient getConnection (hash< auto > req)
 returns a REST connection to the server, optionally setting a Swagger schema from a service resource
 
*AbstractDataProviderType getRequestTypeImpl ()
 Returns the description of a successful request message, if any. More...
 
*AbstractDataProviderType getResponseTypeImpl ()
 Returns the description of a response message, if this object represents a response message. More...
 

Detailed Description

The Qorus API data provider for the data provider REST request API.

Member Function Documentation

◆ doRequestImpl()

auto QorusApiDataProvider::QorusApiRestRequestDataProvider::doRequestImpl ( auto  req,
*hash< auto >  request_options 
)
private

Makes a request and returned the response.

Parameters
reqthe request to serialize and make according to the request type
request_optionsthe request options; will be processed by validateRequestOptions()
Returns
the response to the request

◆ getRequestTypeImpl()

*AbstractDataProviderType QorusApiDataProvider::QorusApiRestRequestDataProvider::getRequestTypeImpl ( )
private

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

Returns
the request type for this provider

◆ getResponseTypeImpl()

*AbstractDataProviderType QorusApiDataProvider::QorusApiRestRequestDataProvider::getResponseTypeImpl ( )
private

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: