SAP ABAP Interface IF_HTTP_UTILITY (Utility Methods for HTTP Framework)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-MID-ICF (Application Component) Internet Communication Framework
     ⤷ SIHTTP (Package) HTTP Framework (iHTTP) Class Wrapper HTTP

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_HTTP_UTILITY	HTTP Framework (iHTTP) HTTP Utilities	20001122

Properties

Interface	IF_HTTP_UTILITY
Short Description	Utility Methods for HTTP Framework

General Data

Package	SIHTTP	HTTP Framework (iHTTP) Class Wrapper HTTP
Created	20000913	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_UTILITY has no interface.

Friends

Interface IF_HTTP_UTILITY has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	HTTP_WHITELIST_EP_CSS_URL	Constant	Public	☐	Type reference (TYPE)	NUMC2	'01'	Two Digit Number	20051011
2	HTTP_WHITELIST_SAP_EXITURL	Constant	Public	☐	Type reference (TYPE)	NUMC2	'02'	Two Digit Number	20051011
3	HTTP_WHITELIST_WDA_RESUME_URL	Constant	Public	☐	Type reference (TYPE)	NUMC2	'10'	Two Digit Number	20051011
4	URLCHECK_CTRLSEQ	Constant	Public	☐	Type reference (TYPE)	X	1	Checks Control Sequences	20080729
5	URLCHECK_DEFAULT	Constant	Public	☐	Type reference (TYPE)	X	6	Standard Check for this Release	20080729
6	URLCHECK_RFC2396	Constant	Public	☐	Type reference (TYPE)	X	2	Check URL for RFC2396 Syntax	20080729
7	URLCHECK_RFC2397	Constant	Public	☐	Type reference (TYPE)	X	4	Check URL for Syntax of RFC2397	20110916

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_HTTP_WHITELIST	Static method	Public	Method	URL Comparison with a White List	20050601
2	CONTENT_DISPOSITION_FILENAME	Static method	Public	Method	File Name in Content Disposition Compliant with RFC2231	20100917
3	DECODE_BASE64	Static method	Public	Method	Decodes a BASE64-Encoded String	20001122
4	DECODE_UTF8	Static method	Public	Method	Converts a string from UTF-8 to internal format	20040510
5	DECODE_X_BASE64	Static method	Public	Method	Decodes a BASE64-encoded XString	20070207
6	ENCODE_BASE64	Static method	Public	Method	Encodes a String in BASE64	20001122
7	ENCODE_UTF8	Static method	Public	Method	Converts a string from internal format to UTF-8	20040510
8	ENCODE_X_BASE64	Static method	Public	Method	Encodes an XString in BASE64	20070207
9	ESCAPE_HTML	Static method	Public	Method	Executes HTML Escaping on a String	20001122
10	ESCAPE_JAVASCRIPT	Static method	Public	Method	Executes Javascript Escaping on String	20050519
11	ESCAPE_URL	Static method	Public	Method	Executes URL Escaping on a String	20001122
12	ESCAPE_WML	Static method	Public	Method	Executes URL Escaping on a String	20011012
13	ESCAPE_XML_ATTR_VALUE	Static method	Public	Method	Executes XML Escaping for Attribut Values	20060731
14	ESCAPE_XML_CHAR_DATA	Static method	Public	Method	Executes XML Escaping for Data Between Two Nodes	20060731
15	FIELDS_TO_STRING	Static method	Public	Method	Encodes a List of Fields as a Query String	20001222
16	GET_LAST_ERROR	Static method	Public	Method	Gets the Last Occurring Error Code	20001122
17	GET_LOGON_CHARSET	Static method	Public	Method	Gets Matching ISO Codepage for Logon/System Language	20031006
18	IS_ICT_SYSTEM_CALL_IMPLEMENTED	Static method	Public	Method	Is system call available for entity processing (internal)	20021218
19	IS_VALID_URL	Static method	Public	Method	Checks whether a specified string is a valid URL	20050204
20	NORMALIZE_URL	Static method	Public	Method	Normalizes URL Path	20050809
21	REWRITE_URL	Static method	Public	Method	Formats a URL with URI Parameters	20011027
22	SET_QUERY	Static method	Public	Method	Set Query String	20030129
23	SET_REQUEST_URI	Static method	Public	Method	Sets the Request URI (Due to Upwards Compatibility)	20011107
24	STRING_TO_FIELDS	Static method	Public	Method	Decodes a Query String into a List of Fields	20001222
25	UNESCAPE_URL	Static method	Public	Method	Executes URL Unescaping on a String	20001122

Events

Interface IF_HTTP_UTILITY has no event.

Types

Interface IF_HTTP_UTILITY has no local type.

Method Signatures

Method CHECK_HTTP_WHITELIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENTRY_TYPE	Call by reference	☐	Type reference (TYPE)	HTTP_WHITELIST_ENTRY_TYPE		HTTP-Framework - Filtertyp für gültige URLs	20050601
2	Importing	URL	Value transfer	☐	Type reference (TYPE)	STRING			20050601
3	Importing	URL_PARM_NAME	Call by reference	☑	Type reference (TYPE)	CSEQUENCE			20050601

