SAP ABAP Class CL_SWF_XI_MSG_BROKER (XI Broker for Messages)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-XI-IS-BPE (Application Component) Business Process Engine
     ⤷ SWF_XI_ADAPTER (Package) Workflow Adapter for XI

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	BI_OBJECT	Business Instance	20030721
2	Interface implementation (CLASS c. INTERFACES i_ref)	BI_PERSISTENT	Persistent Business Instance	20030721
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_WORKFLOW	Business Workflow	20030721

Properties

Class	CL_SWF_XI_MSG_BROKER
Short Description	XI Broker for Messages
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SWF_XI_ADAPTER	Workflow Adapter for XI
Created	20030721	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_SWF_XI_MSG_BROKER has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	BI_OBJECT	☐	☐	Business Instance	20030721
2	BI_PERSISTENT	☐	☐	Persistent Business Instance	20030721
3	IF_WORKFLOW	☐	☐	Business Workflow	20030721

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SWF_XI_PROCESS_EXIT	☐	20031024	XI: Process Exits (Constructor/Deconstructor)

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_TYPE_INTEGER	Constant	Private	☐	Type reference (TYPE)	STRING	'SWFXST_INTEGER'		20070903
2	CO_TYPE_STRING	Constant	Private	☐	Type reference (TYPE)	STRING	'SWFXST_STRING'		20070903
3	MC_ACKTYPE_ACK	Constant	Public	☐	Type reference (TYPE)	SWFDXISACKTYP	'A'		20031006
4	MC_ACKTYPE_NACK	Constant	Public	☐	Type reference (TYPE)	SWFDXISACKTYP	'N'		20031006
5	MC_LOG_FUNC_SENT_SYNC	Constant	Public	☐	Type reference (TYPE)	FUNCNAME	'SWF_XI_MESSAGE_SENT_SYNC'	Function name	20060118
6	MC_RECEIVER_TYPE_CONTEXT	Constant	Private	☐	Type reference (TYPE)	SWFDXISRECTYP	'CTX'		20030829
7	MC_RECEIVER_TYPE_RECEIVERS	Constant	Private	☐	Type reference (TYPE)	SWFDXISRECTYP	'REC'		20030829
8	MC_RECEIVER_TYPE_REPLY_TO	Constant	Private	☐	Type reference (TYPE)	SWFDXISRECTYP	'RTM'		20030829
9	MC_SENDCONTEXT_NAME	Constant	Private	☐	Type reference (TYPE)	STRING	'ProcessStep'		20030930
10	MC_SENDCONTEXT_NAMESPACE	Constant	Private	☐	Type reference (TYPE)	STRING	'http://sap.com/xi/XI/System'		20030930
11	MC_SEND_ACK_APPLICATION	Constant	Private	☐	Type reference (TYPE)	SWFDXISDAK	'APPL'		20030721
12	MC_SEND_ACK_TRANSPORT	Constant	Private	☐	Type reference (TYPE)	SWFDXISDAK	'TRANS'		20030721

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALL_ROUTING	Static method	Public	Method		20030721
2	CALL_TRANSFORMATION	Static method	Public	Method		20030721
3	GET_MESSAGE_XMB	Static method	Private	Method		20030923
4	GET_TOPFLOW	Static method	Private	Method		20070622
5	SEND_ACK	Static method	Public	Method		20030721
6	SEND_ACK_INTERN	Static method	Protected	Method		20031024
7	SEND_ASYNCHRON	Static method	Public	Method		20030721
8	SEND_PREPARE_RECEIVERS	Static method	Private	Method		20030829
9	SEND_SYNCHRON	Static method	Public	Method		20030721
10	SEND_SYNCHRON_REPLY	Static method	Public	Method		20040507
11	SET_PROCESS_CONTEXT	Static method	Private	Method		20030930
12	WRITE_LOG	Static method	Private	Method	Write Log Entry	20060118

Events

#	Event	Type	Visibility	Description	Created on
1	RECEIVED	Instance Event (0)	Public (2)	Received	20030721
2	SEND_OK_APPLICATION	Instance Event (0)	Public (2)	Sent: Application	20030721
3	SEND_OK_TRANSPORT	Instance Event (0)	Public (2)	Sent: Receiver System	20030721

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_OBJECT_BUFFER	Protected	See coding			20030721	begin of t_object_buffer, lpor type sibflpor, instance type ref to cl_swf_xi_instance, object type ref to cl_swf_xi_message, end of t_object_buffer

Method Signatures

Method CALL_ROUTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MESSAGE	Call by reference	☐	Type reference (TYPE)	SIBFLPORB			20030721
2	Exporting	RECEIVERS	Call by reference	☐	Type reference (TYPE)	SXI_ADDRESSES			20030721
3	Importing	SEND_CONTEXT	Call by reference	☐	Type reference (TYPE)	STRING			20030721

Method CALL_ROUTING on class CL_SWF_XI_MSG_BROKER has no exception.

