SAP ABAP Class CL_CLB2_DISPATCHER (SAIL: IC Dispatcher class)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ CA-UI2-AR-SM (Application Component) SAP UI Integration - Social Media Collaboration Enablement
     ⤷ CLB2_PROCESS (Package) Process Layer of the Collaboration Platform Library

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BADI_CONTEXT	Interface, a BAdI Context has to Implement	20140304
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CLB2_DISPATCHER	SAIL: Interception Dispatcher	20130516

Properties

Class	CL_CLB2_DISPATCHER
Short Description	SAIL: IC Dispatcher class
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	CLB2_PROCESS	Process Layer of the Collaboration Platform Library
Created	20130516	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)
2	IF_CLB2_CONFIGURATION	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BADI_CONTEXT	☐	☐	Interface, a BAdI Context has to Implement	20140304
2	IF_CLB2_DISPATCHER	☐	☐	SAIL: Interception Dispatcher	20130516

Friends

Class CL_CLB2_DISPATCHER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_AUTH_INTERFACE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_CLB2_AUTHENTICATE		Authentication (Instance of BAdI CLB_AUTHENTICATE)	20130626
2	MO_CONNECTOR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_CLB2_HTTP_CONNECTOR		HTTP Connector	20130516
3	MO_METHOD	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_CLB2_METHOD_PROCESS		Process Class Method	20130516
4	MS_APPL_KEY	Instance attribute	Protected	☐	Type reference (TYPE)	CLB2_S_APPL_KEY		Application Key	20130516
5	MS_APP_CONFIG	Instance attribute	Protected	☐	Type reference (TYPE)	IF_CLB2_CONFIGURATION=>TY_APPLICATION_CONFIG		Application-Specific Configuration	20130516
6	MS_CONNECTION_DATA	Instance attribute	Protected	☐	Type reference (TYPE)	IF_CLB2_METHOD_PROCESS=>TS_CONNECTION_DATA		Connection Data from Process Method Class	20130708
7	MV_AUTH_COUNTER	Instance attribute	Private	☐	Type reference (TYPE)	I			20140429
8	MV_AUTH_METHOD	Instance attribute	Protected	☐	Type reference (TYPE)	CLB2_AUTH_METHOD		Collaboration: Authentication Method	20130529
9	MV_METHOD_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	CLB2_PLATFORM_METHOD		Method Name	20130516
10	MV_NO_XML_CHECK	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20130617
11	MV_USER_ID	Instance attribute	Protected	☐	Type reference (TYPE)	STRING		External User ID (for instance: email)	20130703

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	AFTER_CALL	Instance method	Protected	Method	Additional tasks which might be necessary after the call	20130516
2	AUTHENTICATE	Instance method	Protected	Method	Perform the Authentication	20130516
3	BEFORE_CALL	Instance method	Protected	Method	Last Chance to perform Preparation Tasks	20130516
4	GET_AUTH_INTERFACE	Instance method	Protected	Method	Get Authentication Interface	20130626
5	LOG_ENTRY_PREPARE	Instance method	Private	Method	Fill the Result Structure for the Logpoint Entry	20130617
6	LOG_ENTRY_WRITE	Instance method	Private	Method	Write the Logpoint Entry	20130617
7	PREPARE_CALL	Instance method	Protected	Method	Fill the necessary Data into the Facade	20130516
8	PREPARE_CONNECTION	Instance method	Protected	Method	Prepare the Connection Facade	20130516
9	RESULT_CHECK	Instance method	Private	Method	Check the Result Data for well formed XML	20130617
10	RESULT_HANDLE_RC_GE_300	Instance method	Private	Method	Handling of Return Codes greater or equal 300	20130617
11	SEND_REQUEST	Instance method	Protected	Method	Send the Request to the Target System	20130516
12	SET_RESULT	Instance method	Protected	Method	Set the Result Data into the Method if the Call succeeded	20130516
13	SYNCHRONIZE	Instance method	Protected	Method	Synchronize the Call Result from Target System to Method	20130516

Events

