SAP ABAP Class CL_AMC_RUNTIME (ABAP Messaging Channel (AMC) runtime basis API)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-MID-AC (Application Component) ABAP Channels
     ⤷ SAMC_RUNTIME (Package) AMC runtime package

Properties

Class	CL_AMC_RUNTIME
Short Description	ABAP Messaging Channel (AMC) runtime basis API
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status	S	System Program
Category	0
Package	SAMC_RUNTIME	AMC runtime package
Created	20111123	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)
2	CL_AMC_MESSAGE_CONTEXT	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_SSI_AMC	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_AMC_RUNTIME has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ABAP_AMC_DISPATCHER	☐	20121112	Dispatcher for AMC Messages
2	CL_AMC_CHANNEL_MANAGER	☐	20120917	ABAP Messaging Channel Manager
3	CL_AMC_CHANNEL_UTILITY	☐	20130722	ABAP Messaging Channel utility
4	CL_AMC_MESSAGE_CONSUMER	☐	20120917	ABAP Messaging Channel (AMC) consumer class
5	CL_APC_WS_BINDING_MANAGER	☐	20120917	APC framework: WebSocket connection binding manager
6	IF_AMC_MESSAGE_PRODUCER	☐	20120917	ABAP Messaging Channel (AMC) interface for message producer

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_ACTIVITY_BIND_SEND_APC	Static Attribute	Private	☐	Type reference (TYPE)	C	'C'	AMC ACTIVITY: Bind to Send to APC	20121205
2	CO_ACTIVITY_RECEIVE_SAPGUI	Static Attribute	Private	☐	Type reference (TYPE)	C	'G'	AMC ACTIVITY: Receive	20130516
3	CO_ACTIVITY_RECEIVE_SESSION	Static Attribute	Private	☐	Type reference (TYPE)	C	'R'	AMC ACTIVITY: Receive	20130516
4	CO_ACTIVITY_SEND	Static Attribute	Private	☐	Type reference (TYPE)	C	'S'	AMC ACTIVITY: Send	20121205
5	CO_MESSAGE_CONTENT_TYPE_BINARY	Constant	Private	☐	Type reference (TYPE)	I	CL_SSI_AMC=>CO_MSG_TYPE_BINARY	Message content type BINARY	20121205
6	CO_MESSAGE_CONTENT_TYPE_TEXT	Constant	Private	☐	Type reference (TYPE)	I	CL_SSI_AMC=>CO_MSG_TYPE_TEXT	Message content type Text	20121205
7	CO_MESSAGE_CONTENT_TYPE_UTF8	Constant	Private	☐	Type reference (TYPE)	I	CL_SSI_AMC=>CO_MSG_TYPE_UTF8	Message content type UTF8	20121205
8	C_REGISTERED_CHANNELS	Static Attribute	Private	☐	Type reference (TYPE)	GT_REGISTERED_CHANNELS			20120912
9	G_APPLICATION_SERVER_NAME	Static Attribute	Private	☐	Type reference (TYPE)	MSNAME2		Application Server Name	20120917
10	G_CLIENT	Static Attribute	Private	☐	Type reference (TYPE)	SYMANDT		Client ID of Current User	20120926
11	G_IN_EXECUTION	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Is session in "Execution" step of a message ?	20120912
12	G_MESSAGE_QUEUE	Static Attribute	Private	☐	Type reference (TYPE)	GT_MESSAGE_QUEUE			20120912
13	G_ROOT_CONTEXT_ID	Static Attribute	Private	☐	Type reference (TYPE)	EPP_ROOT_CONTEXT_ID		Root Context ID of Extended Passport (EPP)	20120912
14	G_STATISTIC_STATE	Static Attribute	Private	☐	Type reference (TYPE)	I	0	Is taskhandler statistic active ?	20120912
15	G_TRACE_LEVEL	Static Attribute	Private	☐	Type reference (TYPE)	I		Determine the present functional trace level	20120912
16	G_USER_NAME	Static Attribute	Private	☐	Type reference (TYPE)	SYUNAME		User Name	20120926
17	M_AUTHORITY_DONE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Is authorithy check already successfully applied ?	20120912
18	M_CHANNEL_IDENTITY_ROLE	Instance attribute	Private	☐	Type reference (TYPE)	GT_CHANNEL_IDENTITY_ROLE		ABAP Messaging Channels Identity	20120912
19	M_ENTRY_COUNTER	Instance attribute	Private	☐	Type reference (TYPE)	I		Used for (unification of) log entries	20120912
20	M_ENTRY_ID	Instance attribute	Private	☐	Type reference (TYPE)	SYSUUID_C32		Used for (unification of) log entries	20120912
21	M_EPP_ENTITY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_EPP_ENTITY		Entity in Extended Passport (EPP)	20120912
22	M_EPP_SYSTEM_ENTITY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_EPP_SYSTEM_ENTITY		Entity of System Area in EPP	20120912
23	M_MESSAGE_EPP	Instance attribute	Private	☐	Type reference (TYPE)	AMC_MESSAGE_EPP_ATTR		Attributes of EPP for AMC	20120912
24	M_SCANNER_SEND	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_VSI		Virus Scan API for Application Developers	20121030

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BIND_WEBSOCKET_CONSUMSER	Instance method	Private	Method	Bind WebSocket connection to AMC channel	20120912
2	CHECK_AUTHORITY	Instance method	Private	Method	Access authorization check the channel	20120912
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20120912
4	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20120912
5	DISPATCH	Static method	Private	Method	Dispatch messages to the subscribed channels	20120912
6	DISPATCH_SAPGUI	Static method	Public	Method	Dispatch messages to the subscribed channels	20130516
7	EXECUTE	Static method	Private	Method	Execute received message	20120912
8	GET_EXTENDED_PASSPORT	Instance method	Private	Method	Export of Extended Passort (EPP)	20120912
9	REGISTER_CHANNEL	Instance method	Private	Method	Subscribe to channel	20120912
10	SEND_MESSAGE	Instance method	Private	Method	Send serialized message to AMC channel	20120912
11	SET_EXTENDED_PASSPORT	Instance method	Private	Method	Import of Extended Passort (EPP)	20120912
12	UNBIND_WEBSOCKET_CONSUMER	Instance method	Private	Method	Unbind WebSocket connection from an AMC channel	20120912
13	UNREGISTER_CHANNEL	Static method	Private	Method	Un-Subscribe the channel	20120912
14	VIRUS_SCAN_MESSAGE	Instance method	Private	Method	Check message content via virus scanner	20121030

