SAP ABAP Class CL_HMI_HTTP_CLIENT_IMPL (Generic HMI Client Using HTTP)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-XI-IBD (Application Component) Integration Builder - Design
     ⤷ SAI_SREP_API (Package) API for Repository

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_HMI_CLIENT	HMI Client	20040824

Properties

Class	CL_HMI_HTTP_CLIENT_IMPL
Short Description	Generic HMI Client Using HTTP
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SAI_SREP_API	API for Repository
Created	20040824	SAP
Last change	20071217	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_HMI_HTTP_CLIENT_IMPL has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_HMI_CLIENT	☐	☐	HMI Client	20040824

Friends

Class CL_HMI_HTTP_CLIENT_IMPL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CALLER_LEVEL	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Client Release	20040824
2	COMPLETE_URL	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Service URL with Schema	20040825
3	HOST	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Server Name	20040825
4	HTTP_CLIENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_HTTP_CLIENT			20061204
5	HTTP_DESTINATION	Instance attribute	Private	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20040913
6	HTTP_METHOD	Instance attribute	Private	☐	Type reference (TYPE)	STRING		http Method	20040824
7	LANGUAGE	Instance attribute	Private	☐	Type reference (TYPE)	SYLANGU		Language Key of Current Text Environment	20040824
8	PASSWORD	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Password	20040824
9	PORT	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Port	20040825
10	SCHEME_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	I		http or https	20040824
11	SERVICE_URL	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Service URL (Without Schema)	20040824
12	USER	Instance attribute	Private	☐	Type reference (TYPE)	STRING		User	20040824

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ANALYSE_HTTP_RESPONSE	Static method	Private	Method	Checks http response and raises an exception if not OK	20070904
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20040824
3	CREATE_HTTP_CLIENT	Instance method	Private	Method	Creates a new http client instance	20061204
4	RAISE_HMI_CORE_EX_IF_NECESSARY	Instance method	Private	Method	Creates Appropriate HMI Exception	20041008
5	RENDER_INPUT	Instance method	Private	Method	Processes Input	20040824
6	SEND_REQUEST	Instance method	Private	Method	Sends the http request and receives the response	20070904

Events

Class CL_HMI_HTTP_CLIENT_IMPL has no event.

Types

Class CL_HMI_HTTP_CLIENT_IMPL has no local type.

Method Signatures

Method ANALYSE_HTTP_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_HOST_DESTINATION	Call by reference	☐	Type reference (TYPE)	RFCDEST		logische Destination (Wird bei Funktionsaufruf angegeben)	20070904
2	Importing	IM_HOST_URL	Call by reference	☐	Type reference (TYPE)	STRING			20070904
3	Importing	IM_HTTP_REQUEST_BODY	Call by reference	☐	Type reference (TYPE)	XSTRING			20070904
4	Importing	IM_HTTP_REQUEST_URL	Call by reference	☐	Type reference (TYPE)	STRING			20070904
5	Importing	IM_HTTP_RESPONSE_BODY	Call by reference	☐	Type reference (TYPE)	XSTRING			20070904
6	Importing	IM_HTTP_RESPONSE_STATUS_CODE	Call by reference	☐	Type reference (TYPE)	I			20070904
7	Importing	IM_HTTP_RESPONSE_STATUS_REASON	Call by reference	☐	Type reference (TYPE)	STRING			20070904

#	Exception	Resumable	Description	Created on
1	CX_SRAPI_REP_NOT_AVAILABLE	☐	Repository nicht verfügbar	20070904
2	CX_SRAPI_USER_NOT_AUTHORIZED	☐	User nicht berechtigt	20070904

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CALLER_LEVEL	Call by reference	☐	Type reference (TYPE)	STRING		Clientrelease	20040824
2	Importing	IM_HTTP_DESTINATION	Call by reference	☐	Type reference (TYPE)	RFCDEST		logische Destination (Wird bei Funktionsaufruf angegeben)	20040913
3	Importing	IM_HTTP_METHOD	Call by reference	☐	Type reference (TYPE)	STRING		http-methode	20040824
4	Importing	IM_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU		Sprachenschlüssel der aktuellen Textumgebung	20040824
5	Importing	IM_PASSWORD	Call by reference	☐	Type reference (TYPE)	STRING		Passwort	20040824
6	Importing	IM_SERVICE_URL	Call by reference	☐	Type reference (TYPE)	STRING		URL des Service	20040824
7	Importing	IM_USER	Call by reference	☐	Type reference (TYPE)	STRING		User	20040824

Method CONSTRUCTOR on class CL_HMI_HTTP_CLIENT_IMPL has no exception.

Method CREATE_HTTP_CLIENT Signature

Method CREATE_HTTP_CLIENT on class CL_HMI_HTTP_CLIENT_IMPL has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SRAPI_REP_NOT_AVAILABLE	☐	Repository nicht verfügbar	20070904

Method RAISE_HMI_CORE_EX_IF_NECESSARY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_CLIENT		HTTP Client Abstraction	20041008
2	Importing	IM_HTTP_STATUS_CODE	Call by reference	☐	Type reference (TYPE)	SYSUBRC		http_status_code	20041008
3	Importing	IM_MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING		http message	20041008

#	Exception	Resumable	Description	Created on
1	CX_HMI_CORE_EXCEPTION	☐	HMI Kommunikation fehlgeschlagen	20041008

Method RENDER_INPUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_INPUT	Call by reference	☐	Object reference (TYPE REF TO)	CL_HMI_METHOD_INPUT		Input für HMI-Methodenaufruf	20040824
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	XSTRING		Ergebnis	20040824

Method RENDER_INPUT on class CL_HMI_HTTP_CLIENT_IMPL has no exception.

Method SEND_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_REQUEST_BODY	Call by reference	☐	Type reference (TYPE)	XSTRING			20070904
2	Importing	IM_TIMEOUT	Call by reference	☑	Type reference (TYPE)	I			20070904
3	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	XSTRING			20070904

#	Exception	Resumable	Description	Created on
1	CX_SRAPI_REP_NOT_AVAILABLE	☐	Repository nicht verfügbar	20070904
2	CX_SRAPI_USER_NOT_AUTHORIZED	☐	User nicht berechtigt	20070904

History

Last changed by/on	SAP	20071217
SAP Release Created in	700