com.qoretechnologies.qorus.QorusSystemRestHelper Class Reference

Inheritance diagram for com.qoretechnologies.qorus.QorusSystemRestHelper:

Public Member Methods
	QorusSystemRestHelper (QoreObject obj)
	QorusSystemRestHelper () throws Throwable
	QorusSystemRestHelper (String name) throws Throwable
	QorusSystemRestHelper (String username, String password) throws Throwable
	QorusSystemRestHelper (HashMap< String, Object > info) throws Throwable
HashMap< String, Object >	getRestWithInfo (String path, Object args, HashMap< String, Object > hdr) throws Throwable
HashMap< String, Object >	getRestWithInfo (String path, Object args) throws Throwable
HashMap< String, Object >	getRestWithInfo (String path) throws Throwable
Object	getRest (String path, Object args, HashMap< String, Object > hdr) throws Throwable
Object	getRest (String path, Object args) throws Throwable
Object	getRest (String path) throws Throwable
HashMap< String, Object >	putRestWithInfo (String path, Object args, HashMap< String, Object > hdr) throws Throwable
HashMap< String, Object >	putRestWithInfo (String path, Object args) throws Throwable
HashMap< String, Object >	putRestithInfo (String path) throws Throwable
Object	putRest (String path, Object args, HashMap< String, Object > hdr) throws Throwable
Object	putRest (String path, Object args) throws Throwable
Object	putRest (String path) throws Throwable
HashMap< String, Object >	postRestWithInfo (String path, Object args, HashMap< String, Object > hdr) throws Throwable
HashMap< String, Object >	postRestWithInfo (String path, Object args) throws Throwable
HashMap< String, Object >	postRestWithInfo (String path) throws Throwable
Object	postRest (String path, Object args, HashMap< String, Object > hdr) throws Throwable
Object	postRest (String path, Object args) throws Throwable
Object	postRest (String path) throws Throwable
HashMap< String, Object >	delRestWithInfo (String path, Object args, HashMap< String, Object > hdr) throws Throwable
HashMap< String, Object >	delRestWithInfo (String path, Object args) throws Throwable
HashMap< String, Object >	delRestWithInfo (String path) throws Throwable
Object	delRest (String path, Object args, HashMap< String, Object > hdr) throws Throwable
Object	delRest (String path, Object args) throws Throwable
Object	delRest (String path) throws Throwable
HashMap< String, Object >	restDoWithInfo (String m, String path, Object args, HashMap< String, Object > hdr) throws Throwable
HashMap< String, Object >	restDoWithInfo (String m, String path, Object args) throws Throwable
HashMap< String, Object >	restDoWithInfo (String m, String path) throws Throwable
Object	restDo (String m, String path, Object args, HashMap< String, Object > hdr) throws Throwable
Object	restDo (String m, String path, Object args) throws Throwable
Object	restDo (String m, String path) throws Throwable

Detailed Description

Java wrapper for the OMQ::QorusSystemRestHelper class in Qore

Constructor & Destructor Documentation

QorusSystemRestHelper() [1/5]

com.qoretechnologies.qorus.QorusSystemRestHelper.QorusSystemRestHelper ( QoreObject  obj )

inline

Creates the object as a wrapper for the Qore object

QorusSystemRestHelper() [2/5]

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() [3/5]

com.qoretechnologies.qorus.QorusSystemRestHelper.QorusSystemRestHelper ( String  name ) throws Throwable

inline

Creates the object with the configuration given by the name of the remote instance

QorusSystemRestHelper() [4/5]

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

username	the username for the connection
password	the password for the connection

Since

Qorus 3.0.2

QorusSystemRestHelper() [5/5]

com.qoretechnologies.qorus.QorusSystemRestHelper.QorusSystemRestHelper ( HashMap< String, Object >  info ) throws Throwable

inline

Creates the object with the configuration given

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

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

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

path	the URI path for the request
args	any 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

path	the 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

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

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

path	the URI path for the request
args	any 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

path	the 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

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

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

path	the URI path for the request
args	any 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

path	the 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

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

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

path	the URI path for the request
args	any 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

path	the 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

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

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

path	the URI path for the request
args	any 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

path	the 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

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

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

path	the URI path for the request
args	any 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

path	the 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

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

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

path	the URI path for the request
args	any 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

path	the 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

path	the 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

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

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

path	the URI path for the request
args	any 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

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

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

m	the HTTP method for the request (ex: "GET")
path	the URI path for the request
args	any 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

m	the HTTP method for the request (ex: "GET")
path	the 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

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

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

m	the HTTP method for the request (ex: "GET")
path	the URI path for the request
args	any 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

m	the HTTP method for the request (ex: "GET")
path	the 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:

• /builds/qorus/qorus/java/com/qoretechnologies/qorus/QorusSystemRestHelper.java