SAP ABAP Class CL_APC_MANAGER (ABAP Push Channel (APC) WebSocket (WS) framework manager)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_HTTP_EXTENSION	HTTP Framework (iHTTP) HTTP Request Handler	20120831

Properties

Class	CL_APC_MANAGER
Short Description	ABAP Push Channel (APC) WebSocket (WS) framework manager
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status	S	System Program
Category	0
Package	SAPC_RUNTIME	APC runtime package
Created	20120831	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_HTTP_EXTENSION	☐	☐	HTTP Framework (iHTTP) HTTP Request Handler	20120831

Friends

#	Friend	Modeled only	Created on	Description
1	CL_APC_KRN_SERVICES	☐	20130125	ABAP Push Channel (APC) kernel methods

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_APC_INFO_APPLICATION_ID	Constant	Private	☐	Type reference (TYPE)	APC_SSTRING	':APID='	ABAP Push Channel Short String	20121129
2	CO_APC_INFO_CALLER_IP	Constant	Private	☐	Type reference (TYPE)	APC_SSTRING	':CAIP='	ABAP Push Channel Short String	20121129
3	CO_APC_INFO_CONNECTION_PARAM	Constant	Private	☐	Type reference (TYPE)	APC_SSTRING	':CONN='	ABAP Push Channel Short String	20121129
4	CO_APC_INFO_PATH	Constant	Private	☐	Type reference (TYPE)	APC_SSTRING	':PATH='	ABAP Push Channel Short String	20121129
5	CO_APC_INFO_VIRT_HOST_NUMBER	Constant	Private	☐	Type reference (TYPE)	APC_SSTRING	':VHNR='	ABAP Push Channel Short String	20130625
6	CO_APC_RINFO_DESERIALIZE	Constant	Protected	☐	Type reference (TYPE)	I	2		20121130
7	CO_APC_RINFO_SERIALIZE	Constant	Protected	☐	Type reference (TYPE)	I	1		20121129
8	CO_WS_EVENT_TYPE_CLOSE	Constant	Protected	☐	Type reference (TYPE)	I	8	see ICT_WS_OPCODE_CONN_CLOSE	20121218
9	CO_WS_EVENT_TYPE_ERROR	Constant	Protected	☐	Type reference (TYPE)	I	838	see ICT_WS_OPCODE_CONN_CLOSE+ICT_EWCONNCLOSED	20130125
10	CO_WS_EVENT_TYPE_MSG_BINARY	Constant	Protected	☐	Type reference (TYPE)	I	2	see ICT_WS_OPCODE_BINARY	20121218
11	CO_WS_EVENT_TYPE_MSG_TEXT	Constant	Protected	☐	Type reference (TYPE)	I	1	see ICT_WS_OPCODE_TEXT	20121218
12	G_APPLICATION_CONFIG	Static Attribute	Protected	☐	Type reference (TYPE)	APC_APPL_V		Generated Table for View	20121206
13	G_APPLICATION_ID	Static Attribute	Protected	☐	Type reference (TYPE)	APC_APPLICATION_ID			20121129
14	G_APPLICATION_PATH	Static Attribute	Private	☐	Type reference (TYPE)	APC_APPL_PATH		ABAP Push Channel application path	20121127
15	G_CONNECTION_PARAMETER	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20130109
16	G_PATH	Static Attribute	Protected	☐	Type reference (TYPE)	STRING			20130108
17	G_PROCESS_ON_START	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Process ON_START() method with initial request	20121015
18	G_REQUEST	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20130108
19	G_REQUEST_PATH	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20130215
20	G_SERVER	Static Attribute	Public	☐	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20121015
21	G_SET_ERROR_PAGE	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20121217
22	G_STATEFUL	Static Attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Is application stateful ?	20121210
23	G_VIRTUAL_HOST_NUMBER	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20130611
24	MO_RUNTIME_ANALYSIS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_ATRA_TRACE_INTERNAL			20121211
25	M_ABAP_RUNTIME_ANAYSIS_ACTIVE	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20121211
26	M_ACCEPT_REMOTE_PROFILE_LEVEL	Instance attribute	Protected	☐	Type reference (TYPE)	I			20121211
27	M_ACCEPT_REMOTE_RECORDER_LEVEL	Instance attribute	Protected	☐	Type reference (TYPE)	I			20121211
28	M_ACCEPT_REMOTE_TRACE_LEVEL	Instance attribute	Protected	☐	Type reference (TYPE)	I			20121211
29	M_APC_WS_INITIAL_REQUEST	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_APC_WS_INITIAL_REQUEST		APC framework: Initial request at setup (do not implement)	20121210
30	M_APPL_EXTENSION	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_APC_WS_EXTENSION_STATELESS		APC framework: Stateless message handler (see documentation)	20121210
31	M_CONTEXT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_APC_WS_CONTEXT		APC framework: Context interface (do not implement)	20121210
32	M_DEBUGGING_POSSIBLE	Instance attribute	Protected	☐	Type reference (TYPE)	C			20121211
33	M_EVENT_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	I		Present event type, e.g. binary message, text message, close	20130108
34	M_FUNCTIONAL_TRACE_LEVEL	Instance attribute	Protected	☐	Type reference (TYPE)	I			20121211
35	M_KS_TIMER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_ABAP_RUNTIME		Kernel Static timer Interface	20130618
36	M_LOGON_SUCCESSFUL	Instance attribute	Protected	☐	Type reference (TYPE)	C			20121211

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_ORIGIN	Instance method	Private	Method	Validate the origin header (same/cross origin policy)	20130408
2	CHECK_XSRF	Instance method	Private	Method	Validate the XSRF token	20121218
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20130618
4	DETERMINE_APPLICATION_CONTEXT	Instance method	Private	Method	Identify the APC application for the processing	20121127
5	DISPATCH	Instance method	Private	Method	Dispatch APC message to application	20121015
6	EXECUTE_EVENT	Instance method	Private	Method	Execute the WebSocket message	20121218
7	EXECUTE_START	Instance method	Private	Method	Execute the WebSocket message	20121218
8	FINALIZE	Instance method	Private	Method	Release and clenup the APC session	20121122
9	GET_APPLICATION_CONTEXT	Instance method	Private	Method	Restore application data for execution of WebSocket messages	20121218
10	LAUNCH	Static method	Public	Method		20121218
11	PREPARE_APC_APPLICATION_INFO	Instance method	Private	Method	Compose or split APC runtime info in/out of string	20121129
12	SET_APPLICATION_CONTEXT	Instance method	Private	Method	Preserve application data for subsequent WebSocket messages	20121218
13	SET_ERROR_PAGE	Instance method	Private	Method	Install error page	20121217
14	SET_TH_APPLICATION_INFO	Instance method	Private	Method	Set taskhandler application info	20121210
15	START	Instance method	Private	Method	Called for request handling for each incoming HTTP request	20121218
16	START_ABAP_RUNTIME_ANALYSIS	Instance method	Private	Method	Start ABAP runtime analysis	20121211
17	START_DEBUGGER	Instance method	Private	Method	Start external debugger	20121211
18	START_FUNCTIONAL_TRACE	Instance method	Private	Method	Start functional trace	20121211
19	STOP_ABAP_RUNTIME_ANALYSIS	Instance method	Private	Method	Stop ABAP runtime analysis	20121211
20	WEBSOCKET_HANDSHAKE	Instance method	Private	Method	Establish WebSocket connection	20120917
21	WEBSOCKET_SEND_OK	Instance method	Private	Method	Send OK	20120917

