Qorus Integration Engine®  4.0.3_git
com.qoretechnologies.qorus.QorusSystemRestHelper Class Reference

Java wrapper for the OMQ::QorusSystemRestHelper class in Qore. More...

Inheritance diagram for com.qoretechnologies.qorus.QorusSystemRestHelper:
org::qore::lang::HTTPClient org::qore::jni::QoreObjectWrapper

Public Member Methods

 QorusSystemRestHelper (QoreObject obj)
 creates the object as a wrapper for the Qore object
 
 QorusSystemRestHelper () throws Throwable
 creates the object pointing to the first local listener for the current instance More...
 
 QorusSystemRestHelper (String name) throws Throwable
 creates the object with the configuration given by the name of the remote instance
 
 QorusSystemRestHelper (String username, String password) throws Throwable
 creates the object pointing to the first local listener for the current instance using the given user and password for connecting More...
 
 QorusSystemRestHelper (HashMap< String, Object > info) throws Throwable
 creates the object with the configuration given
 
HashMap< String, ObjectgetRestWithInfo (String path, Object args, HashMap< String, Object > hdr) throws Throwable
 executes a GET call on the remote REST service and returns the response More...
 
HashMap< String, ObjectgetRestWithInfo (String path, Object args) throws Throwable
 executes a GET call on the remote REST service and returns the response More...
 
HashMap< String, ObjectgetRestWithInfo (String path) throws Throwable
 executes a GET call on the remote REST service and returns the response More...
 
Object getRest (String path, Object args, HashMap< String, Object > hdr) throws Throwable
 executes a GET call on the remote REST service and returns the response More...
 
Object getRest (String path, Object args) throws Throwable
 executes a GET call on the remote REST service and returns the response More...
 
Object getRest (String path) throws Throwable
 executes a GET call on the remote REST service and returns the response More...
 
HashMap< String, ObjectputRestWithInfo (String path, Object args, HashMap< String, Object > hdr) throws Throwable
 executes a PUT call on the remote REST service and returns the response More...
 
HashMap< String, ObjectputRestWithInfo (String path, Object args) throws Throwable
 executes a PUT call on the remote REST service and returns the response More...
 
HashMap< String, ObjectputRestithInfo (String path) throws Throwable
 executes a PUT call on the remote REST service and returns the response More...
 
Object putRest (String path, Object args, HashMap< String, Object > hdr) throws Throwable
 executes a PUT call on the remote REST service and returns the response More...
 
Object putRest (String path, Object args) throws Throwable
 executes a PUT call on the remote REST service and returns the response More...
 
Object putRest (String path) throws Throwable
 executes a PUT call on the remote REST service and returns the response More...
 
HashMap< String, ObjectpostRestWithInfo (String path, Object args, HashMap< String, Object > hdr) throws Throwable
 executes a POST call on the remote REST service and returns the response More...
 
HashMap< String, ObjectpostRestWithInfo (String path, Object args) throws Throwable
 executes a POST call on the remote REST service and returns the response More...
 
HashMap< String, ObjectpostRestWithInfo (String path) throws Throwable
 executes a POST call on the remote REST service and returns the response More...
 
Object postRest (String path, Object args, HashMap< String, Object > hdr) throws Throwable
 executes a POST call on the remote REST service and returns the response More...
 
Object postRest (String path, Object args) throws Throwable
 executes a POST call on the remote REST service and returns the response More...
 
Object postRest (String path) throws Throwable
 executes a POST call on the remote REST service and returns the response More...
 
HashMap< String, ObjectdelRestWithInfo (String path, Object args, HashMap< String, Object > hdr) throws Throwable
 executes a DELETE call on the remote REST service and returns the response More...
 
HashMap< String, ObjectdelRestWithInfo (String path, Object args) throws Throwable
 executes a DELETE call on the remote REST service and returns the response More...
 
HashMap< String, ObjectdelRestWithInfo (String path) throws Throwable
 executes a DELETE call on the remote REST service and returns the response More...
 