Method CALL_TRANSFORMATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ADAPTERS_IN	Call by reference	☑	Type reference (TYPE)	SWFXICHANNELMAPPART			20070823
2	Importing	FLOWITEM	Call by reference	☐	Type reference (TYPE)	SIBFLPORB			20030820
3	Importing	MAPPING	Call by reference	☐	Type reference (TYPE)	MP3_MERGE_SPLIT_MAPPING			20030820
4	Importing	MESSAGES_IN	Call by reference	☐	Type reference (TYPE)	SWFXIMAPPART			20030721
5	Exporting	MESSAGES_OUT	Call by reference	☐	Type reference (TYPE)	SWFXIMAPPART			20030721
6	Exporting	SENDFAULT	Call by reference	☐	Type reference (TYPE)	SWFDXISNDFAULT		XI: Fehlerinformation nach dem Senden	20040607
7	Exporting	SIMPLETYPES_CNT	Call by reference	☐	Object reference (TYPE REF TO)	CL_SWF_XI_MAPPAR_CNT			20070824
8	Importing	SIMPLETYPES_IN	Call by reference	☑	Type reference (TYPE)	SWFXISIMPLEMAPPART			20070823
9	Exporting	SIMPLETYPES_OUT	Call by reference	☐	Type reference (TYPE)	SWFXISIMPLEMAPPART			20070823
10	Exporting	TRACE	Call by reference	☐	Type reference (TYPE)	SIBFLPORBT			20030821

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐		20030930

Method GET_MESSAGE_XMB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_MESSAGE_XMB	Call by reference	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE_XMB			20030923
2	Exporting	EX_XI_INSTANCE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SWF_XI_INSTANCE			20031006
3	Importing	IM_PORB	Call by reference	☐	Type reference (TYPE)	SIBFLPORB			20030923

Method GET_MESSAGE_XMB on class CL_SWF_XI_MSG_BROKER has no exception.

Method GET_TOPFLOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_TOPFLOW	Value transfer	☐	Type reference (TYPE)	SWW_WIID		Workitem-Kennung	20070622

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐		20070622

Method SEND_ACK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ACKMSGREF	Call by reference	☐	Type reference (TYPE)	SIBFLPOR		Lokale Persistente Objektreferenz	20090925
2	Importing	ACK_TYPE	Call by reference	☐	Type reference (TYPE)	SWFDXISACKTYP			20030828
3	Importing	FLOWITEM	Call by reference	☐	Type reference (TYPE)	SIBFLPORB			20030922
4	Importing	MESSAGE	Call by reference	☐	Type reference (TYPE)	SIBFLPORB			20030828

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐		20031006

Method SEND_ACK_INTERN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACK_TYPE	Call by reference	☐	Type reference (TYPE)	SWFDXISACKTYP			20031024
2	Exporting	EX_ACKMSGREF	Call by reference	☐	Type reference (TYPE)	SIBFLPOR		Lokale Persistente Objektreferenz	20090925
3	Importing	FLOWITEM	Call by reference	☐	Type reference (TYPE)	SIBFLPORB			20031024
4	Importing	IM_DO_COMMIT	Call by reference	☐	Type reference (TYPE)	XFELD	'X'		20031024
5	Importing	IM_WAPI_CONTEXT	Call by reference	☑	Object reference (TYPE REF TO)	IF_WAPI_WORKITEM_CONTEXT		Kontext für Workitem	20090925
6	Importing	MESSAGE	Call by reference	☐	Type reference (TYPE)	SIBFLPORB			20031024

#	Exception	Resumable	Description	Created on
1	CX_SWF_IFS_EXCEPTION	☐		20090925

Method SEND_ASYNCHRON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACKNOWLEDGEMENT	Call by reference	☐	Type reference (TYPE)	SWFDXISDAK			20030721
2	Importing	CONV_ID	Call by reference	☑	Type reference (TYPE)	SXMSCONVID		XI: Konversations-Id	20050927
3	Importing	MESSAGE	Call by reference	☐	Type reference (TYPE)	SIBFLPORB			20030721
4	Exporting	MESSAGE_SENT	Call by reference	☐	Type reference (TYPE)	SIBFLPORB			20030721
5	Importing	PP_DATA	Call by reference	☑	Type reference (TYPE)	SWFXIPPDATA		Anwendungsdaten der Weitergabe von Benutzeridentitäten	20070525
6	Importing	QUEUE_ID	Call by reference	☑	Type reference (TYPE)	SXMSQID		ID für Message-Queue	20050927
7	Importing	RECEIVERS	Call by reference	☐	Type reference (TYPE)	SXI_ADDRESSES			20030808
8	Importing	RECEIVER_TYPE	Call by reference	☐	Type reference (TYPE)	SWFDXISRECTYP			20030829
9	Importing	REPLYTOMESSAGE	Call by reference	☐	Type reference (TYPE)	SIBFLPORB			20030808
10	Importing	SENDCONTEXT	Call by reference	☐	Type reference (TYPE)	SWF_STRING			20030808
11	Importing	USERINFO_GUID	Call by reference	☑	Type reference (TYPE)	USERINFO_GUID		Eindeutiger Identifier für die Ablage von USERINFO-Metadaten	20070525

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐		20030721

