SAP ABAP Class /UI5/CL_UI5_APP_HTTP_HANDLER (UI5 application HTTP request handler)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ CA-UI5-TOL (Application Component) SAP UI development toolkit for HTML5 - Design Time Tools
     ⤷ /UI5/UI5_INFRA_APP (Package) SAP UI5 Infrastructure for Applications

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_HTTP_EXTENSION	HTTP Framework (iHTTP) HTTP Request Handler	20120119

Properties

Class	/UI5/CL_UI5_APP_HTTP_HANDLER
Short Description	UI5 application HTTP request handler
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/UI5/UI5_INFRA_APP	SAP UI5 Infrastructure for Applications
Created	20120119	SAP
Last change	20141120
Shared Memory-enabled	☐
Fixed point arithmetic	☑
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	Abstract	Final	Description	Created on
1	IF_HTTP_EXTENSION	☐	☐	HTTP Framework (iHTTP) HTTP Request Handler	20120119

Friends

Class /UI5/CL_UI5_APP_HTTP_HANDLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_CLEAR_CACHE_REQUEST	Constant	Private	☐	Type reference (TYPE)	STRING	'CLEARCACHE'	Name of clear server cache request	20120119
2	GC_RESET_CACHEBUSTER	Constant	Private	☐	Type reference (TYPE)	STRING	'RESETCACHEBUSTER'	Name of request to clear cache buster info cache	20130108
3	GC_SAP_NAMESPACE	Constant	Private	☐	Type reference (TYPE)	STRING	'SAP'	SAP namespace	20120119
4	GO_UI5_REP_RT_API	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/UI5/IF_UI5_REP_RT		SAPUI5 Repository Runtime Interface	20120119
5	GV_APPLICATION	Instance attribute	Private	☐	Type reference (TYPE)	STRING		SAPUI5 application name	20120119
6	GV_ICF_NODE_EXIST	Instance attribute	Private	☐	Type reference (TYPE)	CHAR1		I: Inactive, A: Active, SPACE: Does Not Exist	20120329
7	GV_NAMESPACE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Namespace of UI5 application	20120119
8	GV_SERVER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20130626
9	GV_WEBCONTENT	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Name of WebContent folder	20120329

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACCEPT_INVALID_ETAG_FOR_REQ	Instance method	Private	Method	Checks if invalid etag can be accepted for request.	20130312
2	CACHE_CONTROL	Instance method	Private	Method	adds cache control data to response	20120119
3	CHECK_304_NOT_MODIFIED	Static method	Private	Method	Checks if status 304/"Not Modified" is to be returned	20120904
4	CHECK_ICF_NODE	Instance method	Private	Method	Checks the application ICF node	20120119
5	CLEAR_SERVER_CACHE	Instance method	Private	Method	clear server cache for SAPUI5 application	20120119
6	DETERMINE_CACHE_SETTINGS	Static method	Private	Method	Determines cache settings for current request	20120905
7	DET_RESOURCE_ROOT_TO_BE_SERVED	Instance method	Private	Method	Determines the resource root requested by a SAPUI5 HTTP req.	20140304
8	ESCAPE_HTML	Static method	Public	Method	escapes the html string	20120613
9	FIND_ETAG_IN_UI5_REP	Instance method	Private	Method	Find ETag of file in SAPUI5 repository	20120329
10	FIND_FILE_IN_UI5_REP	Instance method	Private	Method	Find file in SAPUI5 repository	20120119
11	GET_EXTERNAL_URL	Static method	Public	Method	Returns the execution URL on the server	20121122
12	HANDLE_BATCH_REQUEST	Instance method	Private	Method	Handle batch request	20130626
13	ICF_NODE_NOT_OK	Instance method	Private	Method	icf node does not exist or not active handler	20120119
14	IS_BATCH_REQUEST	Instance method	Private	Method	Identify batch request	20130626
15	IS_LANGUAGE_CODE_SUPPORTED	Instance method	Protected	Method	Check is language code is supported	20140429
16	LANGUAGE_CODE_NOT_SUPPORTED	Instance method	Private	Method	Language code not supported handler	20140429
17	NORMALIZE_LANGUAGE_CODE	Instance method	Private	Method	Normalize language code according to BCP 47 rules	20130318
18	NOT_FOUND	Instance method	Private	Method	file not found handler	20120119
19	PARSE_META_TAGS	Instance method	Private	Method	Parse meta tags in resource content	20131107
20	RESET_CACHEBUSTER	Instance method	Private	Method	Reset cache buster for SAPUI5 application	20130108

Events

Class /UI5/CL_UI5_APP_HTTP_HANDLER has no event.

Types

Class /UI5/CL_UI5_APP_HTTP_HANDLER has no local type.

Method Signatures

