Class ZCL_IBMC

Class ZCL_IBMC_SERVICE

public inheriting from zcl_ibmc_service_arch create public

Documentation

ABAP SDK for IBM Watson - Service Class

Types

Visibility and Level	Name	Documentation
public	binary type xstring
public	boolean type zif_ibmc_service_arch~boolean
public	char type zif_ibmc_service_arch~char
public	data_reference type ref to data
public	date type string
public	datetime (typing)	DateTime type, format 2018-10-23T15:18:18.914xxxZ
public	double type f
public	fieldname (typing)
public	file type xstring
public	float type f
public	integer type i
public	jsonobject type ref to data
public	long type int8
public	map type ref to data
public	number type f
public	short type int2
public	time type string
public	ts_file_with_metadata (structured type)
public	ts_form_part type zif_ibmc_service_arch~ts_form_part
public	ts_map_file (structured type)
public	tt_boolean type standard table of zif_ibmc_service_arch~boolean with non-unique default key
public	tt_char type standard table of zif_ibmc_service_arch~char with non-unique default key
public	tt_double type standard table of double with non-unique default key
public	tt_file type standard table of file with non-unique default key
public	tt_file_with_metadata type standard table of ts_file_with_metadata with non-unique default key
public	tt_float type standard table of float with non-unique default key
public	tt_form_part type zif_ibmc_service_arch~tt_form_part
public	tt_integer type standard table of integer with non-unique default key
public	tt_long type standard table of long with non-unique default key
public	tt_map_file type standard table of ts_map_file with non-unique default key
public	tt_number type standard table of number with non-unique default key
public	tt_short type standard table of short with non-unique default key
public	tt_string type zif_ibmc_service_arch~tt_string

Constants

Visibility and Level	Name	Documentation
public static	c_blank type string value '&#!-#&__%$X'
public static	c_boolean_false type boolean value space
public static	c_boolean_true type boolean value 'X'
public static	c_datatype (structured type)
public static	c_default type string value 'DEFAULT'
public static	c_f_zero type f value '-2147481.648'
public static	c_i8_zero type int8 value -9223372036854775608
public static	c_i_zero type i value -2147481648
public static	c_msgid type sy-msgid value 'ZIBMC'
public static	c_subrc_unknown type sy-subrc value 999999
public static	c_tribool_false type boolean value '-'

Attributes

Visibility and Level	Name	Documentation
public instance	p_debug_mode type char value space
public instance	p_request_prop_default type ts_request_prop
public instance	p_version type string

Methods

Visibility and Level

Name

Documentation

public static

abap_to_json
importing	i_name	type string optional
	i_value	type any
	i_dictionary	type any optional
	i_required_fields	type any optional
	i_lower_case	type boolean default c_boolean_true
returning	value(e_json)	type string

Extracts a JSON string from an ABAP structure.

Parameters

i_name	Name of component to be extracted.
i_value	ABAP structure to be converted to JSON string.
i_dictionary	Dictionary to be used for mapping ABAP identifiers to JSON keys.
i_required_fields	Dictionary of required fields. If a field is required, an initial value appears as initial value in JSON structure. Otherwise it is omitted in JSON string.
i_lower_case	If set to C_BOOLEAN_TRUE all keys in JSON string will be lower case.
e_json	JSON string.

public static

add_header_parameter
importing	i_parameter	type string
	i_value	type string
	i_is_boolean	type boolean default c_boolean_false
changing	c_headers	type zif_ibmc_service_arch~ts_request_prop-headers

Method for internal use.

public static

add_query_parameter
importing	i_parameter	type string
	i_value	type string
	i_is_boolean	type boolean default c_boolean_false
changing	c_url	type ts_url

Method for internal use.

public static

get_components
importing	i_structure	type any
exporting	value(e_components)	type zif_ibmc_service_arch~tt_string

Returns component names of a given structure.

Parameters

i_structure	Structure with components.
e_components	Internal table of component names.

public static

get_datatype
importing	i_field	type any
returning	value(e_datatype)	type zif_ibmc_service_arch~char

Returns data type of a given parameter.

Parameters

i_field	Field of type that is supposed to be determined.
e_datatype	Technical type (= base type) of I_FIELD.

public static

get_field_type
importing	i_field	type any
exporting	e_technical_type	type zif_ibmc_service_arch~char
	e_relative_type	type string
	e_length	type i

Returns field type and length of a given parameter.

Parameters

i_field	Field of type that is supposed to be determined.
e_technical_type	Technical type (= base type) of I_FIELD.
e_relative_type	Relative type (= data type) of I_FIELD.
e_length	Length of type of I_FIELD.

public static

get_file_extension
importing	value(i_mime_type)	type string
returning	value(e_extension)	type string

Returns the file extension for a mime type

, e.g. 'text/plain' -> 'txt'

Parameters

i_mime_type	MIME type.
e_extension	File extension (without leading dot).

public static

get_full_url
importing	i_url	type ts_url
returning	value(e_url)	type string

Method for internal use.

public static

move_data_reference_to_abap
importing	i_data_reference	type data_reference
exporting	value(e_abap)	type any
raising	zcx_ibmc_service_exception

Moves a referenced data structure to an ABAP structure.

Parameters

i_data_reference	Reference to data object.
e_abap	ABAP structure to be filled.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public static

