SAP ABAP Class CL_NWBC_HTML (NWBC - Handler for HTML Requests)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-FES-BUS (Application Component) Netweaver Business Client
     ⤷ SAP_NWBC (Package) NetWeaver Business Client

Properties

Class	CL_NWBC_HTML
Short Description	NWBC - Handler for HTML Requests
Super Class
Instantiability of a Class	0	Private
Final	☐

General Data

Message Class
Program status
Category	0
Package	SAP_NWBC	NetWeaver Business Client
Created	20090126	SAP
Last change	20130531	SAP
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)
2	CL_ABAP_CHAR_UTILITIES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_NWBC_HTML	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
4	IF_NWBC_FILE_REPOSITORY_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
5	IF_NWBC_RUNTIME	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_NWBC_HTML has no interface implemented.

Friends

Class CL_NWBC_HTML has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CACHED_NWBC_HTML	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_NWBC_HTML			20100901
2	CONTENT_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20101012
3	CRLF	Constant	Private	☐	Type reference (TYPE)	STRING	CL_ABAP_CHAR_UTILITIES=>CR_LF		20090127
4	GC_S_RESPONSE_TYPE	Constant	Private	☐	See coding				20101012
5	IS_FOOTPRINT	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20101012
6	IS_SERVICE_MAP	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20101012
7	MESSAGE_ERROR	Constant	Private	☐	Type reference (TYPE)	STRING	'error'		20101012
8	MESSAGE_SUCCESS	Constant	Private	☐	Type reference (TYPE)	STRING	'success'		20101012
9	MV_THEME_HTML_ESCAPED	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20111122
10	RUNTIME	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_NWBC_RUNTIME			20101012
11	TARGET_CANVAS_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20101012
12	TARGET_CANVAS_URL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20101012
13	TARGET_CANVAS_WINDOW	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20101012
14	TARGET_CLIENT_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20101012
15	TARGET_REQUEST_URI	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20101012
16	URL_KEY	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20101012
17	URL_KEY_EPCM	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20101012
18	URL_KEY_GENERAL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20101012
19	USER_AGENT_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	I			20101012
20	USER_INFO	Instance attribute	Private	☐	Type reference (TYPE)	IF_NWBC_RUNTIME=>T_USER_INFO			20101012

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	APPEND_ESID	Instance method	Private	Method		20090226
2	APPEND_TIMESTAMP	Instance method	Private	Method		20090312
3	CORRECT_SAP_URL	Instance method	Private	Method		20090529
4	CREATE_LAUNCHPAD_FOR_NODE	Instance method	Private	Method		20090402
5	CREATE_SAPGUI_URL	Instance method	Private	Method		20091001
6	CREATE_SERVICE_MAP_FOR_NODE	Instance method	Private	Method		20090327
7	GET	Static method	Public	Method	OBSOLETE - To be deleted at the End of this SP	20090126
8	GET_BACK_BUTTON	Instance method	Private	Method		20100217
9	GET_BREAD_CRUMB_HTML	Instance method	Private	Method		20100217
10	GET_EPCM_HTML_HEADER	Instance method	Private	Method		20090226
11	GET_ESID	Instance method	Private	Method		20090226
12	GET_HTML_4_APPLICATION_WINDOW	Instance method	Private	Method		20091112
13	GET_TERMINATOR_URL	Instance method	Private	Method		20100217
14	GET_TIMESTAMP	Instance method	Private	Method		20090312
15	HANDLE_REQUEST	Instance method	Public	Method		20101012
16	LOAD_MIMES	Instance method	Private	Method	OBSOLETE - To be deleted at the End of this SP	20090303
17	LOAD_MIMES_EPCM	Instance method	Private	Method	OBSOLETE - To be deleted at the End of this SP	20091204
18	LOAD_MIMES_GENERAL	Instance method	Private	Method		20100625
19	LOAD_MIMES_HCB	Instance method	Private	Method	OBSOLETE - To be deleted at the End of this SP	20091026
20	LOAD_MIMES_RTL	Instance method	Private	Method	OBSOLETE - To be deleted at the End of this SP	20090609
21	LOAD_MIMES_RTL_HCB	Instance method	Private	Method	OBSOLETE - To be deleted at the End of this SP	20091026
22	LOAD_SAPGUI_MIME	Instance method	Private	Method		20091001
23	RENDER_ERROR_MESSAGE	Instance method	Private	Method		20090504
24	RENDER_HTML	Instance method	Private	Method	Render HTML	20090128
25	RENDER_JSON	Instance method	Private	Method	OBSOLETE - To be deleted at the End of this SP	20100609

Events

Class CL_NWBC_HTML has no event.

Types

Class CL_NWBC_HTML has no local type.

Method Signatures