Method CHECK_HTTP_WHITELIST on Interface IF_HTTP_UTILITY has no exception.

Method CONTENT_DISPOSITION_FILENAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILE	Call by reference	☐	Type reference (TYPE)	STRING			20100917
2	Returning	FILENAME	Value transfer	☐	Type reference (TYPE)	STRING		Content Disposition, filename*=utf-8''file.txt	20100917
3	Importing	USER_AGENT_TYPE	Value transfer	☐	Type reference (TYPE)	I			20100917
4	Importing	USER_AGENT_VERSION	Value transfer	☐	Type reference (TYPE)	I			20100917

Method CONTENT_DISPOSITION_FILENAME on Interface IF_HTTP_UTILITY has no exception.

Method DECODE_BASE64 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DECODED	Value transfer	☐	Type reference (TYPE)	STRING		Dekodierter String	20001122
2	Importing	ENCODED	Call by reference	☐	Type reference (TYPE)	STRING		BASE64-kodierter String	20001122

Method DECODE_BASE64 on Interface IF_HTTP_UTILITY has no exception.

Method DECODE_UTF8 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENCODED	Call by reference	☐	Type reference (TYPE)	XSTRING		UTF-8 kcodierter Bytestring	20040510
2	Returning	UNENCODED	Value transfer	☐	Type reference (TYPE)	STRING		Intern kodierter String	20040510

#	Exception	Resumable	Description	Created on
1	CONVERSION_FAILED	☐	Bei der Konvertierung ist ein Fehler aufgetreten	20040510

Method DECODE_X_BASE64 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DECODED	Value transfer	☐	Type reference (TYPE)	XSTRING		Dekodierter XString	20070207
2	Importing	ENCODED	Call by reference	☐	Type reference (TYPE)	STRING		BASE64-kodierter XString	20070207

Method DECODE_X_BASE64 on Interface IF_HTTP_UTILITY has no exception.

Method ENCODE_BASE64 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ENCODED	Value transfer	☐	Type reference (TYPE)	STRING		BASE64-kodierter String	20001122
2	Importing	UNENCODED	Call by reference	☐	Type reference (TYPE)	STRING		Unkodierter String	20001122

Method ENCODE_BASE64 on Interface IF_HTTP_UTILITY has no exception.

Method ENCODE_UTF8 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ENCODED	Value transfer	☐	Type reference (TYPE)	XSTRING		UTF-8 kodierter Bytestring	20040510
2	Importing	UNENCODED	Call by reference	☐	Type reference (TYPE)	STRING		Intern kodierter String	20040510

#	Exception	Resumable	Description	Created on
1	CONVERSION_FAILED	☐	Bei der Konvertierung ist ein Fehler aufgetreten	20040510

Method ENCODE_X_BASE64 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ENCODED	Value transfer	☐	Type reference (TYPE)	STRING		BASE64-kodierter XString	20070207
2	Importing	UNENCODED	Call by reference	☐	Type reference (TYPE)	XSTRING		Unkodierter XString	20070207

Method ENCODE_X_BASE64 on Interface IF_HTTP_UTILITY 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-kodierter String	20001122
2	Importing	KEEP_NUM_CHAR_REF	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED	Escaping von HTML numeric character references verhindern ?	20050405
3	Importing	UNESCAPED	Call by reference	☐	Type reference (TYPE)	STRING		Unkodierter String	20001122

Method ESCAPE_HTML on Interface IF_HTTP_UTILITY has no exception.

Method ESCAPE_JAVASCRIPT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ESCAPED	Value transfer	☐	Type reference (TYPE)	STRING			20050519
2	Importing	INSIDE_HTML	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20050614
3	Importing	UNESCAPED	Call by reference	☐	Type reference (TYPE)	STRING			20050519

Method ESCAPE_JAVASCRIPT on Interface IF_HTTP_UTILITY 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-kodierter String	20001122
2	Importing	OPTIONS	Call by reference	☑	Type reference (TYPE)	I		Reserve für zukünftige Erweiterungen	20050126
3	Importing	UNESCAPED	Call by reference	☐	Type reference (TYPE)	STRING		Unkodierter String	20001122

Method ESCAPE_URL on Interface IF_HTTP_UTILITY has no exception.

Method ESCAPE_WML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ESCAPED	Value transfer	☐	Type reference (TYPE)	STRING		WML-kodierter String	20011012
2	Importing	UNESCAPED	Call by reference	☐	Type reference (TYPE)	STRING		Unkodierter String	20011012

Method ESCAPE_WML on Interface IF_HTTP_UTILITY has no exception.

Method ESCAPE_XML_ATTR_VALUE Signature

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

Method ESCAPE_XML_ATTR_VALUE on Interface IF_HTTP_UTILITY has no exception.

Method ESCAPE_XML_CHAR_DATA Signature

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