Events

Class CL_APC_MANAGER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	GTYPE_APPLICATION_INFO	Protected	See coding			20121129	BEGIN OF gtype_application_info, request TYPE xstring, appl_config TYPE apc_appl_v, path TYPE string, set_error_page type abap_bool, END OF gtype_application_info

Method Signatures

Method CHECK_ORIGIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SERVER	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20130408
2	Returning	R_SUCCESSFUL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20130408

Method CHECK_ORIGIN on class CL_APC_MANAGER has no exception.

Method CHECK_XSRF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SERVER	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20121218
2	Returning	R_SUCCESSFUL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20121218

Method CHECK_XSRF on class CL_APC_MANAGER has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_APC_MANAGER has no parameter.
Method CONSTRUCTOR on class CL_APC_MANAGER has no exception.

Method DETERMINE_APPLICATION_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20121127

Method DETERMINE_APPLICATION_CONTEXT on class CL_APC_MANAGER has no exception.

Method DISPATCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BINARY_MESSAGE	Call by reference	☑	Type reference (TYPE)	XSTRING			20121204
2	Importing	I_CLOSE_CODE	Call by reference	☑	Type reference (TYPE)	I			20130719
3	Importing	I_CLOSE_REASON	Call by reference	☑	Type reference (TYPE)	STRING			20130712
4	Importing	I_EVENT_TYPE	Call by reference	☑	Type reference (TYPE)	I			20121204
5	Importing	I_REQUEST	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20121116
6	Importing	I_TEXT_MESSAGE	Call by reference	☑	Type reference (TYPE)	STRING			20121204

