Class ZCL_IBMC_SERVICE

Class ZCL_IBMC_SERVICE_EXT

public inheriting from zcl_ibmc_service create public

Documentation

Extended REST API service class

Types

Visibility and Level	Name	Documentation
public	ts_oauth_prop (structured type)
public	ty_image_class type string
public	ty_image_format (typing)
public	ty_instance_id (typing)
public	ty_servicename (typing)

Constants

Visibility and Level	Name	Documentation
public static	c_field_none type fieldname value '###'	Field Name
public static	c_format_all type ty_image_format value '*'	Image encoding (jpg, png, ...)
public static	c_format_gif type ty_image_format value 'gif'	Image encoding (jpg, png, ...)
public static	c_format_jpg type ty_image_format value 'jpg'	Image encoding (jpg, png, ...)
public static	c_format_png type ty_image_format value 'png'	Image encoding (jpg, png, ...)
public static	c_format_tif type ty_image_format value 'tif'	Image encoding (jpg, png, ...)
public static	c_format_unknown type ty_image_format value '###'	Image encoding (jpg, png, ...)
public static	c_format_zip type ty_image_format value 'zip'	Image encoding (jpg, png, ...)
public static	c_iam_token_host type string value 'iam.cloud.ibm.com'
public static	c_iam_token_path type string value '/identity/token'
public static	c_icp4d_token_path type string value '/v1/preauth/validateAuth'
public static	c_token_generation_always type char value 'A'
public static	c_token_generation_auto type char value space
public static	c_token_generation_never type char value 'N'

Attributes

Visibility and Level	Name	Documentation
public instance	p_instance_id type ty_instance_id
public instance	p_servicename type ty_servicename

Methods

Visibility and Level

Name

Documentation

public static

get_instance
importing	i_instance_id	type ty_instance_id optional
	i_url	type string optional
	i_host	type string optional
	i_username	type string optional
	i_password	type string optional
	i_proxy_host	type string optional
	i_proxy_port	type string optional
	i_apikey	type string optional
	i_auth_method	type string default c_default
	i_oauth_prop	type ts_oauth_prop optional
	i_access_token	type ts_access_token optional
	i_token_generation	type char default c_token_generation_auto
	i_request_headers	type string optional
	i_version	type string optional
exporting	value(eo_instance)	type any

Factory method to instantiate a service specific wrapper class.

Parameters

i_instance_id	Value of field INSTANCE_UID in table ZIBMC_CONFIG. Service credentials are read from table ZIBMC_CONFIG with key SERVICE = Name of service wrapper class without prefix ZCL_IBMC_ and INSTANCE_UID.
i_url	URL of the service.
i_host	Host of the service. I_URL and I_HOST can be used synonymously.
i_username	User password to authenticate on service.
i_password	User password to authenticate on service.
i_proxy_host	Proxy server, not applicable on SAP Cloud Platform.
i_proxy_port	Proxy server port, not applicable on SAP Cloud Platform.
i_apikey	API key password to authenticate on service.
i_auth_method	Authentication method. Possible values are "IAM", "ICP4D", "basicAuth", "NONE".
i_oauth_prop	Credentials to generate token for OAuth authentication.
i_token_generation	Method for access token refresh: C_TOKEN_GENERATION_NEVER - Access token is not refreshed. C_TOKEN_GENERATION_ALWAYS - Access to token is refreshed for each service call. C_TOKEN_GENERATION_AUTO - Access to token is refreshed just before it expires.
i_request_headers	List of headers sent with every request, format 'Header1=Value1;Header2=Value2'.
i_version	Value of query parameter VERSION.

public static

get_zipdata
importing	it_examples	type any table
	iv_field_class	type fieldname default c_field_none
	iv_field_filename	type fieldname optional
	iv_field_image	type fieldname optional
	iv_image_format	type ty_image_format optional
	iv_image_name	type string optional
exporting	et_zipdata	type tt_map_file
raising	zcx_ibmc_service_exception

Compresses multiple images from an internal table

to a one or more xstrings in ZIP format.

Parameters

it_examples	Internal table of images.
iv_field_class	Field in IT_EXAMPLES that contains the file class. All records in IT_EXAMPLES with same class will be compress into one ZIP xstring.
iv_field_filename	Field in IT_EXAMPLES that contains the filename for the image.
iv_field_image	Field in IT_EXAMPLES that contains the image.
iv_image_format	Format of the image. Possible values are C_FORMAT_JPG, C_FORMAT_PNG, C_FORMAT_GIF, C_FORMAT_TIF, C_FORMAT_ALL.
iv_image_name	Name of the image.
et_zipdata	Internal table containing a compressed ZIP xstring for each image class.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

get_access_token redefinition

public instance

get_bearer_token
returning	value(e_bearer_token)	type string

Returns the bearer token, if available.

Parameters

e_bearer_token

Access token.

public instance

get_config_value
importing	i_default	type zibmc_config-value optional
	i_param	type zibmc_config-param
returning	value(e_value)	type zibmc_config-value
raising	zcx_ibmc_service_exception

Retrieves a value of a configuration parameter

from table ZIBMC_CONFIG.

Parameters

i_default	Default value, if configuration parameter is not found.
i_param	Configuration parameter name.

public instance

get_request_prop redefinition

public instance

get_sdk_version_date
returning	value(e_sdk_version_date)	type string

Returns the SDK built date.

Parameters

e_sdk_version_date

Built data in format YYYYMMDD.

public instance

set_bearer_token
importing	i_bearer_token	type string

Method for internal use.