SAP ABAP Interface IF_HTTP_CLIENT (HTTP Client Abstraction)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-MID-ICF (Application Component) Internet Communication Framework
     ⤷ SHTTP (Package) Development Class for HTTP Communication

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_HTTP_CLIENT	HTTP Client Control Block	20001017

Properties

Interface	IF_HTTP_CLIENT
Short Description	HTTP Client Abstraction

General Data

Package	SHTTP	Development Class for HTTP Communication
Created	20000317	SAP
Last changed	20130531	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Interface IF_HTTP_CLIENT has no interface.

Friends

Interface IF_HTTP_CLIENT has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_COMPRESS_BASED_ON_MIME_TYPE	Constant	Public	☐	Type reference (TYPE)	I	2	Compression Only for Defined MIME Types	20011018
2	CO_COMPRESS_IN_ALL_CASES	Constant	Public	☐	Type reference (TYPE)	I	1	Compress All Documents	20011018
3	CO_COMPRESS_NONE	Constant	Public	☐	Type reference (TYPE)	I	0	No Compression	20011022
4	CO_DISABLED	Constant	Public	☐	Type reference (TYPE)	I	0	Inactive	20000918
5	CO_ENABLED	Constant	Public	☐	Type reference (TYPE)	I	1	Active	20000918
6	CO_EVENT	Constant	Public	☐	Type reference (TYPE)	I	3	Event handler	20010220
7	CO_PROMPT	Constant	Public	☐	Type reference (TYPE)	I	2	Prompt	20010126
8	CO_TIMEOUT_DEFAULT	Constant	Public	☐	Type reference (TYPE)	I	0	Timeout Standard Value (Instance Timeout)	20010130
9	CO_TIMEOUT_INFINITE	Constant	Public	☐	Type reference (TYPE)	I	-1	No Timeout	20010130
10	PROPERTYTYPE_ACCEPT_COMPRESS	Instance attribute	Public	☐	Type reference (TYPE)	I		Send accept-encoding: gzip	20031010
11	PROPERTYTYPE_ACCEPT_COOKIE	Instance attribute	Public	☐	Type reference (TYPE)	I		Transfer Cookie Fields from Response	20010124
12	PROPERTYTYPE_APPLY_SPROXY	Instance attribute	Public	☐	Type reference (TYPE)	I		Evaluation of System Proxy Configuration	20010717
13	PROPERTYTYPE_LOGON_POPUP	Instance attribute	Public	☐	Type reference (TYPE)	I		Display Logon Screen	20000920
14	PROPERTYTYPE_REDIRECT	Instance attribute	Public	☐	Type reference (TYPE)	I		Redirect Documents	20000519
15	PROPERTYTYPE_SEND_SAP_PASSPORT	Instance attribute	Public	☐	Type reference (TYPE)	I		Send SAP Passport	20040120
16	REQUEST	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP request object	20000317
17	RESPONSE	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_HTTP_RESPONSE		HTTP response object	20000317
18	VERSION	Constant	Public	☐	Type reference (TYPE)	STRING	'1.0'	HTTP Client (User-Agent) Version	20000317

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	APPEND_FIELD_URL	Instance method	Public	Method	Appends the Given Name/Value to the Query String of the URL	20000317
2	AUTHENTICATE	Instance method	Public	Method	Logon Data (Basic Authentication)	20000317
3	CLOSE	Instance method	Public	Method	Close of HTTP connection	20000317
4	CREATE_ABS_URL	Instance method	Public	Method	Creates an Absolute URL	20000317
5	CREATE_REL_URL	Instance method	Public	Method	Creates a Relative URL	20000317
6	ESCAPE_HTML	Static method	Public	Method	HTML encodes the given string, e.g. replaces '<' with '<'	20000317
7	ESCAPE_URL	Static method	Public	Method	URL encodes the given string, e.g. replaces space with %20	20000317
8	GET_LAST_ERROR	Instance method	Public	Method	Returns Return Code of Last Method Call	20000317
9	LISTEN	Static method	Public	Method	Waiting for HTTP Response	20000330
10	RECEIVE	Instance method	Public	Method	Receipt of HTTP Response	20000317
11	REFRESH_COOKIE	Instance method	Public	Method	Refresh Cookie Object	20010123
12	REFRESH_REQUEST	Instance method	Public	Method	Refresh Request Object	20000929
13	REFRESH_RESPONSE	Instance method	Public	Method	Refresh response Object	20000929
14	SEND	Instance method	Public	Method	Structure of HTTP Connection and Dispatch of Data	20000403
15	SEND_SAP_ASSERTION_TICKET	Instance method	Public	Method	Send SAP Assertion Ticket	20080826
16	SEND_SAP_LOGON_TICKET	Instance method	Public	Method	Send SAP Logon Ticket	20031216
17	SET_COMPRESSION	Instance method	Public	Method	Activation/Deactivation of Compression	20011018
18	UNESCAPE_URL	Static method	Public	Method	URL Decodes the Given String	20000317