Method ESCAPE_XML_CHAR_DATA on Interface IF_HTTP_UTILITY has no exception.

Method FIELDS_TO_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENCODE	Call by reference	☐	Type reference (TYPE)	I	0	0: Ergebnis nicht base64 kodieren; 1: kodieren	20001222
2	Importing	ENCODE_NAME	Call by reference	☐	Type reference (TYPE)	I	0	0: Namen nicht kodieren; 1: Namen kodieren	20120302
3	Importing	FIELDS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		Tabelle mit Name/Wert-Paaren	20001222
4	Returning	STRING	Value transfer	☐	Type reference (TYPE)	STRING		queryString	20001222

Method FIELDS_TO_STRING on Interface IF_HTTP_UTILITY has no exception.

Method GET_LAST_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Letzter Fehlercode	20001122

Method GET_LAST_ERROR on Interface IF_HTTP_UTILITY has no exception.

Method GET_LOGON_CHARSET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ID	Call by reference	☐	Type reference (TYPE)	STRING			20031006

#	Exception	Resumable	Description	Created on
1	CHARSET_NOT_FOUND	☐	Kein passendes Charakterset gefunden	20031006

Method IS_ICT_SYSTEM_CALL_IMPLEMENTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		0 = Ja, 1 = Nein	20021219
2	Importing	SYSTEM_CALL_NUMBER	Call by reference	☐	Type reference (TYPE)	I		System-Call-Nummer	20021218

Method IS_ICT_SYSTEM_CALL_IMPLEMENTED on Interface IF_HTTP_UTILITY has no exception.

Method IS_VALID_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BLACK_PATTERN	Call by reference	☑	Object reference (TYPE REF TO)	CL_ABAP_REGEX		Negativ-Pattern in URL. Darf nicht vorkommen!	20050822
2	Returning	IS_OK	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		URL OK = ABAP_TRUE, URL not OK = ABAP_FALSE	20050204
3	Importing	OPTIONS	Call by reference	☐	Type reference (TYPE)	X	URLCHECK_DEFAULT	Optionen für die Prüfung	20080729
4	Importing	RESTRICTIVE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Restriktiverer Check	20050204
5	Importing	URL	Call by reference	☐	Type reference (TYPE)	STRING		URL String	20050204
6	Importing	WHITE_PATTERN	Call by reference	☑	Object reference (TYPE REF TO)	CL_ABAP_REGEX		Positiv-Pattern. Die URL muss diesem Muster entsprechen.	20050822

Method IS_VALID_URL on Interface IF_HTTP_UTILITY has no exception.

Method NORMALIZE_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NORMALIZED	Value transfer	☐	Type reference (TYPE)	STRING			20050809
2	Importing	UNNORMALIZED	Call by reference	☐	Type reference (TYPE)	STRING			20050809

Method NORMALIZE_URL on Interface IF_HTTP_UTILITY has no exception.

Method REWRITE_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIELDS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Tabelle Name/Wert-Paare	20011027
2	Returning	REWRITE_URL	Value transfer	☐	Type reference (TYPE)	STRING		Aufbereitete URL	20011027
3	Importing	URL	Call by reference	☐	Type reference (TYPE)	STRING		Original URL	20011027

Method REWRITE_URL on Interface IF_HTTP_UTILITY has no exception.

Method SET_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	QUERY	Call by reference	☐	Type reference (TYPE)	STRING		Query-String (in Form von form_feld1=1&form_feld2=2)	20030129
2	Importing	REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP-Framework (iHTTP) HTTP-Request	20030129

Method SET_QUERY on Interface IF_HTTP_UTILITY has no exception.

Method SET_REQUEST_URI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20011107
2	Importing	URI	Call by reference	☐	Type reference (TYPE)	STRING		URI-String (in Form von /path?query-string)	20011107

Method SET_REQUEST_URI on Interface IF_HTTP_UTILITY has no exception.

Method STRING_TO_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENCODE	Call by reference	☐	Type reference (TYPE)	I	0	0: unkodiert, 1: kodiert	20001222
2	Returning	FIELDS	Value transfer	☐	Type reference (TYPE)	TIHTTPNVP		Tabelle mit Name/Wert-Paaren	20001222
3	Importing	IGNORE_PARENTHESIS	Value transfer	☐	Type reference (TYPE)	I	0	Klammern ignorieren	20110307
4	Importing	STRING	Call by reference	☐	Type reference (TYPE)	STRING		Kodierter queryString	20001222

Method STRING_TO_FIELDS on Interface IF_HTTP_UTILITY has no exception.

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		URL-kodierter String	20001122
2	Importing	OPTIONS	Call by reference	☑	Type reference (TYPE)	I		Reserve für zukünftige Erweiterungen	20050126
3	Returning	UNESCAPED	Value transfer	☐	Type reference (TYPE)	STRING		Dekodierter String	20001122

Method UNESCAPE_URL on Interface IF_HTTP_UTILITY has no exception.

History

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