Qore HttpClientDataProvider Module Reference  1.0
HttpClientDataProvider::HttpClientPostDataProvider Class Reference

The HTTP post data provider class. More...

Inherits AbstractDataProvider.

Public Member Functions

 constructor (*hash< auto > options)
 Creates the object from constructor options.
 
 constructor (HTTPClient http)
 Creates the object from an HTTP connection.
 
string getName ()
 Returns the data provider name.
 
hash< DataProviderInfo > getStaticInfoImpl ()
 Returns data provider static info.
 

Public Attributes

HTTPClient http
 HTTP connection.
 
const ProviderInfo
 Provider info.
 
const ProviderSummaryInfo
 Provider summary info.
 
const RequestType = new HttpClientCallRequestDataType()
 Request type.
 
const ResponseType = new HttpClientCallResponseDataType()
 Response type.
 

Protected Member Functions

auto doRequestImpl (auto req, *hash< auto > request_options)
 Makes a request and returns the response. More...
 
*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 HTTP post data provider class.

Member Function Documentation

◆ doRequestImpl()

auto HttpClientDataProvider::HttpClientPostDataProvider::doRequestImpl ( auto  req,
*hash< auto >  request_options 
)
protected

Makes a request and returns the response.

Parameters
reqthe request info
request_optionsthe request options after processing by validateRequestOptions()
Returns
the response to the request

◆ getRequestTypeImpl()

*AbstractDataProviderType HttpClientDataProvider::HttpClientPostDataProvider::getRequestTypeImpl ( )
protected

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

Returns
the request type for this provider

◆ getResponseTypeImpl()

*AbstractDataProviderType HttpClientDataProvider::HttpClientPostDataProvider::getResponseTypeImpl ( )
protected

Returns the description of a response message, if this object represents a response message.

Returns
the response type for this response message
s="code" href="class_file_location_handler_1_1_file_location_handler_ftp.html#a12c7e92dbc262371d2f6862a51bdb6f8">getWriteOptionsImpl();
135 public:
136 
137 
139 protected:
140  FtpClient getFtpClient(string scheme, string location, *hash<auto> opts, reference<string> file);
141 public:
142 
143 };
144 };
FileLocationHandler::AbstractFileLocationHandler
The abstract file location handler class.
Definition: FileLocationHandler.qc.dox.h:43
FileLocationHandler::FileLocationHandlerFtp
The class for handling file locations.
Definition: FileLocationHandlerFtp.qc.dox.h:28
FileLocationHandler::FileLocationHandlerFtp::getWriteOptionsImpl
hash< string, hash< FileHandlerOptionInfo > > getWriteOptionsImpl()
Gets supported write options.
FileLocationHandler::FileLocationHandlerFtp::getTextFileImpl
string getTextFileImpl(string scheme, string location, *hash< auto > opts)
Retrieves a text file from the given location.
FileLocationHandler::FileLocationHandlerFtp::getBinaryFileImpl
binary getBinaryFileImpl(string scheme, string location, *hash< auto > opts)
Retrieves a binary file from the given location.
FileLocationHandler::FileLocationHandlerFtp::getFtpClient
FtpClient getFtpClient(string scheme, string location, *hash< auto > opts, reference< string > file)
Returns an FTP client for the given location.
FileLocationHandler::FileLocationHandlerFtp::getReadOptionsImpl
hash< string, hash< FileHandlerOptionInfo > > getReadOptionsImpl()
Gets supported read options.
FileLocationHandler::FileLocationHandlerFtp::getStreamReaderImpl
Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash< auto > opts)
Returns a stream reader for the file's data at the given location.
FileLocationHandler::FileLocationHandlerFtp::FtpClientLocationOpts
const FtpClientLocationOpts
Valid common file location options.
Definition: FileLocationHandlerFtp.qc.dox.h:34
FileLocationHandler::FileLocationHandlerFtp::getBinaryStreamImpl
Qore::InputStream getBinaryStreamImpl(string scheme, string location, *hash< auto > opts)
Retrieves a binary file from the given location.
FileLocationHandler::FileLocationHandlerFtp::getOutputStreamImpl
OutputStreamWrapper getOutputStreamImpl(string scheme, string location, *hash< auto > opts)
Returns an output stream for writing data to the given location.
FileLocationHandler::FileLocationHandlerFtp::writeFileImpl
writeFileImpl(string scheme, string location, data contents, *hash< auto > opts)
Writes data to a file at the given location.
FileLocationHandler::OutputStreamWrapper
The abstract file location handler class.
Definition: OutputStramWrapper.qc.dox.h:28
Qore::InputStream
Qore::StreamReader
binary
binary binary()
FileLocationHandler
Contains all public definitions in the FileLocationHandler module.
Definition: FileLocationHandler.qc.dox.h:26
FileLocationHandler::FileHandlerOptionInfo
File handler option info.
Definition: FileLocationHandler.qc.dox.h:28