Qorus Integration Engine®
4.0.3.p2_git
|
base class for accessing the system REST API More...
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... | |
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 > info) |
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... | |
Static Public Member Methods | |
static hash | toConfig (hash info) |
returns a hash of configuration information for the object | |
Public Attributes | |
const | Defaults |
default values for connection options | |
hash | conn_opts |
connection params | |
*string | api_version |
api version | |
*string | name |
connection name if known | |
Private Member Methods | |
abstract | autoSetUrl (*hash opts) |
sets the URL automatically; must be reimplemented in subclasses | |
abstract nothing | warning (string fmt) |
issue a warning on the console (for the client) or in the current log file (for the server) More... | |
base class for accessing the system REST API
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
opts | options as follows:
|
do_not_connect | if True, then the object will be created in an unconnected state |
auto OMQ::QorusSystemRestHelperBase::del | ( | string | path, |
auto | args, | ||
*hash< auto > | hdr, | ||
*reference< hash > | info | ||
) |
executes a DELETE
call on the remote REST service and returns the response
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:
|
hash<auto> OMQ::QorusSystemRestHelperBase::delWithInfo | ( | string | path, |
auto | args, | ||
*hash< auto > | hdr | ||
) |
executes a DELETE
call on the remote REST service and returns the response
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 |
rv:
the deserialized response bodyinfo:
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 headersrequest-uri
: the request URI string sent (ex: "DELETE /users/olduser HTTP/1.1"
)body-content-type
: the outgoing message body Mime Content-Type
valueresponse-headers
: a hash of incoming HTTP headers in the responsechunked:
set to True if the response was received with chunked transfer encodingresponse-code
: the HTTP response coderesponse-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 valuesrequest-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 valueshash<auto> OMQ::QorusSystemRestHelperBase::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
auto OMQ::QorusSystemRestHelperBase::get | ( | string | path, |
auto | args, | ||
*hash< auto > | hdr, | ||
*reference< hash > | info | ||
) |
executes a GET
call on the remote REST service and returns the response
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:
|
hash<auto> OMQ::QorusSystemRestHelperBase::getWithInfo | ( | string | path, |
auto | args, | ||
*hash< auto > | hdr | ||
) |
executes a GET
call on the remote REST service and returns the response
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 |
rv:
the deserialized response bodyinfo:
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 headersrequest-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
valueresponse-headers
: a hash of incoming HTTP headers in the responsechunked:
set to True if the response was received with chunked transfer encodingresponse-code
: the HTTP response coderesponse-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 valuesrequest-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 valuesauto OMQ::QorusSystemRestHelperBase::post | ( | string | path, |
auto | args, | ||
*hash< auto > | hdr, | ||
*reference< hash > | info | ||
) |
executes a POST
call on the remote REST service and returns the response
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:
|
hash<auto> OMQ::QorusSystemRestHelperBase::postWithInfo | ( | string | path, |
auto | args, | ||
*hash< auto > | hdr | ||
) |
executes a POST
call on the remote REST service and returns the response
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 |
rv:
the deserialized response bodyinfo:
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 headersrequest-uri
: the request URI string sent (ex: "POST /services/async/38.0/job HTTP/1.1"
)body-content-type
: the outgoing message body Mime Content-Type
valueresponse-headers
: a hash of incoming HTTP headers in the responsechunked:
set to True if the response was received with chunked transfer encodingresponse-code
: the HTTP response coderesponse-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 valuesrequest-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 valuesauto OMQ::QorusSystemRestHelperBase::put | ( | string | path, |
auto | args, | ||
*hash< auto > | hdr, | ||
*reference< hash > | info | ||
) |
executes a PUT
call on the remote REST service and returns the response
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:
|
hash<auto> OMQ::QorusSystemRestHelperBase::putWithInfo | ( | string | path, |
auto | args, | ||
*hash< auto > | hdr | ||
) |
executes a PUT
call on the remote REST service and returns the response
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 |
rv:
the deserialized response bodyinfo:
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 headersrequest-uri
: the request URI string sent (ex: "PUT /services/async/38.0/job HTTP/1.1"
)body-content-type
: the outgoing message body Mime Content-Type
valueresponse-headers
: a hash of incoming HTTP headers in the responsechunked:
set to True if the response was received with chunked transfer encodingresponse-code
: the HTTP response coderesponse-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 valuesrequest-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
|
pure virtual |
executes the remote REST call and returns the response
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; as defined in the child class |
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:
|
Implemented in OMQ::Client::QorusSystemRestHelper, and OMQ::QorusSystemRestHelper.
hash<auto> OMQ::QorusSystemRestHelperBase::restDoWithInfo | ( | string | m, |
string | path, | ||
auto | args, | ||
*hash< auto > | hdr, | ||
*hash< auto > | opt | ||
) |
executes the remote REST call and returns the response
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; as defined in the child class |
rv:
the deserialized response bodyinfo:
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 headersrequest-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
valueresponse-headers
: a hash of incoming HTTP headers in the responsechunked:
set to True if the response was received with chunked transfer encodingresponse-code
: the HTTP response coderesponse-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 valuesrequest-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
|
privatepure virtual |
issue a warning on the console (for the client) or in the current log file (for the server)
Implemented in OMQ::Client::QorusSystemRestHelper, and OMQ::QorusSystemRestHelper.