Method ACCEPT_INVALID_ETAG_FOR_REQ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ACCEPT_INVALID_ETAG	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20130312
2	Importing	IV_RESOURCE_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20130312

Method ACCEPT_INVALID_ETAG_FOR_REQ on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method CACHE_CONTROL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SERVER	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Server	20120119
2	Importing	IV_ETAG	Call by reference	☑	Type reference (TYPE)	CHAR32		Etag for server cache	20120119
3	Importing	IV_LAST_CHANGED	Call by reference	☐	Type reference (TYPE)	SDOK_CHTST		last changed	20120119
4	Importing	IV_USE_304_ETAG_HANDLING	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		Indicator standard 304/ETag handling to be considered	20120904
5	Importing	IV_USE_BROWSER_CACHE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		Indicator to use browser cache or not	20120831
6	Importing	IV_USE_ICM_CACHE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		Indicator to also use the ICM cache when caching is used	20120330

Method CACHE_CONTROL on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method CHECK_304_NOT_MODIFIED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ETAG	Call by reference	☐	Type reference (TYPE)	CHAR32		Character field, length 32	20120904
2	Importing	IV_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20120904
3	Returning	RV_SET_304_NOT_MODIFIED	Value transfer	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20120904

Method CHECK_304_NOT_MODIFIED on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method CHECK_ICF_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ICF_NODE	Call by reference	☐	Type reference (TYPE)	STRING		ICF node	20120119
2	Exporting	EV_ICF_NODE_EXIST	Call by reference	☐	Type reference (TYPE)	CHAR1		I: Inactive, A: Active, SPACE: Does Not Exist	20120119
3	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	STRING		name of SAPUI5 application	20120119
4	Importing	IV_NAMESPACE	Call by reference	☐	Type reference (TYPE)	STRING		namespace of SAPUI5 application	20120119
5	Importing	IV_PATH	Call by reference	☐	Type reference (TYPE)	STRING		ICF path	20120119

Method CHECK_ICF_NODE on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method CLEAR_SERVER_CACHE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONTENT	Call by reference	☐	Type reference (TYPE)	STRING		Inhalt	20120119
2	Exporting	EV_CONTENT_LAST_CHANGED	Call by reference	☐	Type reference (TYPE)	SDOK_CHTST		last changed	20120119
3	Exporting	EV_MIME_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		MIME type	20120119
4	Importing	IO_SERVER	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Server	20120119

Method CLEAR_SERVER_CACHE on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method DETERMINE_CACHE_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_STANDARD_304_ETAG_HANDLING	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		standard 304/not modified handling to be used	20120905
2	Exporting	EV_USE_BROWSER_CACHE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		browser cache to be used	20120905
3	Exporting	EV_USE_ICM_CACHE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		server cache to be used	20120905
4	Importing	IV_ETAG	Call by reference	☐	Type reference (TYPE)	CHAR32		Character field, length 32	20120905
5	Importing	IV_ETAG_REQUESTED	Call by reference	☐	Type reference (TYPE)	STRING		Character field, length 32	20120905
6	Importing	IV_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20120905

Method DETERMINE_CACHE_SETTINGS on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method DET_RESOURCE_ROOT_TO_BE_SERVED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_REQUEST_FORM_FIELDS	Call by reference	☑	Type reference (TYPE)	TIHTTPNVP		for acceleration	20140304
2	Importing	IV_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP request	20140304
3	Returning	RV_RESOURCE_ROOT	Value transfer	☐	Type reference (TYPE)	STRING		Name of resource root requested	20140304

Method DET_RESOURCE_ROOT_TO_BE_SERVED on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method ESCAPE_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		unescaped string	20120613
2	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	STRING		escaped string	20120613

Method ESCAPE_HTML on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method FIND_ETAG_IN_UI5_REP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ETAG	Call by reference	☐	Type reference (TYPE)	CHAR32		Etag for server cache	20120329
2	Exporting	EV_NOT_FOUND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		not found indicator	20120329
3	Importing	IV_PATH	Call by reference	☐	Type reference (TYPE)	STRING		file path inside of a application	20120329
4	Importing	IV_RESOURCE_ROOT	Call by reference	☐	Type reference (TYPE)	STRING		Resource root to be served	20140304