Object delRest (String path, Object args, HashMap< String, Object > hdr) throws Throwable
 executes a DELETE call on the remote REST service and returns the response More...
 
Object delRest (String path, Object args) throws Throwable
 executes a DELETE call on the remote REST service and returns the response More...
 
Object delRest (String path) throws Throwable
 executes a DELETE call on the remote REST service and returns the response More...
 
HashMap< String, ObjectrestDoWithInfo (String m, String path, Object args, HashMap< String, Object > hdr) throws Throwable
 executes the remote REST call and returns the response More...
 
HashMap< String, ObjectrestDoWithInfo (String m, String path, Object args) throws Throwable
 executes the remote REST call and returns the response More...
 
HashMap< String, ObjectrestDoWithInfo (String m, String path) throws Throwable
 executes the remote REST call and returns the response More...
 
Object restDo (String m, String path, Object args, HashMap< String, Object > hdr) throws Throwable
 executes the remote REST call and returns the response More...
 
Object restDo (String m, String path, Object args) throws Throwable
 executes the remote REST call and returns the response More...
 
Object restDo (String m, String path) throws Throwable
 executes the remote REST call and returns the response More...
 

Detailed Description

Java wrapper for the OMQ::QorusSystemRestHelper class in Qore.

Constructor & Destructor Documentation

◆ QorusSystemRestHelper() [1/2]

com.qoretechnologies.qorus.QorusSystemRestHelper.QorusSystemRestHelper ( ) throws Throwable
inline

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

Since
Qorus 3.0.2

◆ QorusSystemRestHelper() [2/2]

com.qoretechnologies.qorus.QorusSystemRestHelper.QorusSystemRestHelper ( String  username,
String  password 
) throws Throwable
inline

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

Parameters
usernamethe username for the connection
passwordthe password for the connection
Since
Qorus 3.0.2

Member Function Documentation

◆ delRest() [1/3]

Object com.qoretechnologies.qorus.QorusSystemRestHelper.delRest ( String  path,
Object  args,
HashMap< String, Object hdr 
) throws Throwable
inline

executes a DELETE call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
hdra hash of optional HTTP header info to add to the request
Returns
the deserialized response body

◆ delRest() [2/3]

Object com.qoretechnologies.qorus.QorusSystemRestHelper.delRest ( String  path,
Object  args 
) throws Throwable
inline

executes a DELETE call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
Returns
the deserialized response body

◆ delRest() [3/3]

Object com.qoretechnologies.qorus.QorusSystemRestHelper.delRest ( String  path) throws Throwable
inline

executes a DELETE call on the remote REST service and returns the response

Parameters
paththe URI path for the request
Returns
the deserialized response body

◆ delRestWithInfo() [1/3]

HashMap<String, Object> com.qoretechnologies.qorus.QorusSystemRestHelper.delRestWithInfo ( String  path,
Object  args,
HashMap< String, Object hdr 
) throws Throwable
inline

executes a DELETE call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
hdra hash of optional HTTP header info to add to the request
Returns
a hash with the following keys:
  • rv: the deserialized response body
  • info: 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: "DELETE /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

◆ delRestWithInfo() [2/3]

HashMap<String, Object> com.qoretechnologies.qorus.QorusSystemRestHelper.delRestWithInfo ( String  path,
Object  args 
) throws Throwable
inline

executes a DELETE call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
Returns
a hash with the following keys:
  • rv: the deserialized response body
  • info: 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: "DELETE /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

◆ delRestWithInfo() [3/3]

HashMap<String, Object> com.qoretechnologies.qorus.QorusSystemRestHelper.delRestWithInfo ( String  path) throws Throwable
inline

executes a DELETE call on the remote REST service and returns the response

Parameters
paththe URI path for the request
Returns
a hash with the following keys:
  • rv: the deserialized response body
  • info: 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: "DELETE /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

