Qore RestClientDataProvider Module Reference  1.0
RestClientDataProvider::RestClientCallDataProvider Member List

This is the complete list of members for RestClientDataProvider::RestClientCallDataProvider, including all inherited members.

constructor(*hash< auto > options)RestClientDataProvider::RestClientCallDataProvider
constructor(RestClient rest)RestClientDataProvider::RestClientCallDataProvider
doRequestImpl(auto req, *hash< auto > request_options)RestClientDataProvider::RestClientCallDataProviderprotected
getName()RestClientDataProvider::RestClientCallDataProvider
getRequestTypeImpl()RestClientDataProvider::RestClientCallDataProviderprotected
getResponseTypeImpl()RestClientDataProvider::RestClientCallDataProviderprotected
getStaticInfoImpl()RestClientDataProvider::RestClientCallDataProvider
ProviderInfoRestClientDataProvider::RestClientCallDataProvider
ProviderSummaryInfoRestClientDataProvider::RestClientCallDataProvider
RequestTypeRestClientDataProvider::RestClientCallDataProvider
ResponseTypeRestClientDataProvider::RestClientCallDataProvider
restRestClientDataProvider::RestClientCallDataProvider
="line"> 51 
53  const ResponseType = new RestClientCallResponseDataType();
54 
56  constructor(*hash<auto> options);
57 
58 
60  constructor(AwsRestClient rest);
61 
62 
64  string getName();
65 
66 
68 
73 protected:
74  auto doRequestImpl(auto req, *hash<auto> request_options);
75 public:
76 
77 
79 
81 protected:
82  *AbstractDataProviderType getRequestTypeImpl();
83 public:
84 
85 
87 
89 protected:
90  *AbstractDataProviderType getResponseTypeImpl();
91 public:
92 
93 
95  hash<DataProviderInfo> getStaticInfoImpl();
96 
97 };
98 };
AwsRestClientDataProvider::AwsRestClientDataProvider::ConstructorOptions
const ConstructorOptions
Constructor arguments.
Definition: AwsRestClientDataProvider.qc.dox.h:39
AwsRestClientDataProvider::AwsRestClientDeleteDataProvider
The AWS REST client DELETE data provider class.
Definition: AwsRestClientDeleteDataProvider.qc.dox.h:28
AwsRestClientDataProvider::AwsRestClientDeleteDataProvider::ResponseType
const ResponseType
Response type.
Definition: AwsRestClientDeleteDataProvider.qc.dox.h:53
AwsRestClientDataProvider::AwsRestClientDeleteDataProvider::doRequestImpl
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
AwsRestClientDataProvider::AwsRestClientDeleteDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
AwsRestClientDataProvider::AwsRestClientDeleteDataProvider::getStaticInfoImpl
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
AwsRestClientDataProvider::AwsRestClientDeleteDataProvider::getName
string getName()
Returns the data provider name.
AwsRestClientDataProvider::AwsRestClientDeleteDataProvider::ProviderSummaryInfo
const ProviderSummaryInfo
Provider summary info.
Definition: AwsRestClientDeleteDataProvider.qc.dox.h:45
AwsRestClientDataProvider::AwsRestClientDeleteDataProvider::getResponseTypeImpl
*AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
AwsRestClientDataProvider::AwsRestClientDeleteDataProvider::getRequestTypeImpl
*AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
AwsRestClientDataProvider::AwsRestClientDeleteDataProvider::rest
AwsRestClient rest
REST client connection.
Definition: AwsRestClientDeleteDataProvider.qc.dox.h:32
AwsRestClientDataProvider::AwsRestClientDeleteDataProvider::constructor
constructor(AwsRestClient rest)
Creates the object from a REST connection.
AwsRestClientDataProvider::AwsRestClientDeleteDataProvider::RequestType
const RequestType
Request type.
Definition: AwsRestClientDeleteDataProvider.qc.dox.h:50
AwsRestClientDataProvider::AwsRestClientDeleteDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition: AwsRestClientDeleteDataProvider.qc.dox.h:35
True
const True
AwsRestClientDataProvider
Qore AwsRestClientDataProvider module definition.
Definition: AwsRestClientCallDataProvider.qc.dox.h:26
_abstract_file_location_handler.html#a16597193b9e7bb3fab9fba1aac8e35c5">More...
  abstract hash< string, hash< FileHandlerOptionInfo > > getWriteOptionsImpl ()  Gets supported write options. More...
  abstract writeFileImpl (string scheme, string location, data contents, *hash< auto > opts)  Writes data to a file at the given location. More...
 

Static Protected Member Functions

static string forceEncoding (string str, *string encoding)
 Returns a string tagged with the given encoding, if any.
 

Detailed Description

The abstract file location handler class.

Member Function Documentation

◆ getBinaryFile()

binary FileLocationHandler::AbstractFileLocationHandler::getBinaryFile ( string  scheme,
string  location,
*hash< auto >  opts 
)

Retrieves a binary file from the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
optsread options
Returns
the binary data of the file's contents, if it can be retrieved

◆ getBinaryFileImpl()