Method FIND_ETAG_IN_UI5_REP on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method FIND_FILE_IN_UI5_REP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ETAG	Call by reference	☐	Type reference (TYPE)	CHAR32		Etag for server cache	20120119
2	Exporting	EV_FILE_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		file content	20120119
3	Exporting	EV_FILE_CONTENT_AS_STRING	Call by reference	☐	Type reference (TYPE)	STRING		file content as string	20131108
4	Exporting	EV_LAST_MODIFIED	Call by reference	☐	Type reference (TYPE)	SDOK_CHTST		last changed	20120119
5	Exporting	EV_MIME_TYPE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		MIME type	20120119
6	Exporting	EV_NOT_FOUND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		not found indicator	20120119
7	Importing	IV_CODE_PAGE	Call by reference	☑	Type reference (TYPE)	STRING	'UTF-8'	code page	20120127
8	Importing	IV_LANGUAGE_REQUESTED	Call by reference	☐	Type reference (TYPE)	STRING		Language requested	20120829
9	Importing	IV_PATH	Call by reference	☐	Type reference (TYPE)	STRING		file path inside of a application	20120119
10	Importing	IV_RESOURCE_ROOT	Call by reference	☐	Type reference (TYPE)	STRING		Resource root to be served	20140304

Method FIND_FILE_IN_UI5_REP on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method GET_EXTERNAL_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_API	Call by reference	☐	Object reference (TYPE REF TO)	/UI5/IF_UI5_REP		Base interface for SAPUI5 Repository	20121122
2	Importing	IV_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20121122
3	Returning	RV_URL	Value transfer	☐	Type reference (TYPE)	STRING			20121122

Method GET_EXTERNAL_URL on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method HANDLE_BATCH_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_ETAG	Call by reference	☐	Type reference (TYPE)	STRING		ETag	20130626
2	Changing	CV_FILE_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		File content as XSTRING	20130626
3	Changing	CV_LAST_MODIFIED	Call by reference	☐	Type reference (TYPE)	TIMESTAMP		last modified	20130626
4	Changing	CV_MIME_TYPE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		mime type	20130626
5	Importing	IV_CODE_PAGE	Call by reference	☐	Type reference (TYPE)	STRING	'UTF-8'	code page	20130626
6	Importing	IV_LANGUAGES_REQUESTED	Call by reference	☐	Type reference (TYPE)	STRING	'EN'	Languages requested, comma separated	20130626
7	Importing	IV_RESOURCE_ROOT	Call by reference	☐	Type reference (TYPE)	STRING		Resource root requested	20140306

Method HANDLE_BATCH_REQUEST on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method ICF_NODE_NOT_OK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONTENT	Call by reference	☐	Type reference (TYPE)	STRING		Inhalt	20120119
2	Exporting	EV_MIME_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		MIME type	20120119
3	Importing	IV_ICF_NODE	Call by reference	☐	Type reference (TYPE)	STRING		icf node	20120119
4	Importing	IV_ICF_NODE_EXIST	Call by reference	☐	Type reference (TYPE)	CHAR1		I: Inactive, A: Active, SPACE: Does Not Exist	20120119

Method ICF_NODE_NOT_OK on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method IS_BATCH_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_IS_BATCH_REQUEST	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20130626

Method IS_BATCH_REQUEST on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method IS_LANGUAGE_CODE_SUPPORTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING		Language code	20140429
2	Returning	RV_IS_VALID	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Langauge code is valid	20140429

Method IS_LANGUAGE_CODE_SUPPORTED on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method LANGUAGE_CODE_NOT_SUPPORTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONTENT	Call by reference	☐	Type reference (TYPE)	STRING		Content	20140429
2	Exporting	EV_MIME_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		MIME type	20140429
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING		Language code	20140429

Method LANGUAGE_CODE_NOT_SUPPORTED on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method NORMALIZE_LANGUAGE_CODE Signature

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

Method NORMALIZE_LANGUAGE_CODE on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method NOT_FOUND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONTENT	Call by reference	☐	Type reference (TYPE)	STRING		Inhalt	20120119
2	Exporting	EV_MIME_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		MIME type	20120119
3	Importing	IV_URL	Call by reference	☐	Type reference (TYPE)	STRING		URL	20120119

Method NOT_FOUND on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method PARSE_META_TAGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_IS_IE_EDGE_REQUESTED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20131108
2	Exporting	EV_IS_NO_CACHE_REQUESTED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20131108
3	Importing	IV_FILE_CONTENT	Call by reference	☐	Type reference (TYPE)	STRING			20131108
4	Importing	IV_PATH_IN_APP	Call by reference	☐	Type reference (TYPE)	STRING			20131107

Method PARSE_META_TAGS on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

Method RESET_CACHEBUSTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONTENT	Call by reference	☐	Type reference (TYPE)	STRING		Inhalt	20130108
2	Exporting	EV_CONTENT_LAST_CHANGED	Call by reference	☐	Type reference (TYPE)	SDOK_CHTST		last changed	20130108
3	Exporting	EV_MIME_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		MIME type	20130108
4	Importing	IV_NAME_UI5_APPLICATION	Call by reference	☐	Type reference (TYPE)	STRING		Name of UI5 application	20130108

Method RESET_CACHEBUSTER on class /UI5/CL_UI5_APP_HTTP_HANDLER has no exception.

History

Last changed by/on	SAP	20141120
SAP Release Created in	100