Qorus Integration Engine®  4.0.3_git
OMQ::Client::QorusSystemRestHelper Class Reference

class to call the system REST API from the client library More...

Inheritance diagram for OMQ::Client::QorusSystemRestHelper:
OMQ::QorusSystemRestHelperBase DataStreamClient::DataStreamClient

Public Member Methods

 constructor (*hash opts, *softbool do_not_connect)
 creates the object with the given options; a connection is automatically made unless the do_not_connect argument is False More...
 
 constructor (string name, *softbool do_not_connect)
 creates the object from the given remote connection name; a connection is automatically made unless the do_not_connect argument is False More...
 
private autoSetUrl (*hash opts)
 sets the URL automatically
 
private warning (string fmt)
 prints a warning on the console
 
 setBasePath (string p)
 sets the base path for REST requests
 
private string getBody (hash info)
 get the literal HTTP body from the info hash
 
private showRestRequest (hash info, auto args, *hash< auto > opt)
 outpus the REST request
 
private showRestResponse (hash info, auto rv, *hash< auto > opt)
 outpus the REST response
 
auto restDo (string m, string path, auto args, *hash< auto > hdr, *hash< auto > opt, *reference< hash > info)
 makes the REST response and returns the deserialized body More...
 
auto get (*hash opt, string path, auto args, *hash hdr, *reference info)
 issues an HTTP GET REST request against the server and returns the deserialized response More...
 
auto put (*hash opt, string path, auto args, *hash hdr, *reference info)
 issues an HTTP PUT REST request against the server and returns the deserialized response More...
 
auto post (*hash opt, string path, auto args, *hash hdr, *reference info)
 issues an HTTP POST REST request against the server and returns the deserialized response More...
 
auto del (*hash opt, string path, auto args, *hash hdr, *reference info)
 issues an HTTP DELETE REST request against the server and returns the deserialized response More...
 
string getRestErrorMessage (hash< auto > ex, hash< auto > info)
 returns a user-friendly error message when errors occur with REST messaging More...
 
 outputRestErrorMessage (hash ex, hash info)
 outputs a user-friendly error string when errors occur with REST messaging More...
 
- Public Member Methods inherited from OMQ::QorusSystemRestHelperBase
 constructor (*hash opts, *softbool do_not_connect)
 creates the object with the given options; a connection is automatically made unless the do_not_connect argument is False More...
 
 setURL (string url)
 sets the URL for the object
 
hash< auto > restDoWithInfo (string m, string path, auto args, *hash< auto > hdr, *hash< auto > opt)
 executes the remote REST call and returns the response More...
 
auto get (string path, auto args, *hash< auto > hdr, *reference< hash > info)
 executes a GET call on the remote REST service and returns the response More...
 
hash< auto > getWithInfo (string path, auto args, *hash< auto > hdr)
 executes a GET call on the remote REST service and returns the response More...
 
auto put (string path, auto args, *hash< auto > hdr, *reference< hash > info)
 executes a PUT call on the remote REST service and returns the response More...
 
hash< auto > putWithInfo (string path, auto args, *hash< auto > hdr)
 executes a PUT call on the remote REST service and returns the response More...
 
auto post (string path, auto args, *hash< auto > hdr, *reference< hash > info)
 executes a POST call on the remote REST service and returns the response More...
 
hash< auto > postWithInfo (string path, auto args, *hash< auto > hdr)
 executes a POST call on the remote REST service and returns the response More...
 
auto del (string path, auto args, *hash< auto > hdr, *reference< hash > info)
 executes a DELETE call on the remote REST service and returns the response More...
 
hash< auto > delWithInfo (string path, auto args, *hash< auto > hdr)
 executes a DELETE call on the remote REST service and returns the response More...
 
hash< auto > doRequest (string m, string path, auto body, *reference< hash > info, softbool decode_errors=True, *hash hdr)
 sends an HTTP request to the REST server and returns the response More...
 

Additional Inherited Members

- Static Public Member Methods inherited from OMQ::QorusSystemRestHelperBase
static hash toConfig (hash info)
 returns a hash of configuration information for the object
 
- Public Attributes inherited from OMQ::QorusSystemRestHelperBase
const Defaults
 default values for connection options
 
hash conn_opts
 connection params
 
*string api_version
 api version
 
*string name
 connection name if known
 

Detailed Description

class to call the system REST API from the client library

Member Function Documentation

◆ constructor() [1/2]

