SAP ABAP Class /IWFND/CL_SODATA_ROOT_HANDLER (OData Channel Root Handler - Lib 1.0)

Hierarchy

☛ SAP_GWFND (Software Component) SAP Gateway Foundation
   ⤷ OPU-FND-CCL (Application Component) IWF Consumer Connectivity Layer
     ⤷ /IWFND/COC_SDP_LIB_10 (Package) GW Framework - COC - SAP Data Protocol - Library 1.0

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	/IWCOR/CL_DS_HDLR_ROOT	OData root handler	20110830

Properties

Class	/IWFND/CL_SODATA_ROOT_HANDLER
Short Description	OData Channel Root Handler - Lib 1.0
Super Class	/IWCOR/CL_DS_HDLR_ROOT	OData root handler
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/IWFND/COC_SDP_LIB_10	GW Framework - COC - SAP Data Protocol - Library 1.0
Created	20110830	SAP
Last change	20141120
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	/IWFND/IF_SODATA_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
2	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class /IWFND/CL_SODATA_ROOT_HANDLER has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	/IWFND/CL_SODATA_PROCESSOR	☐	20120202	OData Channel Business Data Processor - Lib 1.0

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_OBJECT_SERVICE	Constant	Public	☐	Type reference (TYPE)	STRING	'~service'	Service	20120127
2	GC_SVC_EXTENSION_NONE	Constant	Public	☐	Type reference (TYPE)	STRING	SPACE	Service Extension	20120202
3	MC_AGENT	Constant	Private	☐	Type reference (TYPE)	/IWFND/SUP_IW_AGENT	'LIB 1.0 INT'	GW Agent or Component	20111115
4	MO_BATCH_HELPER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/IWFND/CL_MGW_BATCH_HELPER		OData Channel - Batch Administrator	20120130
5	MV_LOG_HANDLE	Instance attribute	Private	☐	Type reference (TYPE)	BALMSGHNDL		Application Log: Message handle	20110831
6	MV_OPENSEARCH_REGEX	Constant	Private	☐	Type reference (TYPE)	STRING	'^/([[:alnum:]].*)/OpenSearchDescription.xml$'	Opensearch regular expression	20120127
7	MV_RESET_DP	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20131128
8	MV_SOFTSTATE_MODE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20131128

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ERROR_RESOLUTION	Instance method	Private	Method	Add info for Error Resolution	20130628
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20110830
3	CONVERT_NAMESPACE	Instance method	Private	Method	Convert external namespace to namespace in ABAP format	20110830
4	FILL_ODATA_TRACE	Instance method	Private	Method	Fill OData Trace with SUTIL Performance Trace Data	20111122
5	FINALIZE_TRANSACTION_HANDLER	Instance method	Private	Method	Finalize Transaction Handler	20110830
6	GET_ERROR_RESOLUTION	Instance method	Private	Method	Set info for Error Resolution	20130701
7	GET_EXTERNAL_SERVICE_NAME	Instance method	Public	Method	Retrieves the service name for soft state handling	20131129
8	GET_ICF_TIMEOUT_FOR_SERVICE	Instance method	Public	Method	Retrives the actual ICF node for the requested service	20131129
9	GET_PAYLOAD_SIZE	Instance method	Private	Method	Get Response Size	20130725
10	GET_ROOT_HANDLER	Static method	Public	Method	Get a root handler instance - Factory method	20110830
11	HANDLE_ERROR_ATOM_AND_JSON	Instance method	Private	Method	Error handling including the Inner Error Section	20120613
12	HANDLE_WARNINGS	Instance method	Private	Method	OBSOLETE - Use the one in /IWFND/CL_SODATA_UTILS	20131014
13	INITIALIZE_TRANSACTION_MANAGER	Instance method	Private	Method	Initialize Transaction Handler	20110830
14	IS_RESET_DP_REQUIRED	Instance method	Public	Method		20131128
15	IS_SOFTSTATE_MODE	Instance method	Public	Method		20131128
16	NEGOTIATE_CONTENT_FORMAT	Instance method	Private	Method	OBSOLETE - Use the one in /IWFND/CL_SODATA_UTILS	20131015
17	SET_REQUEST_TYPE	Instance method	Private	Method	Sets the request type - only metadata requests	20120926
18	SET_RESET_DP_REQUIRED	Instance method	Public	Method		20131128
19	SET_SOFTSTATE_MODE	Instance method	Public	Method		20131128