Method APPEND_ESID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ESID	Call by reference	☐	Type reference (TYPE)	STRING			20101012
2	Returning	ESID_URL	Value transfer	☐	Type reference (TYPE)	STRING			20101012
3	Importing	REPORT_TYPE	Call by reference	☑	Type reference (TYPE)	STRING			20101012
4	Importing	URL	Value transfer	☐	Type reference (TYPE)	STRING			20101012

Method APPEND_ESID on class CL_NWBC_HTML has no exception.

Method APPEND_TIMESTAMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REPORT_TYPE	Call by reference	☑	Type reference (TYPE)	STRING			20101012
2	Importing	TIMESTAMP	Value transfer	☐	Type reference (TYPE)	STRING			20101012
3	Returning	TIMESTAMP_URL	Value transfer	☐	Type reference (TYPE)	STRING			20101012
4	Importing	URL	Value transfer	☐	Type reference (TYPE)	STRING			20101012

Method APPEND_TIMESTAMP on class CL_NWBC_HTML has no exception.

Method CORRECT_SAP_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CORRECTED_URL	Value transfer	☐	Type reference (TYPE)	STRING			20101012
2	Importing	REPORT_TYPE	Call by reference	☑	Type reference (TYPE)	STRING			20101012
3	Importing	URL	Call by reference	☐	Type reference (TYPE)	STRING			20101012

Method CORRECT_SAP_URL on class CL_NWBC_HTML has no exception.

Method CREATE_LAUNCHPAD_FOR_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LINK_COLLECTION_MODE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20101012
2	Importing	LEVEL	Value transfer	☑	Type reference (TYPE)	INT4			20101012
3	Importing	NODES	Call by reference	☐	Type reference (TYPE)	IF_NWBC_RUNTIME=>T_NAVIGATION_TREE			20101012
4	Importing	OBJECT_ID	Call by reference	☐	Type reference (TYPE)	STRING			20101012
5	Importing	RENDER_EMPTY_LIST	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20101012
6	Importing	SELECTED	Call by reference	☑	Type reference (TYPE)	IF_NWBC_RUNTIME=>T_NAVIGATION_ENTRY			20101012
7	Returning	STR	Value transfer	☐	Type reference (TYPE)	STRING			20101012

Method CREATE_LAUNCHPAD_FOR_NODE on class CL_NWBC_HTML has no exception.

Method CREATE_SAPGUI_URL Signature

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

Method CREATE_SAPGUI_URL on class CL_NWBC_HTML has no exception.

Method CREATE_SERVICE_MAP_FOR_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LINK_COLLECTION_MODE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20101012
2	Importing	LEVEL	Value transfer	☑	Type reference (TYPE)	INT4			20101012
3	Importing	NODES	Call by reference	☐	Type reference (TYPE)	IF_NWBC_RUNTIME=>T_NAVIGATION_TREE			20101012
4	Importing	OBJECT_ID	Call by reference	☐	Type reference (TYPE)	STRING			20101012
5	Returning	STR	Value transfer	☐	Type reference (TYPE)	STRING			20101012

Method CREATE_SERVICE_MAP_FOR_NODE on class CL_NWBC_HTML has no exception.

Method GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NWBC_HTML	Value transfer	☐	Object reference (TYPE REF TO)	CL_NWBC_HTML		NW Business Client HTML Shell	20090126
2	Importing	RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	IF_NWBC_RUNTIME		The NWBC Runtime Interface	20090321

Method GET on class CL_NWBC_HTML has no exception.

Method GET_BACK_BUTTON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HISTORY	Call by reference	☐	Type reference (TYPE)	STRING			20101012
2	Importing	HTML	Call by reference	☐	Type reference (TYPE)	STRING			20101012
3	Returning	RETURN_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20101012

Method GET_BACK_BUTTON on class CL_NWBC_HTML has no exception.

Method GET_BREAD_CRUMB_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HISTORY	Call by reference	☐	Type reference (TYPE)	STRING			20101012
2	Returning	HTML	Value transfer	☐	Type reference (TYPE)	STRING			20101012
3	Importing	ID	Call by reference	☐	Type reference (TYPE)	STRING			20101012
4	Importing	ISHASHURL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20101012
5	Importing	NODES	Call by reference	☐	Type reference (TYPE)	IF_NWBC_RUNTIME=>T_NAVIGATION_TREE			20101012
6	Importing	TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20101012

Method GET_BREAD_CRUMB_HTML on class CL_NWBC_HTML has no exception.

Method GET_EPCM_HTML_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	HTML	Value transfer	☐	Type reference (TYPE)	STRING			20101012
2	Importing	REPORT_TYPE	Call by reference	☑	Type reference (TYPE)	STRING			20101012
3	Importing	URL	Value transfer	☐	Type reference (TYPE)	STRING			20101012

Method GET_EPCM_HTML_HEADER on class CL_NWBC_HTML has no exception.

Method GET_ESID Signature

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

Method GET_ESID on class CL_NWBC_HTML has no exception.