Events

#	Event	Type	Visibility	Description	Created on
1	EVENTKIND_HANDLE_COOKIE	Instance Event (0)	Public (2)	Cookie Handling	20010220

Types

Interface IF_HTTP_CLIENT has no local type.

Method Signatures

Method APPEND_FIELD_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING		the name of the field	20000317
2	Changing	URL	Call by reference	☐	Type reference (TYPE)	STRING		the URL to which to append the field	20000317
3	Importing	VALUE	Call by reference	☐	Type reference (TYPE)	STRING		the value of the field	20000317

Method APPEND_FIELD_URL on Interface IF_HTTP_CLIENT has no exception.

Method AUTHENTICATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☑	Type reference (TYPE)	SYMANDT		R/3-System, Mandantennummer aus Anmeldung	20000321
2	Importing	LANGUAGE	Call by reference	☑	Type reference (TYPE)	SYLANGU		R/3-System, aktuelle Sprache	20000321
3	Importing	PASSWORD	Call by reference	☐	Type reference (TYPE)	STRING		Anmdelekennung	20000321
4	Importing	PROXY_AUTHENTICATION	Call by reference	☐	Type reference (TYPE)	C	' '	Proxy-Logon (= 'X')	20010511
5	Importing	USERNAME	Call by reference	☐	Type reference (TYPE)	STRING		R/3-System, Anmeldename des Benutzers	20000321

Method AUTHENTICATE on Interface IF_HTTP_CLIENT has no exception.

Method CLOSE Signature

Method CLOSE on Interface IF_HTTP_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	HTTP_INVALID_STATE	☐	Ungültiger Zustand	20000404

Method CREATE_ABS_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HOST	Call by reference	☐	Type reference (TYPE)	STRING	''	host name	20000317
2	Importing	PATH	Call by reference	☐	Type reference (TYPE)	STRING	''	path	20000317
3	Importing	PORT	Call by reference	☐	Type reference (TYPE)	STRING	''	port number (e.g. 80)	20000317
4	Importing	PROTOCOL	Call by reference	☐	Type reference (TYPE)	STRING	''	protocol name (e.g. http)	20000317
5	Importing	QUERYSTRING	Call by reference	☐	Type reference (TYPE)	STRING	''	query string	20000317
6	Importing	STATEFUL	Call by reference	☐	Type reference (TYPE)	I	-1	-1: current session setting	20000317
7	Returning	URL	Value transfer	☐	Type reference (TYPE)	STRING		result URL	20000317

Method CREATE_ABS_URL on Interface IF_HTTP_CLIENT has no exception.

Method CREATE_REL_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PATH	Call by reference	☐	Type reference (TYPE)	STRING	''	path	20000317
2	Importing	QUERYSTRING	Call by reference	☐	Type reference (TYPE)	STRING	''	query string	20000317
3	Importing	STATEFUL	Call by reference	☐	Type reference (TYPE)	I	-1	-1: current session setting	20000317
4	Returning	URL	Value transfer	☐	Type reference (TYPE)	STRING		result URL	20000317

Method CREATE_REL_URL on Interface IF_HTTP_CLIENT has no exception.

Method ESCAPE_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ESCAPED	Value transfer	☐	Type reference (TYPE)	STRING		HTML-encoded text	20000317
2	Importing	UNESCAPED	Call by reference	☐	Type reference (TYPE)	STRING		unencoded text	20000317

Method ESCAPE_HTML on Interface IF_HTTP_CLIENT has no exception.

Method ESCAPE_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ESCAPED	Value transfer	☐	Type reference (TYPE)	STRING		URL-encoded URL	20000317
2	Importing	UNESCAPED	Call by reference	☐	Type reference (TYPE)	STRING		unencoded URL	20000317

Method ESCAPE_URL on Interface IF_HTTP_CLIENT has no exception.

