Class ZCL_IBMC_SERVICE

Class ZCL_IBMC_SERVICE_ARCH

public create public

Documentation

IBM Watson SDK Platform-specifics

Interfaces

Types

Visibility and Level	Name	Documentation
public	to_form_part type ref to if_web_http_request
public	to_http_client type ref to if_web_http_client	HTTP Client Control Block
public	to_rest_request type ref to if_web_http_request
public	to_rest_response type ref to if_web_http_response
public	ts_access_token type zif_ibmc_service_arch~ts_access_token
public	ts_client (structured type)
public	ts_header type zif_ibmc_service_arch~ts_header
public	ts_http_stat (structured type)
public	ts_http_status (structured type)
public	ts_request_prop type zif_ibmc_service_arch~ts_request_prop
public	ts_url type zif_ibmc_service_arch~ts_url
public	tt_header type zif_ibmc_service_arch~tt_header

Methods

Visibility and Level

Name

Documentation

public static

base64_decode
importing	i_base64	type string
returning	value(e_binary)	type xstring
raising	zcx_ibmc_service_exception

Decodes base64 encoded data to binary.

Parameters

i_base64	Base64-encoded binary
e_binary	Binary data

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public static

convert_string_to_utf8
importing	i_string	type string
returning	value(e_utf8)	type xstring
raising	zcx_ibmc_service_exception

Converts STRING data to UTF8 encoded XSTRING.

Parameters

i_string	STRING data
e_utf8	UTF8-encoded data

public static

create_client_by_url
importing	i_url	type string
	i_request_prop	type ts_request_prop
exporting	e_client	type ts_client
raising	zcx_ibmc_service_exception

Returns a HTTP/REST client based on an URL.

Parameters

i_url	URL
i_request_prop	Request parameters
e_client	HTTP/REST client

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public static

execute
importing	i_client	type ts_client
	i_method	type zif_ibmc_service_arch~char
returning	value(e_response)	type to_rest_response
raising	zcx_ibmc_service_exception

Executes a HTTP request.

Parameters

i_client	HTTP/REST client
i_method	HTTP method (GET,POST,PUT,DELETE)
e_response	Response of the request

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public static

get_default_proxy
importing	i_url	type ts_url optional
exporting	e_proxy_host	type string
	e_proxy_port	type string

Returns the default proxy host and port.

Parameters

i_url	target URL
e_proxy_host	Proxy host
e_proxy_port	Proxy port

public static

get_http_status
importing	i_rest_response	type ref to if_web_http_response
returning	value(e_status)	type ts_http_status

Returns the status of a REST response.

Parameters

i_rest_response	HTTP/REST response
e_status	HTTP status

public static

get_progname
returning	value(e_progname)	type string

Returns an ABAP module identifier.

Parameters

e_progname

ABAP module identifier

public static

get_response_binary
importing	i_response	type ref to if_web_http_response
returning	value(e_data)	type xstring

Reads binary data from a HTTP response.

Parameters

i_response	HTTP response
e_data	Binary data

public static

get_response_header
importing	i_response	type to_rest_response
	i_header_field	type string
returning	value(e_value)	type string

Returns a HTTP response header.

Parameters

i_response	HTTP/REST response
i_header_field	Header field name
e_value	Header field value

public static

get_response_string
importing	i_response	type ref to if_web_http_response
returning	value(e_data)	type string

Reads character data from a HTTP response.

Parameters

i_response	HTTP response
e_data	Character data

public static

get_timezone
returning	value(e_timezone)	type zif_ibmc_service_arch~ty_timezone

Returns the user's time zone.

Parameters

e_timezone

user's time zone

public static

set_authentication_basic
importing	i_client	type ts_client
	i_username	type string
	i_password	type string

Sets request header for basic authentication.

Parameters

i_client	HTTP/REST client
i_username	User name
i_password	Password

public static

set_request_body_cdata
importing	i_client	type ts_client
	i_data	type string

Set character data for the body of a HTTP request.

Parameters

i_client	HTTP/REST client
i_data	Character data

public static

set_request_body_xdata
importing	i_client	type ts_client
	i_data	type xstring

Set binary data for the body of a HTTP request.

Parameters

i_client	HTTP/REST client
i_data	Binary data

public static

set_request_header
importing	i_client	type ts_client
	i_name	type string
	i_value	type string

Sets a HTTP header.

Parameters

i_client	HTTP/REST client
i_name	Header field name
i_value	Header field value

public static

set_request_uri
importing	i_client	type ts_client
	i_uri	type string

Sets the URI for a HTTP request.

Parameters

i_client	HTTP/REST client
i_uri	URI

public instance

add_form_part
importing	i_client	type ts_client
	it_form_part	type zif_ibmc_service_arch~tt_form_part
raising	zcx_ibmc_service_exception

Generates a multi-part request body.

Parameters

i_client	HTTP/REST client
it_form_part	Table of form parts

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.