SAP ABAP Class CL_SOAP_EVENTING (handler for SOAP Event messages)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ESI-WS-ABA-RT (Application Component) WebServices ABAP Runtime
     ⤷ SOAP_EVENT (Package) Package for WS Eventing

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SOAP_EVENTING	event interface	20081204
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SOAP_TXH_COMMIT	Transaction Commit Handling	20090209

Properties

Class	CL_SOAP_EVENTING
Short Description	handler for SOAP Event messages
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SOAP_EVENT	Package for WS Eventing
Created	20081120	SAP
Last change	20140121	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)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SOAP_EVENTING	☐	☐	event interface	20081204
2	IF_SOAP_TXH_COMMIT	☐	☐	Transaction Commit Handling	20090209

Friends

#	Friend	Modeled only	Created on	Description
1	IF_WS_PROXY_RUNTIME_EVENT	☐	20081202	Call of Web Service Method

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_CHILD_EVENT_ERROR	Constant	Public	☐	Type reference (TYPE)	CHAR1	'E'	Single-Character Flag	20081126
2	CO_CHILD_EVENT_FINISHED	Constant	Public	☐	Type reference (TYPE)	CHAR1	'F'	Single-Character Flag	20081126
3	CO_CHILD_EVENT_INIT	Constant	Public	☐	Type reference (TYPE)	CHAR1	'I'	Single-Character Flag	20081126
4	CO_PERS_PAYLOAD_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'Payload'	name of payload	20081215
5	CO_PERS_PAYLOAD_NS	Constant	Public	☐	Type reference (TYPE)	STRING	'http://www.sap.com/webas/710/soap/runtime/eventing'	namespace of payload	20081215
6	CO_RETRY_COUNTER_MAX	Constant	Public	☐	Type reference (TYPE)	I	3	maximum retry counter	20090506
7	FRAMEWORK	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_PROXY_FRAMEWORK_WS		Proxy Framework for Web Service	20081125
8	GV_CONTEXT_CREATED	Instance attribute	Private	☐	Type reference (TYPE)	XSDBOOLEAN			20120730
9	G_CHILD_PART	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SXMLP_FRAGMENT		child part	20081215
10	G_REQUEST_PART	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SXMLP_PART		message part of parent event message	20081120
11	G_TXH_REG_NEEDED	Instance attribute	Private	☐	Type reference (TYPE)	BOOLEAN		is a new registration at the txh needed?	20090217
12	MO_EXEC_HANDLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SOAP_SEQ_EXEC_HANDLER_CO_EV		Web Service execution handler	20130715
13	MT_PERSISTS	Instance attribute	Private	☐	See coding				20120809
14	PROT_CONTEXT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_WS_SERVER_CONTEXT		Proxy Server Context	20081219

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALCULATE_QUEUE_NAME_FOR_XI_IO	Static method	Private	Method		20130701
2	CONSTRUCTOR	Instance method	Public	Constructor		20090209
3	CREATE_CHILD	Instance method	Private	Method	create child event message	20081120
4	CREATE_LOG_VERSION_CONTENT	Instance method	Private	Method	generate content for the log version	20081202
5	CREATE_PARENT_QUEUENAME	Static method	Public	Method	Create Queue name for parent queue	20130610
6	DETERMINE_OPERATION_NAME	Instance method	Private	Method		20120731
7	EXTRACT_ERROR_TEXT	Instance method	Private	Method	extract the error text out of a caught exception	20081202
8	EXT_STAT_ADD_SIZE	Instance method	Private	Method		20130704
9	EXT_STAT_END	Instance method	Private	Method		20130704
10	EXT_STAT_START	Instance method	Private	Method		20130704
11	FINALIZE	Instance method	Private	Method		20130715
12	GET_SUBSCRIPTION_LIST	Instance method	Private	Method	get the subscription list from the configuration	20081120
13	LOG_PARENT_FAILURE	Instance method	Private	Method		20130717
14	PROCESS_CHILD_MSGS	Instance method	Public	Method	split the parent event into the child mesages	20081120
15	PROCESS_PARENT_EVENT	Instance method	Private	Method	process parent event message	20081120
16	SAVE_SUBSCRIPTION_LIST	Instance method	Private	Method	persist the subscription ist	20081120