Method GET_LAST_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CODE	Call by reference	☐	Type reference (TYPE)	SYSUBRC		Rückgabewert, Rückgabewert nach ABAP-Anweisungen	20000317
2	Exporting	MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING		Fehlermeldung	20000317
3	Exporting	MESSAGE_CLASS	Call by reference	☐	Type reference (TYPE)	ARBGB		Arbeitsgebiet	20120712
4	Exporting	MESSAGE_NUMBER	Call by reference	☐	Type reference (TYPE)	MSGNR		Nachrichtennummer	20120712

Method GET_LAST_ERROR on Interface IF_HTTP_CLIENT has no exception.

Method LISTEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CLIENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_HTTP_CLIENT		HTTP Client Abstraction	20000330

#	Exception	Resumable	Description	Created on
1	HTTP_COMMUNICATION_FAILURE	☐	Kommunikationsfehler	20000404
2	HTTP_NO_OPEN_CONNECTION	☐	Keine offene Verbindungen existiert	20000404

Method RECEIVE Signature

Method RECEIVE on Interface IF_HTTP_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	HTTP_COMMUNICATION_FAILURE	☐	Kommunikationsfehler	20000404
2	HTTP_INVALID_STATE	☐	ungültiger Zustand	20000404
3	HTTP_PROCESSING_FAILED	☐	Bearbeitung der Methode misslungen	20010123

Method REFRESH_COOKIE Signature

Method REFRESH_COOKIE on Interface IF_HTTP_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	HTTP_ACTION_FAILED	☐	Die Ausführung der Methode ist misslungen	20010123
2	HTTP_PROCESSING_FAILED	☐	Bearbeitung der Methode misslungen	20010123

Method REFRESH_REQUEST Signature

Method REFRESH_REQUEST on Interface IF_HTTP_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	HTTP_ACTION_FAILED	☐	Die Ausführung der Methode ist misslungen	20001005

Method REFRESH_RESPONSE Signature

Method REFRESH_RESPONSE on Interface IF_HTTP_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	HTTP_ACTION_FAILED	☐	Die Ausführung der Methode ist misslungen	20001005

Method SEND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TIMEOUT	Call by reference	☐	Type reference (TYPE)	I	CO_TIMEOUT_DEFAULT	Timeout von Antwortwartezeit	20010130

#	Exception	Resumable	Description	Created on
1	HTTP_COMMUNICATION_FAILURE	☐	Kommunikationsfehler	20000404
2	HTTP_INVALID_STATE	☐	Ungültiger Zustand	20000404
3	HTTP_INVALID_TIMEOUT	☐	Ungültige Zeitangabe	20010130
4	HTTP_PROCESSING_FAILED	☐	Bearbeitung der Methode misslungen	20010123

Method SEND_SAP_ASSERTION_TICKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	SYMANDT		Mandantenkennung des aktuellen Benutzers	20080826
2	Importing	SYSTEM_ID	Call by reference	☐	Type reference (TYPE)	SYSYSID		Name des SAP-Systems	20080826

#	Exception	Resumable	Description	Created on
1	ARGUMENT_NOT_FOUND	☐	Parameter (Client oder SYSTEM_ID) ist nicht verfügbar	20080826

Method SEND_SAP_LOGON_TICKET Signature

Method SEND_SAP_LOGON_TICKET on Interface IF_HTTP_CLIENT has no parameter.
Method SEND_SAP_LOGON_TICKET on Interface IF_HTTP_CLIENT has no exception.

Method SET_COMPRESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OPTIONS	Call by reference	☐	Type reference (TYPE)	I	CO_COMPRESS_BASED_ON_MIME_TYPE	CO_COMPRESS_NONE,CO_COMPRESS_IN_ALL_CASES, CO_COMPRESS_BASED	20011018

#	Exception	Resumable	Description	Created on
1	COMPRESSION_NOT_POSSIBLE	☐	Komprimierung ist nicht möglich	20011018

Method UNESCAPE_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ESCAPED	Call by reference	☐	Type reference (TYPE)	STRING		encoded URL	20000317
2	Returning	UNESCAPED	Value transfer	☐	Type reference (TYPE)	STRING		decoded URL	20000317

Method UNESCAPE_URL on Interface IF_HTTP_CLIENT has no exception.

Event Signatures

Event EVENTKIND_HANDLE_COOKIE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	CLIENT	Exporting	Value transfer	☑	Object reference (TYPE REF TO)	IF_HTTP_CLIENT		HTTP Client Abstraction	20010220
2	COOKIES	Exporting	Value transfer	☑	Type reference (TYPE)	TIHTTPCKI		HTTP cookies	20010220

History

Last changed by/on	SAP	20130531
SAP Release Created in	50A