Events

Class /IWFND/CL_SODATA_ROOT_HANDLER has no event.

Types

Class /IWFND/CL_SODATA_ROOT_HANDLER has no local type.

Method Signatures

Method ADD_ERROR_RESOLUTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_REST_RESPONSE		REST Response	20130701
2	Importing	IO_SUTIL_RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	/IWFND/CL_SUTIL_RUNTIME		Support Utilities: Runtime	20131114
3	Importing	IV_CONTENT_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20130701

Method ADD_ERROR_RESOLUTION on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SVC_FACTORY	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_DS_SVC_FACTORY			20110830

Method CONSTRUCTOR on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method CONVERT_NAMESPACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXTERNAL_NAMESPACE	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_NAMESPACE		Namespace	20110830
2	Returning	RV_NAMESPACE	Value transfer	☐	Type reference (TYPE)	/IWFND/MED_MDL_NAMESPACE		Namespace	20110830

Method CONVERT_NAMESPACE on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method FILL_ODATA_TRACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_DS_CNTXT		OData Context	20111122
2	Importing	IO_SUTIL_RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	/IWFND/CL_SUTIL_RUNTIME		Support Utilities: Runtime	20131114

Method FILL_ODATA_TRACE on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method FINALIZE_TRANSACTION_HANDLER Signature

Method FINALIZE_TRANSACTION_HANDLER on class /IWFND/CL_SODATA_ROOT_HANDLER has no parameter.
Method FINALIZE_TRANSACTION_HANDLER on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method GET_ERROR_RESOLUTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_INNERERROR	Call by reference	☐	Type reference (TYPE)	/IWFND/IF_SODATA_TYPES=>INNERERROR_S			20130701
2	Importing	IO_SUTIL_RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	/IWFND/CL_SUTIL_RUNTIME		Support Utilities: Runtime	20131114
3	Importing	IV_SAP_NOTE	Call by reference	☑	Type reference (TYPE)	/IWFND/MGW_SAP_NOTE_ID		SAP Note number	20131002

Method GET_ERROR_RESOLUTION on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method GET_EXTERNAL_SERVICE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_RESOURCE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Resource path	20131204
2	Exporting	EV_SERVICE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20131129
3	Exporting	EV_SERVICE_NAMESPACE	Call by reference	☐	Type reference (TYPE)	STRING			20131129
4	Exporting	EV_SERVICE_ROOT	Call by reference	☐	Type reference (TYPE)	STRING		Service root	20131204
5	Exporting	EV_SERVICE_SEGMENT_DATA	Call by reference	☐	Type reference (TYPE)	STRING		Service segment data	20131204
6	Importing	IO_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_REST_CONTEXT			20131129
7	Importing	IO_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_REST_REQUEST		Request	20131129

#	Exception	Resumable	Description	Created on
1	/IWCOR/CX_DS_ERROR	☐	OData error	20131129

Method GET_ICF_TIMEOUT_FOR_SERVICE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SERVICE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20131129
2	Importing	IV_SERVICE_NAMESPACE	Call by reference	☐	Type reference (TYPE)	STRING			20131129
3	Returning	RV_SERVICE_TIMEOUT	Value transfer	☐	Type reference (TYPE)	ICFTIME		Session Timeout	20131129

Method GET_ICF_TIMEOUT_FOR_SERVICE on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method GET_PAYLOAD_SIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SIZE	Value transfer	☐	Type reference (TYPE)	I			20130725

