SAP ABAP Class CL_SAM_SESSION_QUEUE_CNTRLER (Session Queue Controller)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-GTF-IC-FRW-MES (Application Component) Messaging
     ⤷ CRM_SAM_BSP_SESSION (Package) SAM BSP Session Messaging

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BSP_CONTROLLER2	BSP Component	20031013
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BSP_APPLICATION_EVENTS	Business Server Page (BSP) Application Events	20110727
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SAM_MESSAGE_ACCESSOR	Helper Interface	20031017
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SAM_QUEUE_ACCESSOR	Helper Interface	20031014
5	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SAM_SESSION_PROPERTIES	Properties	20031205

Properties

Class	CL_SAM_SESSION_QUEUE_CNTRLER
Short Description	Session Queue Controller
Super Class	CL_BSP_CONTROLLER2	BSP Component
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CRM_SAM_BSP_SESSION	SAM BSP Session Messaging
Created	20031013	SAP
Last change	20130531	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_BSP_APPLICATION_EVENTS	☐	☐	Business Server Page (BSP) Application Events	20110727
2	IF_SAM_MESSAGE_ACCESSOR	☐	☐	Helper Interface	20031017
3	IF_SAM_QUEUE_ACCESSOR	☐	☐	Helper Interface	20031014
4	IF_SAM_SESSION_PROPERTIES	☐	☐	Properties	20031205

Friends

Class CL_SAM_SESSION_QUEUE_CNTRLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CONTROLLER_URL	Constant	Public	☐	Type reference (TYPE)	STRING	'/sap/bc/bsp/sap/sam_sess_queue/sam_session_queue_cntrler.do'		20031210
2	S_CLIENT_QUEUE_RECEIVER	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SAM_CLIENT_QUEUE_RECEIVER			20031210
3	S_REGISTERED_SESSIONS	Static Attribute	Protected	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Table Name/Value Pairs	20100120
4	S_SEND_TRACE	Static Attribute	Protected	☐	Type reference (TYPE)	STRING	SPACE		20031117
5	S_SEND_TRACE_QUEUE	Static Attribute	Protected	☐	Type reference (TYPE)	STRING	SPACE		20031218
6	S_SESSION_QUEUE_RECEIVER	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SAM_SESSION_QUEUE_RECEIVER			20031210
7	S_SHARED_CLIENT_QRECEIVER	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SAM_QUEUE_RECEIVER			20031210
8	S_SHARED_SESSION_QRECEIVER	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SAM_QUEUE_RECEIVER			20031210
9	S_TRACE	Static Attribute	Protected	☐	Type reference (TYPE)	STRING	SPACE		20031112

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	DESERIALIZE_MESSAGE	Static method	Public	Method	deserialize	20031017
2	GENERATE_SESSION_URL	Static method	Public	Method	generates session url	20031205
3	GET_STATIC_CLIENT_RECEIVER	Static method	Public	Method	returns static CL_SAM_CLIENT_QUEUE_RECEIVER instance	20031210
4	GET_STATIC_SESSION_RECEIVER	Static method	Public	Method	returns static CL_SAM_SESSION_QUEUE_RECEIVER instance	20031210
5	PING_SESSION_QUEUE_CNTRLER	Static method	Public	Method	sends a ping to a SessionQueueReceiver	20031210
6	SERIALIZE_MESSAGE	Static method	Public	Method	serialize	20031017
7	TRACE_SESSION_QUEUE_CNTRLER	Static method	Public	Method	sends trace request to a SessionQueueReceiver	20031218

Events

Class CL_SAM_SESSION_QUEUE_CNTRLER has no event.

Types

Class CL_SAM_SESSION_QUEUE_CNTRLER has no local type.

Method Signatures

Method DESERIALIZE_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HTTP_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_ENTITY		HTTP Framework (iHTTP) HTTP Entity	20031017
2	Returning	MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	CL_SAM_MESSAGE		Message	20031017

#	Exception	Resumable	Description	Created on
1	CX_SAM_MESSAGING_EXCEPTION	☐	Messaging Exception	20031017

Method GENERATE_SESSION_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REGISTER_SECURE_URL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20100211
2	Importing	RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	CL_BSP_RUNTIME		Business Server Pages (BSP) Runtime	20031205
3	Importing	SESSION_TYPE	Call by reference	☐	Type reference (TYPE)	I	-1		20040318
4	Returning	SESSION_URL	Value transfer	☐	Type reference (TYPE)	STRING			20031205
5	Importing	URL	Call by reference	☐	Type reference (TYPE)	STRING			20031205

Method GENERATE_SESSION_URL on class CL_SAM_SESSION_QUEUE_CNTRLER has no exception.

Method GET_STATIC_CLIENT_RECEIVER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RECEIVER	Value transfer	☐	Object reference (TYPE REF TO)	CL_SAM_CLIENT_QUEUE_RECEIVER		Client Queue Receiver	20031210

Method GET_STATIC_CLIENT_RECEIVER on class CL_SAM_SESSION_QUEUE_CNTRLER has no exception.

Method GET_STATIC_SESSION_RECEIVER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RECEIVER	Value transfer	☐	Object reference (TYPE REF TO)	CL_SAM_SESSION_QUEUE_RECEIVER		Session Queue Receiver	20031210

Method GET_STATIC_SESSION_RECEIVER on class CL_SAM_SESSION_QUEUE_CNTRLER has no exception.

Method PING_SESSION_QUEUE_CNTRLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	QUEUE	Call by reference	☐	Type reference (TYPE)	STRING			20031210
2	Returning	RESPONSE	Value transfer	☐	Object reference (TYPE REF TO)	CL_SAM_TEXT_MESSAGE		Message	20031210

Method PING_SESSION_QUEUE_CNTRLER on class CL_SAM_SESSION_QUEUE_CNTRLER has no exception.

Method SERIALIZE_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HTTP_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_ENTITY		HTTP Framework (iHTTP) HTTP Entity	20031017
2	Importing	MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SAM_MESSAGE		Message	20031017

#	Exception	Resumable	Description	Created on
1	CX_SAM_MESSAGING_EXCEPTION	☐	Messaging Exception	20031017

Method TRACE_SESSION_QUEUE_CNTRLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	RECEIVER_QUEUE	Call by reference	☐	Type reference (TYPE)	STRING			20031218
2	Returning	RESPONSE	Value transfer	☐	Object reference (TYPE REF TO)	IF_SAM_MESSAGE		Message	20031219
3	Importing	TRACE_QUEUE	Call by reference	☐	Type reference (TYPE)	STRING			20031218

Method TRACE_SESSION_QUEUE_CNTRLER on class CL_SAM_SESSION_QUEUE_CNTRLER has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in