normalize_url
changing	c_url	type ts_url

Method for internal use.

public static

parse_json
importing	i_json	type string
	i_dictionary	type any optional
changing	value(c_abap)	type any
	zcx_ibmc_service_exception

Parses a JSON string into an ABAP structure.

Parameters

i_json	JSON string.
i_dictionary	Dictionary for mapping of identifier names.
c_abap	ABAP structure to be filled

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public static

raise_exception
importing	i_msgno	type sy-msgno optional
	i_msgv1	type string optional
	i_msgv2	type string optional
	i_msgv3	type string optional
	i_msgv4	type string optional
	i_text	type string optional
	i_subrc	type sy-subrc default c_subrc_unknown
	i_previous	type ref to cx_root optional
	i_http_status	type ts_http_status optional
raising	zcx_ibmc_service_exception

Raises an exception.

Parameters

i_msgno	Message number.
i_msgv1	Substitution for 1st placeholder in message.
i_msgv2	Substitution for 2nd placeholder in message.
i_msgv3	Substitution for 3rd placeholder in message.
i_msgv4	Substitution for 4th placeholder in message.
i_text	Message text; specify if message number is not specified.
i_subrc	Return code being returned.
i_previous	Exception that has been captured before.
i_http_status	HTTP status code if exception is triggered by HTTP error

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised.

public static

unescape_unicode
importing	i_in	type string
returning	value(e_out)	type string

Unescape unicode codepoints to characters in a string

, e.g. '\u0041 b \u0063' -> 'A b c'

Parameters

i_in	String with unicode codepoints.
e_out	Unescaped string.

public instance

check_http_response
importing	i_response	type to_rest_response optional
	i_url	type ts_url optional
raising	zcx_ibmc_service_exception

Throws an exception, if HTTP response indicates an error.

Parameters

i_response	HTTP response to be checked.
i_url	URL that the request has been sent to.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

constructor
importing	i_url	type string optional
	i_host	type string optional
	i_proxy_host	type string optional
	i_proxy_port	type string optional
	i_username	type string optional
	i_password	type string optional
	i_apikey	type string optional
	i_access_token	type ts_access_token optional
	i_ssl_id	type zif_ibmc_service_arch~ty_ssl_id optional
	i_debug_mode	type char default space

Class constructor.

Parameters

i_url	URL of the service.
i_host	Host of the service. I_URL and I_HOST can be used synonymously.
i_proxy_host	Proxy server, not applicable on SAP Cloud Platform.
i_proxy_port	Proxy server port, not applicable on SAP Cloud Platform.
i_username	User name to authenticate on service.
i_password	User password to authenticate on service.
i_apikey	API key password to authenticate on service.
i_access_token	Access token to authenticate on service.
i_ssl_id	ID of PSE, not applicable on SAP Cloud Platform.
i_debug_mode	not used.

public instance

get_access_token
importing	i_request_prop	type ts_request_prop optional
returning	value(e_access_token)	type ts_access_token
raising	zcx_ibmc_service_exception

Method for internal use.

public instance

get_appname
returning	value(e_appname)	type string

Returns the service name.

Parameters

e_appname

Name of the service.

public instance

get_request_prop
importing	i_auth_method	type string default c_default
returning	value(e_request_prop)	type ts_request_prop

Method for internal use.

public instance

get_rest_client
importing	i_request_prop	type ts_request_prop
returning	value(e_client)	type ts_client
raising	zcx_ibmc_service_exception

Method for internal use.

public instance

http_delete
importing	i_request_prop	type ts_request_prop
returning	value(e_response)	type to_rest_response
raising	zcx_ibmc_service_exception

Sends a HTTP DELETE request.

Parameters

i_request_prop	Request properties.
e_response	Response returned by service.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

http_get
importing	i_request_prop	type ts_request_prop
returning	value(e_response)	type to_rest_response
raising	zcx_ibmc_service_exception

Sends a HTTP GET request.

Parameters

i_request_prop	Request properties.
e_response	Response returned by service.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

http_patch
importing	i_request_prop	type ts_request_prop
returning	value(e_response)	type to_rest_response
raising	zcx_ibmc_service_exception

Sends a HTTP PATCH request.

Parameters

i_request_prop	Request properties.
e_response	Response returned by service.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

http_post
importing	i_request_prop	type ts_request_prop
returning	value(e_response)	type to_rest_response
raising	zcx_ibmc_service_exception

Sends a HTTP POST request.

Parameters

i_request_prop	Request properties.
e_response	Response returned by service.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

http_post_multipart
importing	i_request_prop	type ts_request_prop
	it_form_part	type tt_form_part
returning	value(e_response)	type to_rest_response
raising	zcx_ibmc_service_exception

Sends a HTTP POST request with multipart body.

Parameters

i_request_prop	Request properties.
it_form_part	Internal table of form parts in request body.
e_response	Response returned by service.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

http_put
importing	i_request_prop	type ts_request_prop
returning	value(e_response)	type to_rest_response
raising	zcx_ibmc_service_exception

Sends a HTTP PUT request.

Parameters

i_request_prop	Request properties.
e_response	Response returned by service.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

set_access_token
importing	i_access_token	type ts_access_token

Sets an access token explicitly.

Parameters

i_access_token

Access token.