Qorus Integration Engine®  4.0.3.p1_git
OMQ::QorusSystemRestHelper Class Reference

class used to call the Qorus REST API for a remote Qorus instance More...

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

Public Member Methods

 constructor (string user, string pwd)
 creates the object pointing to the first local listener for the current instance using the given user and password for connecting More...
 
 constructor ()
 creates the object pointing to the first local listener for the current instance More...
 
 constructor (hash info)
 creates the object with the configuration given
 
 constructor (string name)
 creates the object with the configuration given by the name of the remote instance
 
 autoSetUrl (*hash opts)
 sets the URL automatically; must be reimplemented in subclasses
 
private warning (string fmt)
 logs a warning
 
auto restDo (string m, string path, auto args, *hash< auto > hdr, *hash< auto > opt, *reference< hash > info)
 executes the remote REST call and returns the response 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 used to call the Qorus REST API for a remote Qorus instance

See also
QorusSystemRestHelperBase for the method documentation

Member Function Documentation

◆ constructor() [1/2]

OMQ::QorusSystemRestHelper::constructor ( string  user,
string  pwd 
)

creates the object pointing to the first local listener for the current instance using the given user and password for connecting

Parameters
userthe username for the connection
pwdthe password for the connection
Since
Qorus 3.0.2

◆ constructor() [2/2]

OMQ::QorusSystemRestHelper::constructor ( )

creates the object pointing to the first local listener for the current instance

Since
Qorus 3.0.2

◆ restDo()

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

executes the remote REST call and returns the response

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; as defined in the child class
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

Implements OMQ::QorusSystemRestHelperBase.


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