SAP ABAP Class CL_SMI_CLB_HANDLER (SMI HTTP and CLB layer handler)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ CA-UI2-AR-SM (Application Component) SAP UI Integration - Social Media Collaboration Enablement
     ⤷ AR_702_SM_SERVICES (Package) UI AR - Social Media Data Provider Impl. (Rel. Dependent)

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SMI_BIZ_OBJ_HANDLER	SMI Business Object handler	20130603
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SMI_COLLAB_HOST_HANDLER	SMI Collaboration host handler	20130621
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SMI_CONFIGURATION_HANDLER	SMI System Configuration handler	20130621

Properties

Class	CL_SMI_CLB_HANDLER
Short Description	SMI HTTP and CLB layer handler
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	AR_702_SM_SERVICES	UI AR - Social Media Data Provider Impl. (Rel. Dependent)
Created	20130603	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_SMI_BIZ_OBJ_HANDLER	☐	☐	SMI Business Object handler	20130603
2	IF_SMI_COLLAB_HOST_HANDLER	☐	☐	SMI Collaboration host handler	20130621
3	IF_SMI_CONFIGURATION_HANDLER	☐	☐	SMI System Configuration handler	20130621

Friends

Class CL_SMI_CLB_HANDLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_COLLAB_PLATFORM_PROCESS	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_CLB2_PROCESS			20130603
2	MO_DB_ACCESS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_CLB2_BO_DB_ACCESS			20130603
3	MO_IXML	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_IXML			20130603
4	MO_IXML_STREAM_FACTORY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_IXML_STREAM_FACTORY			20130603
5	MV_APPLICATION_ID	Instance attribute	Private	☐	Type reference (TYPE)	CLB2_APPLICATION_ID			20130603
6	MV_COLLABORATION_HOST_URL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20130621
7	MV_ODATA_METADATA_NAMESPACE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20130603

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_RESPONSE_FOR_ERRORS	Instance method	Public	Method	Verify Jam response for errors and raise exception.	20130926
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20130603
3	CREATE_CLB_METHOD	Instance method	Public	Method	Creates an object representing a HTTP request.	20130603
4	GET_JAM_ERROR_MESSAGE	Instance method	Public	Method	Gets the error message from Jam response	20130603
5	GET_ODATA_METADATA_NAMESPACE	Instance method	Private	Method	Gets the metadata namespace from Jam response	20130603
6	XSTRING_XML_TO_IXML_DOCUMENT	Instance method	Private	Method	Converts XML in xstring representation to a DOM object.	20130603

Events

Class CL_SMI_CLB_HANDLER has no event.

Types

Class CL_SMI_CLB_HANDLER has no local type.

Method Signatures

Method CHECK_RESPONSE_FOR_ERRORS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CLB_METHOD	Call by reference	☐	Object reference (TYPE REF TO)	CL_CLB2_METHOD		Object containing the HTTP response code and payload.	20130926

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐		20130926

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_SMI_CLB_HANDLER has no parameter.

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_TECH_EXCEPTION	☐	Technical Exception	20130603

Method CREATE_CLB_METHOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_HEADERS	Call by reference	☐	Type reference (TYPE)	/IWBEP/T_MGW_NAME_VALUE_PAIR		Table for HTTP headers.	20131101
2	Importing	IV_AUTHENTICATION_CONTEXT	Call by reference	☐	Type reference (TYPE)	CLB2_AUTH_CONTEXT		Type of authentication.	20130619
3	Importing	IV_CHECK_XML	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	If the CLB layer checks the XML of the response.	20130621
4	Importing	IV_HTTP_METHOD	Call by reference	☐	Type reference (TYPE)	STRING		HTTP Method such as GET, POST, PUT, DELETE, etc.	20130619
5	Importing	IV_PAYLOAD	Call by reference	☐	Type reference (TYPE)	STRING	''	XML payload of HTTP request.	20131101
6	Importing	IV_SAP_JAM_ENDPOINT	Call by reference	☐	Type reference (TYPE)	STRING		URL of request's destination.	20130619
7	Importing	IV_XPAYLOAD	Call by reference	☑	Type reference (TYPE)	XSTRING			20131122
8	Returning	RO_CLB_METHOD	Value transfer	☐	Object reference (TYPE REF TO)	CL_CLB2_METHOD		Object representation of HTTP request.	20130603

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐		20130603
2	/IWBEP/CX_MGW_TECH_EXCEPTION	☐		20130603

Method GET_JAM_ERROR_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ERROR_XML_DOM	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		DOM containing a Jam error.	20130603
2	Returning	RV_ERROR_MESSAGE	Value transfer	☐	Type reference (TYPE)	STRING		The error message extracted from the input DOM	20130603

Method GET_JAM_ERROR_MESSAGE on class CL_SMI_CLB_HANDLER has no exception.

Method GET_ODATA_METADATA_NAMESPACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_IXML_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		DOM containing the OData metadata namespace URL.	20130603
2	Returning	RV_ODATA_METADATA_NAMESPACE	Value transfer	☐	Type reference (TYPE)	STRING		OData metadata namesapce URL extracted from the input DOM.	20130603

Method GET_ODATA_METADATA_NAMESPACE on class CL_SMI_CLB_HANDLER has no exception.

Method XSTRING_XML_TO_IXML_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_IXML_DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		DOM representaion of input XML.	20130926
2	Exporting	EV_ERROR_MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING		Returns a non empty error when an error occurs.	20130926
3	Importing	IV_XSTRING	Call by reference	☐	Type reference (TYPE)	XSTRING		Xstring representation of HTTP response's XML payload.	20130603

Method XSTRING_XML_TO_IXML_DOCUMENT on class CL_SMI_CLB_HANDLER has no exception.

History

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