Events

Class CL_SOAP_EVENTING has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_PERSIST	Private	See coding			20120809	BEGIN OF ty_persist, persist_id TYPE srt_persistency_persist_id, runtime TYPE REF TO if_soap_persistency_runtime, END OF ty_persist

Method Signatures

Method CALCULATE_QUEUE_NAME_FOR_XI_IO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BASE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20130701
2	Returning	RV_QUEUE_NAME	Value transfer	☐	Type reference (TYPE)	SXMSQID		Queue Name for EOIO	20130701

Method CALCULATE_QUEUE_NAME_FOR_XI_IO on class CL_SOAP_EVENTING has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EXEC_HANDLER	Call by reference	☑	Object reference (TYPE REF TO)	IF_SOAP_SEQ_EXECUTION_HANDLER		Web Service execution handler	20130715

Method CONSTRUCTOR on class CL_SOAP_EVENTING has no exception.

Method CREATE_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LP	Call by reference	☐	Type reference (TYPE)	SRT_LP_NAME		Logical Port Name	20081120
2	Importing	I_OP	Call by reference	☐	Type reference (TYPE)	QNAME		Operation	20081126
3	Importing	I_PARENT_EVENT_MSG_ID	Call by reference	☐	Type reference (TYPE)	SXMSGUID		message ID of parent event message	20081210
4	Importing	I_PROXY	Call by reference	☐	Type reference (TYPE)	SRT_LP_PROXYCLASS		Proxy Class of Logical Port	20081126
5	Importing	I_SEQUENCE	Call by reference	☑	Object reference (TYPE REF TO)	IF_SOAP_SEQUENCE		SOAP sequence interface	20130702
6	Importing	I_XI	Call by reference	☐	Type reference (TYPE)	BOOLEAN		is the logical port XI based?	20081210
7	Returning	R_MSG_ID	Value transfer	☐	Type reference (TYPE)	SXMSGUID		message ID of processed child event	20081126

#	Exception	Resumable	Description	Created on
1	CX_SOAP_EVENTING	☐	exception class for Eventing	20081215

Method CREATE_LOG_VERSION_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SUB_LIST	Call by reference	☐	Type reference (TYPE)	TTAB_SRT_EVENTS			20081202
2	Returning	R_ERROR_XSTRING	Value transfer	☐	Type reference (TYPE)	XSTRING			20081202

Method CREATE_LOG_VERSION_CONTENT on class CL_SOAP_EVENTING has no exception.

Method CREATE_PARENT_QUEUENAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BGRFC_UNIT_ID	Value transfer	☑	Type reference (TYPE)	BGRFC_UNIT_ID		ID of Unit in Background RFC	20130610
2	Returning	QUEUE_NAME	Value transfer	☐	Type reference (TYPE)	QRFC_QUEUE_NAME		Queue Name for Background RFC	20130610

Method CREATE_PARENT_QUEUENAME on class CL_SOAP_EVENTING has no exception.

Method DETERMINE_OPERATION_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_EVENT_CHILD	Call by reference	☐	Type reference (TYPE)	SRT_EVENTS			20120731
2	Importing	IV_PERSIST_ID	Call by reference	☐	Type reference (TYPE)	SXMSGUID			20120731
3	Returning	RS_OP_QNAME	Value transfer	☐	Type reference (TYPE)	QNAME			20120731

#	Exception	Resumable	Description	Created on
1	CX_SOAP_EVENTING	☐		20120731

Method EXTRACT_ERROR_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass for All Global Exceptions	20081202
2	Returning	R_ERROR_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20081202

