Qorus Integration Engine® Enterprise Edition 6.0.19_prod
|
class to call the system REST API from the client library More...
Public Member Methods | |
constructor (*hash< auto > opts, *softbool do_not_connect) | |
Creates the object with the given options. More... | |
constructor (string name, *softbool do_not_connect) | |
creates the object from the given remote connection name More... | |
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... | |
setBasePath (string p) | |
sets the base path for REST requests | |
auto | restDo (string m, string path, auto args, *hash< auto > hdr, *hash< auto > opt, *reference< hash< auto > > info) |
makes the REST response and returns the deserialized body More... | |
auto | get (*hash< auto > opt, string path, auto args, *hash< auto > hdr, *reference< hash< auto > > info) |
issues an HTTP GET REST request against the server and returns the deserialized response More... | |
auto | put (*hash< auto > opt, string path, auto args, *hash< auto > hdr, *reference< hash< auto > > info) |
issues an HTTP PUT REST request against the server and returns the deserialized response More... | |
auto | post (*hash< auto > opt, string path, auto args, *hash< auto > hdr, *reference< hash< auto > > info) |
issues an HTTP POST REST request against the server and returns the deserialized response More... | |
auto | del (*hash< auto > opt, string path, auto args, *hash< auto > hdr, *reference< hash< auto > > info) |
issues an HTTP DELETE REST request against the server and returns the deserialized response More... | |
string | getRestErrorMessage (hash< auto > ex, *hash< auto > info, *reference< bool > down) |
returns a user-friendly error message when errors occur with REST messaging More... | |
bool | outputRestErrorMessage (hash< auto > ex, *hash< auto > info) |
outputs a user-friendly error string when errors occur with REST messaging More... | |
Public Member Methods inherited from OMQ::QorusSystemRestHelperBase | |
constructor (*hash< auto > opts, *softbool do_not_connect) | |
Creates the object with the given options. More... | |
setSchema () | |
Sets the REST validator to the latest version of the schema for the Qorus API. More... | |
setPublicSchema () | |
Sets the REST validator to the latest version of the public schema for the Qorus API. More... | |
abstract private | autoSetUrl (*hash< auto > opts) |
sets the URL automatically; must be reimplemented in subclasses | |
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... | |
abstract auto | restDo (string m, string path, auto args, *hash< auto > hdr, *hash< auto > opt, *reference< hash< auto > > info) |
executes the remote REST call and returns the response More... | |
abstract private nothing | warning (string fmt,...) |
issue a warning on the console (for the client) or in the current log file (for the server) More... | |
auto | get (string path, auto args, *hash< auto > hdr, *reference< hash< auto > > 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< auto > > 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< auto > > 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< auto > > 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< auto > > info, softbool decode_errors=True, *hash< auto > hdr) |
sends an HTTP request to the REST server and returns the response More... | |
Private Member Methods | |
autoSetUrl (*hash< auto > opts) | |
sets the URL automatically More... | |
setInternalUrl (string url) | |
Sets internal authentication info. | |
warning (string fmt,...) | |
prints a warning on the console | |
string | getBody (hash< auto > info) |
get the literal HTTP body from the info hash | |
showRestRequest (hash< auto > info, auto args, *hash< auto > opt) | |
outpus the REST request | |
showRestResponse (hash< auto > info, auto rv, *hash< auto > opt) | |
outpus the REST response | |
Additional Inherited Members | |
Static Public Member Methods inherited from OMQ::QorusSystemRestHelperBase | |
static hash< auto > | toConfig (hash< auto > 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 | |
class to call the system REST API from the client library
|
privatevirtual |
sets the URL automatically
This method acquires an authentication token automatically that provides internal system access to Qorus APIs and data if no other explicit authentication information is available
Implements OMQ::QorusSystemRestHelperBase.
OMQ::Client::QorusSystemRestHelper::constructor | ( | *hash< auto > | 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
opts | options as follows:
|
do_not_connect | if True, then the object will be created in an unconnected state |
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
name | the remote connection name to use for the connection |
do_not_connect | if True, then the object will be created in an unconnected state |
OMQ::Client::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
user | the username for the connection |
pwd | the password for the connection |
auto OMQ::Client::QorusSystemRestHelper::del | ( | *hash< auto > | opt, |
string | path, | ||
auto | args, | ||
*hash< auto > | hdr, | ||
*reference< hash< auto > > | info | ||
) |
issues an HTTP DELETE
REST request against the server and returns the deserialized response
opt | output options: |
path | the URI path for the request |
args | any arguments to the REST request |
hdr | a hash of optional HTTP header info to add to the request |
info | an 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:
|
auto OMQ::Client::QorusSystemRestHelper::get | ( | *hash< auto > | opt, |
string | path, | ||
auto | args, | ||
*hash< auto > | hdr, | ||
*reference< hash< auto > > | info | ||
) |
issues an HTTP GET
REST request against the server and returns the deserialized response
opt | output options: |
path | the URI path for the request |
args | any arguments to the REST request |
hdr | a hash of optional HTTP header info to add to the request |
info | an 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:
|
string OMQ::Client::QorusSystemRestHelper::getRestErrorMessage | ( | hash< auto > | ex, |
*hash< auto > | info, | ||
*reference< bool > | down | ||
) |
returns a user-friendly error message when errors occur with REST messaging
ex | an exception hash |
info | an output hash from a REST call |
bool OMQ::Client::QorusSystemRestHelper::outputRestErrorMessage | ( | hash< auto > | ex, |
*hash< auto > | info | ||
) |
outputs a user-friendly error string when errors occur with REST messaging
ex | an exception hash |
info | an output hash from a REST call |
auto OMQ::Client::QorusSystemRestHelper::post | ( | *hash< auto > | opt, |
string | path, | ||
auto | args, | ||
*hash< auto > | hdr, | ||
*reference< hash< auto > > | info | ||
) |
issues an HTTP POST
REST request against the server and returns the deserialized response
opt | output options: |
path | the URI path for the request |
args | any arguments to the REST request |
hdr | a hash of optional HTTP header info to add to the request |
info | an 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:
|
auto OMQ::Client::QorusSystemRestHelper::put | ( | *hash< auto > | opt, |
string | path, | ||
auto | args, | ||
*hash< auto > | hdr, | ||
*reference< hash< auto > > | info | ||
) |
issues an HTTP PUT
REST request against the server and returns the deserialized response
opt | output options: |
path | the URI path for the request |
args | any arguments to the REST request |
hdr | a hash of optional HTTP header info to add to the request |
info | an 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:
|
|
virtual |
makes the REST response and returns the deserialized body
m | the HTTP method for the request (ex: "GET" ) |
path | the URI path for the request |
args | any arguments to the REST request |
hdr | a hash of optional HTTP header info to add to the request |
opt | output options: |
info | an 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:
|
Implements OMQ::QorusSystemRestHelperBase.