OMQ::Client::QorusSystemRestHelper::constructor ( *hash  opts,
*softbool  do_not_connect 
)

creates the object with the given options; a connection is automatically made unless the do_not_connect argument is False

Parameters
optsoptions as follows:
  • api_version: the REST API version (defaults to the latest version)
  • connect_timeout: the connect timeout value in milliseconds
  • timeout: the socket I/O timeout value in milliseconds
  • url: the target URL
do_not_connectif True, then the object will be created in an unconnected state
Since
Qorus 3.1.1 added the api_version option

◆ constructor() [2/2]

OMQ::Client::QorusSystemRestHelper::constructor ( string  name,
*softbool  do_not_connect 
)

creates the object from the given remote connection name; a connection is automatically made unless the do_not_connect argument is False

Parameters
namethe remote connection name to use for the connection
do_not_connectif True, then the object will be created in an unconnected state

◆ del()

auto OMQ::Client::QorusSystemRestHelper::del ( *hash  opt,
string  path,
auto  args,
*hash  hdr,
*reference  info 
)

issues an HTTP DELETE REST request against the server and returns the deserialized response

Parameters
optoutput options:
  • lit: if True, outputs the literal response
  • reformat: if True, outputs a reformatted response with verbose formatting (easier to read complex data structures)
paththe URI path for the request
argsany arguments to the REST request
hdra hash of optional HTTP header info to add to the request
infoan optional reference to a hash that will be used as an output variable giving a hash of request headers and other information about the HTTP request; if present the hash will contain the following keys:
  • headers: a hash of outgoing HTTP request headers
  • request-uri: the request URI string sent (ex: "GET /services/async/38.0/job HTTP/1.1")
  • body-content-type: the outgoing message body Mime Content-Type value
  • response-headers: a hash of incoming HTTP headers in the response
  • chunked: set to True if the response was received with chunked transfer encoding
  • response-code: the HTTP response code
  • response-body: the raw message body in the response (after any content decoding)
  • response-serialization: the type of message serialization in the response; see RestClient::RestClient::DataSerializationOptions for possible values
  • request-body: the raw message body in the request (before any content encoding)
  • request-serialization: the type of message serialization in the request; see RestClient::RestClient::DataSerializationOptions for possible values
Returns
the deserialized response body
Since
Qorus 3.1.0.p11 added the info argument

◆ get()

auto OMQ::Client::QorusSystemRestHelper::get ( *hash  opt,
string  path,
auto  args,
*hash  hdr,
*reference  info 
)

issues an HTTP GET REST request against the server and returns the deserialized response

Parameters
optoutput options:
  • lit: if True, outputs the literal response
  • reformat: if True, outputs a reformatted response with verbose formatting (easier to read complex data structures)
paththe URI path for the request
argsany arguments to the REST request
hdra hash of optional HTTP header info to add to the request
infoan optional reference to a hash that will be used as an output variable giving a hash of request headers and other information about the HTTP request; if present the hash will contain the following keys:
  • headers: a hash of outgoing HTTP request headers
  • request-uri: the request URI string sent (ex: "GET /services/async/38.0/job HTTP/1.1")
  • body-content-type: the outgoing message body Mime Content-Type value
  • response-headers: a hash of incoming HTTP headers in the response
  • chunked: set to True if the response was received with chunked transfer encoding
  • response-code: the HTTP response code
  • response-body: the raw message body in the response (after any content decoding)
  • response-serialization: the type of message serialization in the response; see RestClient::RestClient::DataSerializationOptions for possible values
  • request-body: the raw message body in the request (before any content encoding)
  • request-serialization: the type of message serialization in the request; see RestClient::RestClient::DataSerializationOptions for possible values
Returns
the deserialized response body
Since
Qorus 3.1.0.p11 added the info argument

◆ getRestErrorMessage()

string OMQ::Client::QorusSystemRestHelper::getRestErrorMessage ( hash< auto >  ex,
hash< auto >  info 
)

returns a user-friendly error message when errors occur with REST messaging

Parameters
exan exception hash
infoan output hash from a REST call
Returns
a user-friendly error string corresponding to the REST error
Since
Qorus 3.1.0.p11

◆ outputRestErrorMessage()

OMQ::Client::QorusSystemRestHelper::outputRestErrorMessage ( hash  ex,
hash  info 
)

outputs a user-friendly error string when errors occur with REST messaging

Parameters
exan exception hash
infoan output hash from a REST call
Since
Qorus 3.1.0.p11

◆ post()