abstract binary FileLocationHandler::AbstractFileLocationHandler::getBinaryFileImpl ( string  scheme,
string  location,
*hash< auto >  opts 
)
protectedpure virtual

Retrieves a binary file from the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
optsread options
Returns
the binary data of the file's contents, if it can be retrieved

Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, and FileLocationHandler::FileLocationHandlerFile.

◆ getBinaryStream()

Qore::InputStream FileLocationHandler::AbstractFileLocationHandler::getBinaryStream ( string  scheme,
string  location,
*hash< auto >  opts 
)

Retrieves a binary file from the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
optsread options
Returns
an input stream of the file's contents, if it can be retrieved
Note
The data is read in the background and added to the input stream

◆ getBinaryStreamImpl()

abstract Qore::InputStream FileLocationHandler::AbstractFileLocationHandler::getBinaryStreamImpl ( string  scheme,
string  location,
*hash< auto >  opts 
)
protectedpure virtual

Retrieves a binary file from the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
optsread options
Returns
an input stream of the file's contents, if it can be retrieved

Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, and FileLocationHandler::FileLocationHandlerFile.

◆ getOutputStream()

OutputStreamWrapper FileLocationHandler::AbstractFileLocationHandler::getOutputStream ( string  scheme,
string  location,
*hash< auto >  opts 
)

Returns an output stream for writing data to the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
optswrite options
Returns
an output stream for writing to the file
Note

◆ getOutputStreamImpl()

abstract OutputStreamWrapper FileLocationHandler::AbstractFileLocationHandler::getOutputStreamImpl ( string  scheme,
string  location,
*hash< auto >  opts 
)
protectedpure virtual

Returns an output stream for writing data to the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
optswrite options
Returns
an output stream for writing to the file
Note

Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, and FileLocationHandler::FileLocationHandlerFile.

◆ getReadOptions()

hash<string, hash<FileHandlerOptionInfo> > FileLocationHandler::AbstractFileLocationHandler::getReadOptions ( )

Gets supported read options.

Returns
supported read options

◆ getReadOptionsImpl()

abstract hash<string, hash<FileHandlerOptionInfo> > FileLocationHandler::AbstractFileLocationHandler::getReadOptionsImpl ( )
protectedpure virtual

Gets supported read options.

Returns
supported read options

Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, and FileLocationHandler::FileLocationHandlerFile.

◆ getStreamReader()

Qore::StreamReader FileLocationHandler::AbstractFileLocationHandler::getStreamReader ( string  scheme,
string  location,
*hash< auto >  opts 
)

Returns a string stream for the file's data at the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
optsread options
Returns
a stream reader for the file's contents, if it can be retrieved
Note
The data is read in the background and added to the input stream backing the stream reader

◆ getStreamReaderImpl()

abstract Qore::StreamReader FileLocationHandler::AbstractFileLocationHandler::getStreamReaderImpl ( string  scheme,
string  location,
*hash< auto >  opts 
)
protectedpure virtual

Returns a string stream for the file's data at the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
optsread options
Returns
a stream reader for the file's contents, if it can be retrieved

Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, and FileLocationHandler::FileLocationHandlerFile.

◆ getTextFile()

string FileLocationHandler::AbstractFileLocationHandler::getTextFile ( string  scheme,
string  location,
*hash< auto >  opts 
)

Retrieves a text file from the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme or options
optsread options
Returns
the string of the file's contents, if it can be retrieved

◆ getTextFileImpl()

abstract string FileLocationHandler::AbstractFileLocationHandler::getTextFileImpl ( string  scheme,
string  location,
*hash< auto >  opts 
)
protectedpure virtual

Retrieves a text file from the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
optsread options
Returns
the string of the file's contents, if it can be retrieved

Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, and FileLocationHandler::FileLocationHandlerFile.

◆ getWriteOptions()

hash<string, hash<FileHandlerOptionInfo> > FileLocationHandler::AbstractFileLocationHandler::getWriteOptions ( )

Gets supported write options.

Returns
supported write options

◆ getWriteOptionsImpl()

abstract hash<string, hash<FileHandlerOptionInfo> > FileLocationHandler::AbstractFileLocationHandler::getWriteOptionsImpl ( )
protectedpure virtual

Gets supported write options.

Returns
supported write options

Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, and FileLocationHandler::FileLocationHandlerFile.

◆ writeFile()

FileLocationHandler::AbstractFileLocationHandler::writeFile ( string  scheme,
string  location,
data  contents,
*hash< auto >  opts 
)

Writes data to a file at the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
contentsthe file's contents
optswrite options

◆ writeFileImpl()

abstract FileLocationHandler::AbstractFileLocationHandler::writeFileImpl ( string  scheme,
string  location,
data  contents,
*hash< auto >  opts 
)
protectedpure virtual

Writes data to a file at the given location.

Parameters
schemethe scheme being used
locationthe location string without the scheme
contentsthe file's contents
optswrite options

Implemented in FileLocationHandler::FileLocationHandlerSftp, FileLocationHandler::FileLocationHandlerHttp, FileLocationHandler::FileLocationHandlerFtp, and FileLocationHandler::FileLocationHandlerFile.