Method GET_HTML_4_APPLICATION_WINDOW 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			20101012
2	Returning	HTML	Value transfer	☐	Type reference (TYPE)	STRING			20101012
3	Importing	NWBC_HAS_POST_PARAMS	Call by reference	☐	Type reference (TYPE)	XFELD			20101012
4	Importing	NWBC_SOURCE_ROLE	Call by reference	☐	Type reference (TYPE)	STRING			20101012
5	Importing	REPORT_TYPE	Call by reference	☑	Type reference (TYPE)	STRING			20101012
6	Importing	TITLE	Call by reference	☑	Type reference (TYPE)	STRING			20101012
7	Importing	URL	Value transfer	☐	Type reference (TYPE)	STRING			20101012

Method GET_HTML_4_APPLICATION_WINDOW on class CL_NWBC_HTML has no exception.

Method GET_TERMINATOR_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_SUSPEND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20101012
2	Returning	TERMINATOR	Value transfer	☐	Type reference (TYPE)	STRING			20101012
3	Importing	URL	Call by reference	☐	Type reference (TYPE)	STRING			20101012

Method GET_TERMINATOR_URL on class CL_NWBC_HTML has no exception.

Method GET_TIMESTAMP Signature

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

Method GET_TIMESTAMP on class CL_NWBC_HTML has no exception.

Method HANDLE_REQUEST Signature

Method HANDLE_REQUEST on class CL_NWBC_HTML has no parameter.
Method HANDLE_REQUEST on class CL_NWBC_HTML has no exception.

Method LOAD_MIMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SERVER	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20090303
2	Returning	URL_KEY	Value transfer	☐	Type reference (TYPE)	STRING			20090303

Method LOAD_MIMES on class CL_NWBC_HTML has no exception.

Method LOAD_MIMES_EPCM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILE_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20091204
2	Importing	SERVER	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20091204
3	Returning	URL_KEY	Value transfer	☐	Type reference (TYPE)	STRING			20091204

Method LOAD_MIMES_EPCM on class CL_NWBC_HTML has no exception.

Method LOAD_MIMES_GENERAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILE_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20100625
2	Importing	SERVER	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_SERVER			20100625
3	Returning	URL_KEY	Value transfer	☐	Type reference (TYPE)	STRING			20100625

Method LOAD_MIMES_GENERAL on class CL_NWBC_HTML has no exception.

Method LOAD_MIMES_HCB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILE_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20091026
2	Importing	SERVER	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20091026
3	Returning	URL_KEY	Value transfer	☐	Type reference (TYPE)	STRING			20091026

Method LOAD_MIMES_HCB on class CL_NWBC_HTML has no exception.

Method LOAD_MIMES_RTL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILE_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20090609
2	Importing	SERVER	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20090609
3	Returning	URL_KEY	Value transfer	☐	Type reference (TYPE)	STRING			20090609

Method LOAD_MIMES_RTL on class CL_NWBC_HTML has no exception.

Method LOAD_MIMES_RTL_HCB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILE_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20091026
2	Importing	SERVER	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20091026
3	Returning	URL_KEY	Value transfer	☐	Type reference (TYPE)	STRING			20091026

Method LOAD_MIMES_RTL_HCB on class CL_NWBC_HTML has no exception.

Method LOAD_SAPGUI_MIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ERROR_MESSAGE	Value transfer	☐	Type reference (TYPE)	STRING			20101012
2	Importing	FIELDS	Call by reference	☑	Type reference (TYPE)	TIHTTPNVP			20091001
3	Importing	SERVER	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_SERVER			20091001

Method LOAD_SAPGUI_MIME on class CL_NWBC_HTML has no exception.

Method RENDER_ERROR_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	HTML	Value transfer	☐	Type reference (TYPE)	STRING			20101012
2	Importing	MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING	CL_NWBC_HTML=>MESSAGE_SUCCESS		20101012
3	Importing	STRLINK1	Call by reference	☑	Type reference (TYPE)	STRING			20101012
4	Importing	STRLINK2	Call by reference	☑	Type reference (TYPE)	STRING			20101012
5	Importing	STRTEXT1	Call by reference	☐	Type reference (TYPE)	STRING			20101012
6	Importing	STRTEXT2	Call by reference	☐	Type reference (TYPE)	STRING			20101012
7	Importing	STRTEXT3	Call by reference	☐	Type reference (TYPE)	STRING			20101012
8	Importing	STRTEXT4	Call by reference	☑	Type reference (TYPE)	STRING			20101012

Method RENDER_ERROR_MESSAGE on class CL_NWBC_HTML has no exception.

Method RENDER_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CACHE_CONTROL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20091204
2	Importing	HTML	Value transfer	☐	Type reference (TYPE)	STRING			20090128

Method RENDER_HTML on class CL_NWBC_HTML has no exception.

Method RENDER_JSON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	JSON	Value transfer	☐	Type reference (TYPE)	STRING			20100609

Method RENDER_JSON on class CL_NWBC_HTML has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	720