auto OMQ::Client::QorusSystemRestHelper::post ( *hash  opt,
string  path,
auto  args,
*hash  hdr,
*reference  info 
)

issues an HTTP POST REST request against the server and returns the deserialized response

Parameters
optoutput options:
  • lit: if True, outputs the literal response
  • reformat: if True, outputs a reformatted response with verbose formatting (easier to read complex data structures)
paththe URI path for the request
argsany arguments to the REST request
hdra hash of optional HTTP header info to add to the request
infoan optional reference to a hash that will be used as an output variable giving a hash of request headers and other information about the HTTP request; if present the hash will contain the following keys:
  • headers: a hash of outgoing HTTP request headers
  • request-uri: the request URI string sent (ex: "GET /services/async/38.0/job HTTP/1.1")
  • body-content-type: the outgoing message body Mime Content-Type value
  • response-headers: a hash of incoming HTTP headers in the response
  • chunked: set to True if the response was received with chunked transfer encoding
  • response-code: the HTTP response code
  • response-body: the raw message body in the response (after any content decoding)
  • response-serialization: the type of message serialization in the response; see RestClient::RestClient::DataSerializationOptions for possible values
  • request-body: the raw message body in the request (before any content encoding)
  • request-serialization: the type of message serialization in the request; see RestClient::RestClient::DataSerializationOptions for possible values
Returns
the deserialized response body
Since
Qorus 3.1.0.p11 added the info argument

◆ put()

auto OMQ::Client::QorusSystemRestHelper::put ( *hash  opt,
string  path,
auto  args,
*hash  hdr,
*reference  info 
)

issues an HTTP PUT REST request against the server and returns the deserialized response

Parameters
optoutput options:
  • lit: if True, outputs the literal response
  • reformat: if True, outputs a reformatted response with verbose formatting (easier to read complex data structures)
paththe URI path for the request
argsany arguments to the REST request
hdra hash of optional HTTP header info to add to the request
infoan optional reference to a hash that will be used as an output variable giving a hash of request headers and other information about the HTTP request; if present the hash will contain the following keys:
  • headers: a hash of outgoing HTTP request headers
  • request-uri: the request URI string sent (ex: "GET /services/async/38.0/job HTTP/1.1")
  • body-content-type: the outgoing message body Mime Content-Type value
  • response-headers: a hash of incoming HTTP headers in the response
  • chunked: set to True if the response was received with chunked transfer encoding
  • response-code: the HTTP response code
  • response-body: the raw message body in the response (after any content decoding)
  • response-serialization: the type of message serialization in the response; see RestClient::RestClient::DataSerializationOptions for possible values
  • request-body: the raw message body in the request (before any content encoding)
  • request-serialization: the type of message serialization in the request; see RestClient::RestClient::DataSerializationOptions for possible values
Returns
the deserialized response body
Since
Qorus 3.1.0.p11 added the info argument

◆ restDo()

auto OMQ::Client::QorusSystemRestHelper::restDo ( string  m,
string  path,
auto  args,
*hash< auto >  hdr,
*hash< auto >  opt,
*reference< hash info 
)
virtual

makes the REST response and returns the deserialized body

Parameters
mthe HTTP method for the request (ex: "GET")
paththe URI path for the request
argsany arguments to the REST request
hdra hash of optional HTTP header info to add to the request
optoutput options:
  • lit: if True, outputs the literal response
  • reformat: if True, outputs a reformatted response with verbose formatting (easier to read complex data structures)
infoan optional reference to a hash that will be used as an output variable giving a hash of request headers and other information about the HTTP request; if present the hash will contain the following keys:
  • headers: a hash of outgoing HTTP request headers
  • request-uri: the request URI string sent (ex: "GET /services/async/38.0/job HTTP/1.1")
  • body-content-type: the outgoing message body Mime Content-Type value
  • response-headers: a hash of incoming HTTP headers in the response
  • chunked: set to True if the response was received with chunked transfer encoding
  • response-code: the HTTP response code
  • response-body: the raw message body in the response (after any content decoding)
  • response-serialization: the type of message serialization in the response; see RestClient::RestClient::DataSerializationOptions for possible values
  • request-body: the raw message body in the request (before any content encoding)
  • request-serialization: the type of message serialization in the request; see RestClient::RestClient::DataSerializationOptions for possible values
Returns
the deserialized response body
Since
Qorus 3.1.0.p11 added the info argument

Implements OMQ::QorusSystemRestHelperBase.


The documentation for this class was generated from the following file: