Sap4HanaRestClient::Sap4HanaRestConnection Class Reference

class for SAP S/4Hana REST connections; returns Sap4HanaRestClient::Sap4HanaRestClient objects More...

Inheritance diagram for Sap4HanaRestClient::Sap4HanaRestConnection:

Public Member Methods
deprecated	constructor (string name, string desc, string url, bool monitor, *hash< auto > opts, hash< auto > urlh)
	DEPRECATED: creates the Sap4HanaRestConnection object. More...
	constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
	creates the Sap4HanaRestConnection object More...
*hash< auto >	getDefaultOptions ()
	returns default options
hash< auto >	getOptions ()
	gets options More...
string	getType ()
	returns "sap4hanarest"

Static Public Member Methods
static deprecated Sap4HanaRestConnection	make (string name, string desc, string url, bool monitor, *hash< auto > opts, hash< auto > urlh)
	DEPRECATED: static constructor. More...

Public Attributes
const	Options
	Sap4HanaRestConnection object connection options.

Private Member Methods
hash< ConnectionConstructorInfo >	getConstructorInfoImpl ()
	returns a hash that can be used to construct the object dynamically More...
Sap4HanaRestClient	getImpl (bool connect=True, *hash< auto > rtopts)
	returns a Sap4HanaRestClient::Sap4HanaRestClient object More...

Detailed Description

class for SAP S/4Hana REST connections; returns Sap4HanaRestClient::Sap4HanaRestClient objects

supports the following options:

• "apikey": (required if "client_id" and "client_secret" are not supplied) the SAP S/4Hana api key
• "client_id": (required if "apikey" is not supplied) the SAP S/4Hana OAuth2 client ID
• "client_secret": (required if "apikey" is not supplied) the SAP S/4Hana OAuth2 client secret
• "connect_timeout": connection timeout to use in milliseconds
• "content_encoding": this sets the send encoding (if the "send_encoding" option is not set) and the requested response encoding; for possible values, see EncodingSupport
• "data": see DataSerializationOptions for possible values; the default is "json"
• "error_passthru": if True then HTTP status codes indicating errors will not cause an REST-RESPONSE-ERROR exception to be raised, rather such responses will be passed through to the caller like any other response
• "http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")
• "max_redirects": maximum redirects to support
• "proxy": proxy URL to use
• "redirect_passthru": if True then redirect responses will be passed to the called instead of processed
• "send_encoding": a send data encoding option or the value "auto" which means to use automatic encoding; if not present defaults to no content-encoding on sent message bodies
• "timeout": transfer timeout to use in milliseconds

See also

Sap4HanaRestClient::constructor() for more information on the above options

Member Function Documentation

constructor() [1/2]

deprecated Sap4HanaRestClient::Sap4HanaRestConnection::constructor	(	string	name,
		string	desc,
		string	url,
		bool	monitor,
		*hash< auto >	opts,
		hash< auto >	urlh
	)

DEPRECATED: creates the Sap4HanaRestConnection object.

Parameters

name	the name of the connection
desc	connection description
url	connection URL (potentially with password info)
monitor	monitoring flag
opts	connection options
urlh	broken down URL hash (as returned by Qore::parse_url())

Exceptions

SAP4HANARESTCONNECTION-ERROR

missing apikey option

Deprecated:

since Qore 0.9

constructor() [2/2]

Sap4HanaRestClient::Sap4HanaRestConnection::constructor	(	string	name,
		string	description,
		string	url,
		hash< auto >	attributes = {},
		hash< auto >	options = {}
	)

creates the Sap4HanaRestConnection object

Parameters

name	the name of the connection
description	connection description
url	connection URL (potentially with password info)
attributes	various attributes. See below
options	connection options

See AbstractConnection::constructor() for attributes and options reference.

Exceptions

SAP4HANARESTCONNECTION-ERROR

missing apikey option

getConstructorInfoImpl()

hash<ConnectionConstructorInfo> Sap4HanaRestClient::Sap4HanaRestConnection::getConstructorInfoImpl ( )

privatevirtual

returns a hash that can be used to construct the object dynamically

Since

Sap4HanaRestClient 1.5

Reimplemented from RestClient::RestConnection.

getImpl()

Sap4HanaRestClient Sap4HanaRestClient::Sap4HanaRestConnection::getImpl ( bool  connect = True, *hash< auto >  rtopts  )

private

returns a Sap4HanaRestClient::Sap4HanaRestClient object

Parameters

connect	if True, then the connection is returned already connected
rtopts	this connection type does not accept any runtime options, so this parameter is ignored

Returns

a Sap4HanaRestClient object

getOptions()

hash<auto> Sap4HanaRestClient::Sap4HanaRestConnection::getOptions

(

)

gets options

Returns

returns a hash with the following supported options:

• "apikey": the SAP S/4Hana API key in use
• "connect_timeout": connection timeout to use in milliseconds
• "content_encoding": this sets the send encoding (if the "send_encoding" option is not set) and the requested response encoding; for possible values, see EncodingSupport
• "data": see RestClient::RestClient::DataSerializationOptions for possible values; the default is "json"
• "error_passthru": if True then HTTP status codes indicating errors will not cause an REST-RESPONSE-ERROR exception to be raised, rather such responses will be passed through to the caller like any other response
• "http_version": HTTP version to use ("1.0" or "1.1", defaults to "1.1")
• "max_redirects": maximum redirects to support
• "proxy": proxy URL to use
• "redirect_passthru": if True then redirect responses will be passed to the called instead of processed
• "send_encoding": a send data encoding option or the value "auto" which means to use automatic encoding; if not present defaults to no content-encoding on sent message bodies
• "timeout": transfer timeout to use in milliseconds

See also

Sap4HanaRestClient::constructor() for more information on the above options

make()

static deprecated Sap4HanaRestConnection Sap4HanaRestClient::Sap4HanaRestConnection::make ( string  name, string  desc, string  url, bool  monitor, *hash< auto >  opts, hash< auto >  urlh  )

static

DEPRECATED: static constructor.

Deprecated:

since Qore 0.9 in favor of new constructor and Qore::Reflection