Method SEND_PREPARE_RECEIVERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MESSAGE_XMB	Call by reference	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE_XMB			20030829
2	Importing	IM_RECEIVERS	Call by reference	☐	Type reference (TYPE)	SXI_ADDRESSES			20030829
3	Importing	IM_RECEIVER_TYPE	Call by reference	☐	Type reference (TYPE)	SWFDXISRECTYP			20030829
4	Importing	IM_REPLYTOMESSAGE	Call by reference	☐	Type reference (TYPE)	SIBFLPORB			20030829
5	Importing	IM_SENDCONTEXT	Call by reference	☐	Type reference (TYPE)	SWF_STRING			20030829

#	Exception	Resumable	Description	Created on
1	CX_SWF_XI_EXCEPTION	☐		20030829

Method SEND_SYNCHRON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR_RESPONSE	Call by reference	☐	Type reference (TYPE)	SIBFLPORB		Lokale Persistente Objektreferenz - BOR kompatibel	20090213
2	Importing	INTERFACE	Call by reference	☐	Type reference (TYPE)	SXI_INTERFACE			20030828
3	Importing	MESSAGE_REQUEST	Call by reference	☐	Type reference (TYPE)	SIBFLPORB			20030828
4	Changing	MESSAGE_RESPONSE	Call by reference	☐	Type reference (TYPE)	SIBFLPORB			20030828
5	Exporting	MESSAGE_SENT	Call by reference	☐	Type reference (TYPE)	SIBFLPORB		Lokale Persistente Objektreferenz - BOR kompatibel	20090213
6	Importing	PP_DATA	Call by reference	☑	Type reference (TYPE)	SWFXIPPDATA			20070525
7	Importing	RECEIVERS	Call by reference	☐	Type reference (TYPE)	SXI_ADDRESSES			20030828
8	Importing	RECEIVER_TYPE	Call by reference	☐	Type reference (TYPE)	SWFDXISRECTYP			20030829
9	Importing	REPLYTOMESSAGE	Call by reference	☐	Type reference (TYPE)	SIBFLPORB			20030828
10	Importing	RESPONSE_TYPE	Call by reference	☐	Type reference (TYPE)	SIBFOTYPE			20030902
11	Importing	SENDCONTEXT	Call by reference	☐	Type reference (TYPE)	SWF_STRING			20030828
12	Exporting	SENDFAULT	Call by reference	☐	Type reference (TYPE)	SWFDXISNDFAULT			20030922
13	Importing	USERINFO_GUID	Call by reference	☑	Type reference (TYPE)	USERINFO_GUID			20070525

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐		20030901

Method SEND_SYNCHRON_REPLY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INTERFACE	Call by reference	☐	Type reference (TYPE)	SXI_INTERFACE		XI: Interface	20040507
2	Importing	REPLY_MESSAGE	Call by reference	☐	Type reference (TYPE)	SIBFLPORB		Lokale Persistente Objektreferenz - BOR kompatibel	20040507
3	Exporting	REPLY_MESSAGE_SENT	Call by reference	☐	Type reference (TYPE)	SIBFLPORB		Lokale Persistente Objektreferenz - BOR kompatibel	20040510
4	Importing	REQUEST_MESSAGE	Call by reference	☐	Type reference (TYPE)	SIBFLPORB		Lokale Persistente Objektreferenz - BOR kompatibel	20040507
5	Exporting	SENDFAULT	Call by reference	☐	Type reference (TYPE)	SWFDXISNDFAULT		XI: Fehlerinformation nach dem Senden	20040507

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐		20040507

Method SET_PROCESS_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MESSAGE_XMB	Call by reference	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE_XMB			20030930
2	Importing	IM_SENDCONTEXT	Call by reference	☐	Type reference (TYPE)	SWF_STRING			20030930

Method SET_PROCESS_CONTEXT on class CL_SWF_XI_MSG_BROKER has no exception.

Method WRITE_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_FUNCNAME	Call by reference	☐	Type reference (TYPE)	FUNCNAME		Funktionsname	20060118
2	Importing	IM_MESSAGE	Call by reference	☐	Type reference (TYPE)	SIBFLPORB		Lokale Persistente Objektreferenz - BOR kompatibel	20060118

Method WRITE_LOG on class CL_SWF_XI_MSG_BROKER has no exception.

Event Signatures

Event RECEIVED Signature
Event RECEIVED on class CL_SWF_XI_MSG_BROKER has no parameter.
Event SEND_OK_APPLICATION Signature
Event SEND_OK_APPLICATION on class CL_SWF_XI_MSG_BROKER has no parameter.
Event SEND_OK_TRANSPORT Signature
Event SEND_OK_TRANSPORT on class CL_SWF_XI_MSG_BROKER has no parameter.

History

Last changed by/on	SAP	20110908
SAP Release Created in	640