Events

#	Event	Type	Visibility	Description	Created on
1	EVENT_RECEIVED	Static Event (1)	Public (2)		20120912

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	GT_CHANNEL_IDENTITY_ROLE	Public	See coding			20120912	BEGIN OF gt_channel_identity_role, role TYPE amc_role, identity TYPE amc_channel_identity, vsi_profile_send TYPE vscan_profile, END OF gt_channel_identity_role
2	GT_MESSAGE_QUEUE	Private	See coding			20120912	gt_message_queue TYPE STANDARD TABLE OF gt_message_queue_entry
3	GT_MESSAGE_QUEUE_ENTRY	Private	See coding			20120912	BEGIN OF gt_message_queue_entry, ssi_channel_id TYPE ssi_channel_id, serialized_message TYPE xstring, message_context TYPE cl_amc_message_context=>gt_client_context, END OF gt_message_queue_entry
4	GT_REGISTERED_CHANNEL	Private	See coding			20120912	BEGIN OF gt_registered_channel, amc_channel TYPE amc_channel_v, "provided attributes of the amc_channel amc_channel_extension_id type amc_channel_extension_id, ssi_channel_id TYPE ssi_channel_id, "constructed channel id for taskhandler registration receiver TYPE REF TO if_amc_message_receiver,"receiver object entry_id TYPE sysuuid_c32, "Used for (unification of) log entries entry_counter TYPE i, "Used for (unification of) log entries´ message_type TYPE amc_message_type, role type amc_role, "Used for unregister action for R and G END OF gt_registered_channel
5	GT_REGISTERED_CHANNELS	Private	See coding			20120912	gt_registered_channels TYPE HASHED TABLE OF gt_registered_channel WITH UNIQUE KEY amc_channel-application_id amc_channel-channel_id amc_channel_extension_id receiver

Method Signatures

Method BIND_WEBSOCKET_CONSUMSER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHANNEL_IDENTITY	Call by reference	☐	Type reference (TYPE)	AMC_CHANNEL_IDENTITY		ABAP Messaging Channels Identity	20120924

#	Exception	Resumable	Description	Created on
1	CX_AMC_ERROR	☐	Error handling class for ABAP Messaging Channels (AMC)	20120906

Method CHECK_AUTHORITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACTIVITY	Call by reference	☐	Type reference (TYPE)	AMC_CHANNEL_ACTIVITY_TYPE		Type of ABAP Messaging Channel Activity	20120924
2	Importing	I_APPLICATION_ID	Call by reference	☐	Type reference (TYPE)	AMC_APPLICATION_ID			20120924
3	Importing	I_CHANNEL_ID	Call by reference	☐	Type reference (TYPE)	AMC_CHANNEL_ID		Identifier of the ABAP Messaging Channel	20120924

#	Exception	Resumable	Description	Created on
1	CX_AMC_ERROR	☐	Error handling class for ABAP Messaging Channels (AMC)	20111123

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_AMC_RUNTIME has no parameter.
Method CLASS_CONSTRUCTOR on class CL_AMC_RUNTIME has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHANNEL_IDENTITY_ROLE	Call by reference	☐	Type reference (TYPE)	GT_CHANNEL_IDENTITY_ROLE		ABAP Messaging Channels Identity	20120420