◆ getRest() [1/3]

Object com.qoretechnologies.qorus.QorusSystemRestHelper.getRest ( String  path,
Object  args,
HashMap< String, Object hdr 
) throws Throwable
inline

executes a GET call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
hdra hash of optional HTTP header info to add to the request
Returns
the deserialized response body

◆ getRest() [2/3]

Object com.qoretechnologies.qorus.QorusSystemRestHelper.getRest ( String  path,
Object  args 
) throws Throwable
inline

executes a GET call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
Returns
the deserialized response body

◆ getRest() [3/3]

Object com.qoretechnologies.qorus.QorusSystemRestHelper.getRest ( String  path) throws Throwable
inline

executes a GET call on the remote REST service and returns the response

Parameters
paththe URI path for the request
Returns
the deserialized response body

◆ getRestWithInfo() [1/3]

HashMap<String, Object> com.qoretechnologies.qorus.QorusSystemRestHelper.getRestWithInfo ( String  path,
Object  args,
HashMap< String, Object hdr 
) throws Throwable
inline

executes a GET call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
hdra hash of optional HTTP header info to add to the request
Returns
a hash with the following keys:
  • rv: the deserialized response body
  • info: 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

◆ getRestWithInfo() [2/3]

HashMap<String, Object> com.qoretechnologies.qorus.QorusSystemRestHelper.getRestWithInfo ( String  path,
Object  args 
) throws Throwable
inline

executes a GET call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
Returns
a hash with the following keys:
  • rv: the deserialized response body
  • info: 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

◆ getRestWithInfo() [3/3]

HashMap<String, Object> com.qoretechnologies.qorus.QorusSystemRestHelper.getRestWithInfo ( String  path) throws Throwable
inline

executes a GET call on the remote REST service and returns the response

Parameters
paththe URI path for the request
Returns
a hash with the following keys:
  • rv: the deserialized response body
  • info: 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

◆ postRest() [1/3]

Object com.qoretechnologies.qorus.QorusSystemRestHelper.postRest ( String  path,
Object  args,
HashMap< String, Object hdr 
) throws Throwable
inline

executes a POST call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
hdra hash of optional HTTP header info to add to the request
Returns
the deserialized response body

◆ postRest() [2/3]

Object com.qoretechnologies.qorus.QorusSystemRestHelper.postRest ( String  path,
Object  args 
) throws Throwable
inline

executes a POST call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
Returns
the deserialized response body

◆ postRest() [3/3]

Object com.qoretechnologies.qorus.QorusSystemRestHelper.postRest ( String  path) throws Throwable
inline

executes a POST call on the remote REST service and returns the response

Parameters
paththe URI path for the request
Returns
the deserialized response body

◆ postRestWithInfo() [1/3]

HashMap<String, Object> com.qoretechnologies.qorus.QorusSystemRestHelper.postRestWithInfo ( String  path,
Object  args,
HashMap< String, Object hdr 
) throws Throwable
inline

executes a POST call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
hdra hash of optional HTTP header info to add to the request
Returns
a hash with the following keys:
  • rv: the deserialized response body
  • info: 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: "POST /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

◆ postRestWithInfo() [2/3]

HashMap<String, Object> com.qoretechnologies.qorus.QorusSystemRestHelper.postRestWithInfo ( String  path,
Object  args 
) throws Throwable
inline

executes a POST call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
Returns
a hash with the following keys:
  • rv: the deserialized response body
  • info: 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: "POST /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

◆ postRestWithInfo() [3/3]

HashMap<String, Object> com.qoretechnologies.qorus.QorusSystemRestHelper.postRestWithInfo ( String  path) throws Throwable
inline

executes a POST call on the remote REST service and returns the response

Parameters
paththe URI path for the request
Returns
a hash with the following keys:
  • rv: the deserialized response body
  • info: 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: "POST /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

◆ putRest() [1/3]