Class CL_CLB2_DISPATCHER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_LOG_ENTRY	Protected	See coding			20130617	BEGIN OF ty_log_entry, method_name type char30, rc TYPE char5, subkey TYPE char255, is_xml TYPE char8, check TYPE char8, error_msg type char255, result TYPE char255, END OF ty_log_entry
2	TY_SESSION	Protected	See coding		Session description	20130516	BEGIN OF ty_session, session_key TYPE string, session_id TYPE string, timestamp TYPE timestamp, user_id TYPE string, END OF ty_session

Method Signatures

Method AFTER_CALL Signature

Method AFTER_CALL on class CL_CLB2_DISPATCHER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_CLB2_TECHNICAL	☐	CLB2: Technical Error	20140430

Method AUTHENTICATE Signature

Method AUTHENTICATE on class CL_CLB2_DISPATCHER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_CLB2_AUTHENTICATE	☐		20130516
2	CX_CLB2_PROCESS	☐	SAIL: Base exception	20130516

Method BEFORE_CALL Signature

Method BEFORE_CALL on class CL_CLB2_DISPATCHER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_CLB2_PROCESS	☐		20130516

Method GET_AUTH_INTERFACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_AUTH_INTERFACE	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLB2_AUTHENTICATE		Interface for BAdI: CLB2_AUTHENTICATE	20130626

#	Exception	Resumable	Description	Created on
1	CX_CLB2_AUTHENTICATE	☐	Authentication Error	20130626
2	CX_CLB2_PROCESS	☐	SAIL: Process layer exception	20130626

Method LOG_ENTRY_PREPARE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_LOG_ENTRY	Value transfer	☐	Type reference (TYPE)	TY_LOG_ENTRY			20130617
2	Importing	IV_METHOD_NAME	Call by reference	☐	Type reference (TYPE)	CLB2_PLATFORM_METHOD			20130617
3	Importing	IV_NO_XML_CHECK	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20130617
4	Importing	IV_RESULT	Call by reference	☐	Type reference (TYPE)	XSTRING			20130617
5	Importing	IV_RESULT_CODE	Call by reference	☐	Type reference (TYPE)	INT4			20130617

Method LOG_ENTRY_PREPARE on class CL_CLB2_DISPATCHER has no exception.

Method LOG_ENTRY_WRITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LOG_ENTRY	Call by reference	☐	Type reference (TYPE)	TY_LOG_ENTRY			20130617

Method LOG_ENTRY_WRITE on class CL_CLB2_DISPATCHER has no exception.

Method PREPARE_CALL Signature

Method PREPARE_CALL on class CL_CLB2_DISPATCHER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_CLB2_PROCESS	☐	SAIL: Process layer exception	20130516

Method PREPARE_CONNECTION Signature

Method PREPARE_CONNECTION on class CL_CLB2_DISPATCHER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_CLB2_PROCESS	☐	SAIL: Process layer exception	20130516

Method RESULT_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RESULT	Call by reference	☐	Type reference (TYPE)	XSTRING			20130617
2	Importing	IV_RESULT_CODE	Call by reference	☐	Type reference (TYPE)	INT4			20130617

#	Exception	Resumable	Description	Created on
1	CX_CLB2_PROCESS	☐		20130617

Method RESULT_HANDLE_RC_GE_300 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_NO_XML_CHECK	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20130617
2	Importing	IV_RESULT_CODE	Call by reference	☐	Type reference (TYPE)	INT4			20130617

Method RESULT_HANDLE_RC_GE_300 on class CL_CLB2_DISPATCHER has no exception.

Method SEND_REQUEST Signature

Method SEND_REQUEST on class CL_CLB2_DISPATCHER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_CLB2_PROCESS	☐	SAIL: Process layer exception	20130516

Method SET_RESULT Signature

Method SET_RESULT on class CL_CLB2_DISPATCHER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_CLB2_PROCESS	☐		20130516

Method SYNCHRONIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_RESPONSE_XDATA	Value transfer	☐	Type reference (TYPE)	XSTRING			20130516

#	Exception	Resumable	Description	Created on
1	CX_CLB2_PROCESS	☐	SAIL: Process layer exception	20130516

History

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