Method DISPATCH on class CL_APC_MANAGER has no exception.

Method EXECUTE_EVENT Signature

Method EXECUTE_EVENT on class CL_APC_MANAGER has no parameter.
Method EXECUTE_EVENT on class CL_APC_MANAGER has no exception.

Method EXECUTE_START Signature

Method EXECUTE_START on class CL_APC_MANAGER has no parameter.
Method EXECUTE_START on class CL_APC_MANAGER has no exception.

Method FINALIZE Signature

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

Method GET_APPLICATION_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_SUCCESSFUL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20121218

Method GET_APPLICATION_CONTEXT on class CL_APC_MANAGER has no exception.

Method LAUNCH Signature

Method LAUNCH on class CL_APC_MANAGER has no parameter.
Method LAUNCH on class CL_APC_MANAGER has no exception.

Method PREPARE_APC_APPLICATION_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_APC_INFO	Call by reference	☐	Type reference (TYPE)	STRING			20121129
2	Changing	C_APPLICATION_ID	Call by reference	☐	Type reference (TYPE)	APC_APPLICATION_ID		ABAP Push Channel Application ID	20121129
3	Changing	C_APPLICATION_PATH	Call by reference	☐	Type reference (TYPE)	APC_APPL_PATH		ABAP Push Channel application path	20121129
4	Changing	C_CALLER_IP	Call by reference	☐	Type reference (TYPE)	STRING		ABAP Push Channel caller IP	20121129
5	Changing	C_CONNECTION_PARAM	Call by reference	☐	Type reference (TYPE)	STRING		ABAP Push Channel connection parameter	20121129
6	Changing	C_VIRTUAL_HOST_NUMBER	Call by reference	☐	Type reference (TYPE)	STRING			20130625
7	Importing	I_ACTION	Call by reference	☐	Type reference (TYPE)	I		CO_APC_RINFO_SERIALIZE/CO_APC_RINFO_DESERIALIZE	20121129

Method PREPARE_APC_APPLICATION_INFO on class CL_APC_MANAGER has no exception.

Method SET_APPLICATION_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20121218
2	Returning	R_SUCCESSFUL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20121218

Method SET_APPLICATION_CONTEXT on class CL_APC_MANAGER has no exception.

Method SET_ERROR_PAGE Signature

Method SET_ERROR_PAGE on class CL_APC_MANAGER has no parameter.
Method SET_ERROR_PAGE on class CL_APC_MANAGER has no exception.

Method SET_TH_APPLICATION_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CALLER_IP	Call by reference	☐	Type reference (TYPE)	STRING			20121210

Method SET_TH_APPLICATION_INFO on class CL_APC_MANAGER has no exception.

Method START Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SERVER	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Server	20121218

Method START on class CL_APC_MANAGER has no exception.

Method START_ABAP_RUNTIME_ANALYSIS Signature

Method START_ABAP_RUNTIME_ANALYSIS on class CL_APC_MANAGER has no parameter.
Method START_ABAP_RUNTIME_ANALYSIS on class CL_APC_MANAGER has no exception.

Method START_DEBUGGER Signature

Method START_DEBUGGER on class CL_APC_MANAGER has no parameter.
Method START_DEBUGGER on class CL_APC_MANAGER has no exception.

Method START_FUNCTIONAL_TRACE Signature

Method START_FUNCTIONAL_TRACE on class CL_APC_MANAGER has no parameter.
Method START_FUNCTIONAL_TRACE on class CL_APC_MANAGER has no exception.

Method STOP_ABAP_RUNTIME_ANALYSIS Signature

Method STOP_ABAP_RUNTIME_ANALYSIS on class CL_APC_MANAGER has no parameter.
Method STOP_ABAP_RUNTIME_ANALYSIS on class CL_APC_MANAGER has no exception.

Method WEBSOCKET_HANDSHAKE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SERVER	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20120831
2	Returning	SUCCESSFUL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20130207

Method WEBSOCKET_HANDSHAKE on class CL_APC_MANAGER has no exception.

Method WEBSOCKET_SEND_OK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SERVER	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20120904

Method WEBSOCKET_SEND_OK on class CL_APC_MANAGER has no exception.

History

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