Method EXTRACT_ERROR_TEXT on class CL_SOAP_EVENTING has no exception.

Method EXT_STAT_ADD_SIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING			20130704
2	Importing	IV_MESSAGE_ID	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_ACCESS_ID-MESSAGE_ID			20130705

Method EXT_STAT_ADD_SIZE on class CL_SOAP_EVENTING has no exception.

Method EXT_STAT_END Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MESSAGE_ID	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_ACCESS_ID-MESSAGE_ID			20130705

Method EXT_STAT_END on class CL_SOAP_EVENTING has no exception.

Method EXT_STAT_START Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MESSAGE_ID	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_ACCESS_ID-MESSAGE_ID			20130705

Method EXT_STAT_START on class CL_SOAP_EVENTING has no exception.

Method FINALIZE Signature

Method FINALIZE on class CL_SOAP_EVENTING has no parameter.
Method FINALIZE on class CL_SOAP_EVENTING has no exception.

Method GET_SUBSCRIPTION_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FILTER	Call by reference	☑	Type reference (TYPE)	XSTRING			20081120
2	Importing	I_OP	Call by reference	☐	Type reference (TYPE)	QNAME		Qualified Name	20081120
3	Importing	I_PRX_NAME	Call by reference	☐	Type reference (TYPE)	SRT_LP_PROXYCLASS		Proxy Class of Logical Port	20081120
4	Returning	R_SUB_LIST	Value transfer	☐	Type reference (TYPE)	SRT_WSP_LP_XI_LIST		List of logical ports including indicator of XI relation	20081120

#	Exception	Resumable	Description	Created on
1	CX_SOAP_EVENTING	☐	exception class for Eventing	20081215

Method LOG_PARENT_FAILURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SOAP_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SOAP_CONTEXT		Interface of SOAP Runtime Context	20130717
2	Importing	IO_SOAP_SEQUENCE	Call by reference	☐	Object reference (TYPE REF TO)	IF_SOAP_SEQUENCE		SOAP sequence interface	20130717
3	Importing	IT_ERROR_CHILDREN	Call by reference	☐	Type reference (TYPE)	TTAB_SRT_EVENTS		table type of srt_events	20130717
4	Importing	IV_ERROR_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20130717

Method LOG_PARENT_FAILURE on class CL_SOAP_EVENTING has no exception.

Method PROCESS_CHILD_MSGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PERSIST_ID	Call by reference	☐	Type reference (TYPE)	SXMSGUID		GUID for Integration Engine Objects	20081126
2	Importing	I_QUEUE_NAME	Call by reference	☑	Type reference (TYPE)	QRFC_QUEUE_NAME		Queue Name for Background RFC	20090126
3	Importing	I_SEQUENCE	Call by reference	☑	Object reference (TYPE REF TO)	IF_SOAP_SEQUENCE		Soap Sequence	20130701

#	Exception	Resumable	Description	Created on
1	CX_SOAP_EVENTING	☐	exception class for Eventing	20090506

Method PROCESS_PARENT_EVENT Signature

Method PROCESS_PARENT_EVENT on class CL_SOAP_EVENTING has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SOAP_EVENTING	☐	exception class for Eventing	20081215

Method SAVE_SUBSCRIPTION_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MSGGUID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message ID	20081120
2	Importing	I_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	QNAME		Qualified Name	20081120
3	Importing	I_PAYLOAD	Call by reference	☑	Type reference (TYPE)	XSTRING			20081120
4	Importing	I_PROXY	Call by reference	☐	Type reference (TYPE)	SRT_LP_PROXYCLASS		Proxy Class of Logical Port	20081120
5	Returning	R_EVENT_CONSUMERS_EXIST	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20081120

#	Exception	Resumable	Description	Created on
1	CX_SOAP_EVENTING	☐	exception class for Eventing	20081215

History

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