Method GET_PAYLOAD_SIZE on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method GET_ROOT_HANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SVC_FACTORY	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_DS_SVC_FACTORY			20110830
2	Returning	RO_ROOT_HANDLER	Value transfer	☐	Object reference (TYPE REF TO)	/IWFND/CL_SODATA_ROOT_HANDLER		OData root handler	20110830

Method GET_ROOT_HANDLER on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method HANDLE_ERROR_ATOM_AND_JSON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ERROR	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/CX_DS_ERROR		OData error	20120613
2	Importing	IO_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_REST_RESPONSE		REST Response	20120613
3	Importing	IO_SODATA_ERROR	Call by reference	☐	Object reference (TYPE REF TO)	/IWFND/CX_SODATA		OData error	20120613
4	Importing	IO_SUTIL_RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	/IWFND/CL_SUTIL_RUNTIME		Support Utilities: Runtime	20131114
5	Importing	IV_CONTENT_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20120613

Method HANDLE_ERROR_ATOM_AND_JSON on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method HANDLE_WARNINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_REST_RESPONSE		REST Response	20131014
2	Importing	IV_CONTENT_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20131015

Method HANDLE_WARNINGS on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method INITIALIZE_TRANSACTION_MANAGER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ALL_REQUEST_PARAMS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework Table - all request parameters	20130108
2	Importing	IV_BASE_URL	Call by reference	☐	Type reference (TYPE)	STRING		Base URL	20111205
3	Importing	IV_CONSUMER_TYPE	Call by reference	☐	Type reference (TYPE)	/IWFND/COR_CONSUMER_ID		Consumer Type Code ID - used for BADI /IWFND/BD_MGW_RUNTIME	20120228
4	Importing	IV_EXTERNAL_SERVICE_NAME	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_SERVICE_GRP_ID		External Service Document Name	20110830
5	Importing	IV_HOST_NAME	Call by reference	☐	Type reference (TYPE)	STRING		http (virtual) host name	20120906
6	Importing	IV_IS_MDC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		TRUE if service is run as Mulit Destination Composition	20111122
7	Importing	IV_REQUEST_ID	Call by reference	☐	Type reference (TYPE)	/IWFND/IFL_CONS_REQU_ID		SCL Framework: Consumer Request ID	20110830
8	Importing	IV_SERVICE_NAMESPACE	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_NAMESPACE		Namespace	20110830
9	Importing	IV_SERVICE_VERSION	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_VERSION	0001	Version of Meta Model Entity	20110830
10	Importing	IV_SYSTEM_ALIAS	Call by reference	☐	Type reference (TYPE)	/IWFND/DEFI_SYSTEM_ALIAS		SAP System Alias	20111125
11	Importing	IV_VERBOSE_METADATA	Call by reference	☐	Type reference (TYPE)	/IWFND/MGW_VERBOSE_METADATA		Verbose Metadata	20120913

#	Exception	Resumable	Description	Created on
1	/IWCOR/CX_DS_ERROR	☐	OData error	20121005

Method IS_RESET_DP_REQUIRED Signature

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

Method IS_RESET_DP_REQUIRED on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method IS_SOFTSTATE_MODE Signature

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

Method IS_SOFTSTATE_MODE on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method NEGOTIATE_CONTENT_FORMAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_REST_REQUEST		REST Request	20131015
2	Returning	RV_CONTENT_FORMAT	Value transfer	☐	Type reference (TYPE)	STRING			20131015

Method NEGOTIATE_CONTENT_FORMAT on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method SET_REQUEST_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	/IWCOR/IF_DS_CNTXT		OData Context	20120926

Method SET_REQUEST_TYPE on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method SET_RESET_DP_REQUIRED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RESET_DP	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20131128

Method SET_RESET_DP_REQUIRED on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

Method SET_SOFTSTATE_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SOFTSTATE_MODE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20131128

Method SET_SOFTSTATE_MODE on class /IWFND/CL_SODATA_ROOT_HANDLER has no exception.

History

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