#	Exception	Resumable	Description	Created on
1	CX_AMC_ERROR	☐	Error handling class for ABAP Messaging Channels (AMC)	20120420

Method DISPATCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_HEADER	Call by reference	☑	Type reference (TYPE)	XSTRING			20130516
2	Importing	I_SERIALIZED_MESSAGE	Call by reference	☑	Type reference (TYPE)	XSTRING			20130516
3	Importing	I_SSI_CHANNEL_ID	Call by reference	☑	Type reference (TYPE)	SSI_CHANNEL_ID		Message Channel ID	20130516

Method DISPATCH on class CL_AMC_RUNTIME has no exception.

Method DISPATCH_SAPGUI Signature

Method DISPATCH_SAPGUI on class CL_AMC_RUNTIME has no parameter.
Method DISPATCH_SAPGUI on class CL_AMC_RUNTIME has no exception.

Method EXECUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MESSAGE_CONTEXT	Call by reference	☐	Type reference (TYPE)	CL_AMC_MESSAGE_CONTEXT=>GT_CLIENT_CONTEXT			20120924
2	Importing	I_SERIALIZED_MESSAGE	Call by reference	☐	Type reference (TYPE)	XSTRING			20120924
3	Importing	I_SSI_CHANNEL_ID	Call by reference	☐	Type reference (TYPE)	SSI_CHANNEL_ID		Message Channel ID	20120924

Method EXECUTE on class CL_AMC_RUNTIME has no exception.

Method GET_EXTENDED_PASSPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AMC_EPP_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	AMC_MESSAGE_EPP_ATTR		Attributes of EPP for AMC	20120924
2	Returning	R_PASSPORT	Value transfer	☐	Type reference (TYPE)	XSTRING			20120924

#	Exception	Resumable	Description	Created on
1	CX_EPP_ERROR	☐	Exception in Extended Passport (EPP)	20120702

Method REGISTER_CHANNEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHANNEL_IDENTITY	Call by reference	☐	Type reference (TYPE)	AMC_CHANNEL_IDENTITY		ABAP Messaging Channels Identity	20120924
2	Importing	I_RECEIVER	Call by reference	☐	Object reference (TYPE REF TO)	IF_AMC_MESSAGE_RECEIVER		ABAP Messaging Channel Message Receiver	20120924

#	Exception	Resumable	Description	Created on
1	CX_AMC_ERROR	☐	Error handling class for ABAP Messaging Channels (AMC)	20111123

Method SEND_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MESSAGE	Call by reference	☐	Type reference (TYPE)	XSTRING			20120924
2	Importing	I_MESSAGE_CONTENT_TYPE	Call by reference	☐	Type reference (TYPE)	I		Message content type (co_message_content_type_binary,text,..	20121205

#	Exception	Resumable	Description	Created on
1	CX_AMC_ERROR	☐	Error handling class for ABAP Messaging Channels (AMC)	20111123

Method SET_EXTENDED_PASSPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PASSPORT	Call by reference	☐	Type reference (TYPE)	XSTRING			20120924

#	Exception	Resumable	Description	Created on
1	CX_EPP_ERROR	☐	Exception in Extended Passport (EPP)	20120709

Method UNBIND_WEBSOCKET_CONSUMER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHANNEL_IDENTITY	Call by reference	☐	Type reference (TYPE)	AMC_CHANNEL_IDENTITY		ABAP Messaging Channels Identity	20120924

#	Exception	Resumable	Description	Created on
1	CX_AMC_ERROR	☐	Error handling class for ABAP Messaging Channels (AMC)	20120906

Method UNREGISTER_CHANNEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHANNEL_IDENTITY	Call by reference	☐	Type reference (TYPE)	AMC_CHANNEL_IDENTITY			20120924
2	Importing	I_RECEIVER	Call by reference	☐	Object reference (TYPE REF TO)	IF_AMC_MESSAGE_RECEIVER		ABAP Messaging Channel Message Receiver	20120924

#	Exception	Resumable	Description	Created on
1	CX_AMC_ERROR	☐	Error handling class for ABAP Messaging Channels (AMC)	20111123

Method VIRUS_SCAN_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MESSAGE	Call by reference	☐	Type reference (TYPE)	XSTRING			20121030

#	Exception	Resumable	Description	Created on
1	CX_AMC_ERROR	☐	APC framework: Error handling class for ABAP Push Channel	20121030

Event Signatures

Event EVENT_RECEIVED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	IV_EVENT_SET	Exporting	Value transfer	☐	Type reference (TYPE)	I			20111123

History

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