Object com.qoretechnologies.qorus.QorusSystemRestHelper.putRest ( String  path,
Object  args,
HashMap< String, Object hdr 
) throws Throwable
inline

executes a PUT call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
hdra hash of optional HTTP header info to add to the request
Returns
the deserialized response body

◆ putRest() [2/3]

Object com.qoretechnologies.qorus.QorusSystemRestHelper.putRest ( String  path,
Object  args 
) throws Throwable
inline

executes a PUT call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
Returns
the deserialized response body

◆ putRest() [3/3]

Object com.qoretechnologies.qorus.QorusSystemRestHelper.putRest ( String  path) throws Throwable
inline

executes a PUT call on the remote REST service and returns the response

Parameters
paththe URI path for the request
Returns
the deserialized response body

◆ putRestithInfo()

HashMap<String, Object> com.qoretechnologies.qorus.QorusSystemRestHelper.putRestithInfo ( String  path) throws Throwable
inline

executes a PUT call on the remote REST service and returns the response

Parameters
paththe URI path for the request
Returns
a hash with the following keys:
  • rv: the deserialized response body
  • info: 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: "PUT /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

◆ putRestWithInfo() [1/2]

HashMap<String, Object> com.qoretechnologies.qorus.QorusSystemRestHelper.putRestWithInfo ( String  path,
Object  args,
HashMap< String, Object hdr 
) throws Throwable
inline

executes a PUT call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
hdra hash of optional HTTP header info to add to the request
Returns
a hash with the following keys:
  • rv: the deserialized response body
  • info: 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: "PUT /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

◆ putRestWithInfo() [2/2]

HashMap<String, Object> com.qoretechnologies.qorus.QorusSystemRestHelper.putRestWithInfo ( String  path,
Object  args 
) throws Throwable
inline

executes a PUT call on the remote REST service and returns the response

Parameters
paththe URI path for the request
argsany arguments to the REST request
Returns
a hash with the following keys:
  • rv: the deserialized response body
  • info: 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: "PUT /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

◆ restDo() [1/3]

Object com.qoretechnologies.qorus.QorusSystemRestHelper.restDo ( String  m,
String  path,
Object  args,
HashMap< String, Object hdr 
) throws Throwable
inline

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
Returns
the deserialized response body

◆ restDo() [2/3]

Object com.qoretechnologies.qorus.QorusSystemRestHelper.restDo ( String  m,
String  path,
Object  args 
) throws Throwable
inline

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
Returns
the deserialized response body

◆ restDo() [3/3]

Object com.qoretechnologies.qorus.QorusSystemRestHelper.restDo ( String  m,
String  path 
) throws Throwable
inline

executes the remote REST call and returns the response

Parameters
mthe HTTP method for the request (ex: "GET")
paththe URI path for the request
Returns
the deserialized response body

◆ restDoWithInfo() [1/3]

HashMap<String, Object> com.qoretechnologies.qorus.QorusSystemRestHelper.restDoWithInfo ( String  m,
String  path,
Object  args,
HashMap< String, Object hdr 
) throws Throwable
inline

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
Returns
a hash with the following keys:
  • rv: the deserialized response body
  • info: 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: "DELETE /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

◆ restDoWithInfo() [2/3]

HashMap<String, Object> com.qoretechnologies.qorus.QorusSystemRestHelper.restDoWithInfo ( String  m,
String  path,
Object  args 
) throws Throwable
inline

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
Returns
a hash with the following keys:
  • rv: the deserialized response body
  • info: 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: "DELETE /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

◆ restDoWithInfo() [3/3]

HashMap<String, Object> com.qoretechnologies.qorus.QorusSystemRestHelper.restDoWithInfo ( String  m,
String  path 
) throws Throwable
inline

executes the remote REST call and returns the response

Parameters
mthe HTTP method for the request (ex: "GET")
paththe URI path for the request
Returns
a hash with the following keys:
  • rv: the deserialized response body
  • info: 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: "DELETE /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

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