SAP ABAP Class CL_ICWC_SESSION_REGISTRY (ICWC Registry)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-GTF-IC-FRW (Application Component) Framework
     ⤷ CRM_ICWC_ABAP (Package) IC WebClient ABAP

Properties

Class	CL_ICWC_SESSION_REGISTRY
Short Description	ICWC Registry
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CRM_ICWC_ABAP	IC WebClient ABAP
Created	20040205	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_CRM_IC_SERVICES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	ICWC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_ICWC_SESSION_REGISTRY has no interface implemented.

Friends

Class CL_ICWC_SESSION_REGISTRY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	AGENT	Constant	Public	☐	Type reference (TYPE)	STRING	'AGENT'		20040318
2	AGENT_SESSION_URL	Constant	Public	☐	Type reference (TYPE)	STRING	'/sap/bc/bsp/sap/crm_ic/default.htm'		20040217
3	CC_NOT_EXISTS	Constant	Public	☐	Type reference (TYPE)	I	4	Cookie does Not Exist	20071121
4	CC_OK	Constant	Public	☐	Type reference (TYPE)	I	0	OK	20071121
5	CC_PARAMETER_MISSING	Constant	Public	☐	Type reference (TYPE)	I	2	Parameter Missing	20071121
6	CC_WRONG_DATA_OBJECT	Constant	Public	☐	Type reference (TYPE)	I	1	Data object Does Not Fit	20071121
7	DEFAULT_CTI_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'CTI'		20040205
8	DEFAULT_DESTINATION	Constant	Public	☐	Type reference (TYPE)	STRING	'NONE'		20040318
9	GR_SNS_SERVICE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CO_SNS_SERVER_PORT		Proxy Class (generated)	20091209
10	ICWC_APPL_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'ICWC'		20040210
11	M_LAST_ERROR	Static Attribute	Protected	☐	Type reference (TYPE)	I		Last Return Code	20071121
12	M_LAST_ERROR_NAME	Static Attribute	Protected	☐	Type reference (TYPE)	STRING		Internal Error Name	20071121
13	POLLING	Constant	Public	☐	Type reference (TYPE)	STRING	'POLLING'		20040304
14	SESSIONID	Static Attribute	Public	☐	Type reference (TYPE)	STRING			20040312
15	S_AGENT_SESSION_ID	Static Attribute	Protected	☐	Type reference (TYPE)	STRING			20040402
16	S_AGENT_SESSION_POLLING_KEY	Static Attribute	Protected	☐	Type reference (TYPE)	STRING			20040402
17	S_AGENT_SESSION_QUEUE	Static Attribute	Protected	☐	Type reference (TYPE)	STRING			20040402
18	S_SESSION_ID	Static Attribute	Protected	☐	Type reference (TYPE)	STRING		unique session ID	20071121
19	S_SESSION_SYNC_ID	Static Attribute	Protected	☐	Type reference (TYPE)	STRING			20040405
20	S_WORKER_SESSION_ID	Static Attribute	Protected	☐	Type reference (TYPE)	STRING			20040402
21	S_WORKER_SESSION_POLLING_KEY	Static Attribute	Protected	☐	Type reference (TYPE)	STRING			20040402
22	S_WORKER_SESSION_QUEUE	Static Attribute	Protected	☐	Type reference (TYPE)	STRING			20040402
23	S_WS_CL	Static Attribute	Protected	☐	Type reference (TYPE)	STRING			20071128
24	URL_PARAM_NOCOOKIE_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'sap-syscmd'		20040405
25	URL_PARAM_NOCOOKIE_VALUE	Constant	Public	☐	Type reference (TYPE)	STRING	'nocookie'		20040405
26	URL_PARAM_SESSION_ID_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'crm-icsessionid'		20071121
27	URL_PARAM_SESSION_SYNC_ID_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'crm-icsessionsyncid'		20040405
28	URL_PARAM_WS_CL_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'crm-icwscl'		20071128
29	WORKER	Constant	Public	☐	Type reference (TYPE)	STRING	'WORKER'		20040318
30	WORKER_SESSION_URL	Constant	Public	☐	Type reference (TYPE)	STRING	'/sap/bc/bsp/sap/crm_ic/abap_workerSessionPage.htm'		20040217

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	DO_CTI_LOGOUT	Static method	Public	Method	do CTI Logout	20040405
2	GET_AGENT_SESSION_ID	Static method	Public	Method	returns agent session id	20040205
3	GET_AGENT_SESSION_POLLING_KEY	Static method	Public	Method	returns agent session polling key (SAM)	20040304
4	GET_AGENT_SESSION_QUEUE	Static method	Public	Method	returns agent session queue (SAM)	20040205
5	GET_CLIENT_SESSION_POLLING_KEY	Static method	Public	Method	returns client session polling key (SAM)	20040311
6	GET_CLIENT_SESSION_QUEUE	Static method	Public	Method	returns client session queue (SAM)	20040311
7	GET_DESTINATION	Static method	Public	Method	helper: returns destination for session startup	20040223
8	GET_SESSION_ID	Static method	Public	Method	returns unique session ID	20071121
9	GET_SESSION_SYNC_ID	Static method	Public	Method	helper: returns sync id worker <--> agent	20040405
10	GET_SNS_SERVICE	Static method	Public	Method	Get SNS server instance	20091209
11	GET_WORKER_SAM_QUEUE	Static method	Public	Method	returns the registered queue for a key	20071121
12	GET_WORKER_SESSION_ID	Static method	Public	Method	returns worker session id	20040210
13	GET_WORKER_SESSION_POLLING_KEY	Static method	Public	Method	returns worker session polling key (SAM)	20040304
14	GET_WORKER_SESSION_QUEUE	Static method	Public	Method	returns worker session queue (SAM)	20040210
15	GET_WORKER_SESSION_URI	Static method	Public	Method	returns the url of the page that represents the worker sess.	20040901
16	GET_WS_CL	Static method	Public	Method	returns worker session client number	20071128
17	REGISTER_AS_AGENT_SESSION	Static method	Public	Method	registers current session as agent session	20040210
18	REGISTER_AS_WORKER_SESSION	Static method	Public	Method	registers current session as worker session	20040210
19	REMOVE_AGENT_SESSION	Static method	Public	Method	removes agent session	20040405
20	REMOVE_WORKER_SESSION	Static method	Public	Method	removes worker session	20040405
21	SET_SESSION_SYNC_ID	Static method	Public	Method	helper: sets the sync id worker <--> agent	20080108
22	START_AGENT_SESSION	Static method	Public	Method	startup sequence of ICWC (Agent Session)	20040217
23	START_WORKER_SESSION	Static method	Public	Method	startup sequence of ICWC (Worker Session)	20040217

Events

Class CL_ICWC_SESSION_REGISTRY has no event.

Types

Class CL_ICWC_SESSION_REGISTRY has no local type.

Method Signatures

Method DO_CTI_LOGOUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	QUEUE	Value transfer	☐	Type reference (TYPE)	STRING	SPACE		20040405

Method DO_CTI_LOGOUT on class CL_ICWC_SESSION_REGISTRY has no exception.

Method GET_AGENT_SESSION_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ID	Value transfer	☐	Type reference (TYPE)	STRING			20040205

Method GET_AGENT_SESSION_ID on class CL_ICWC_SESSION_REGISTRY has no exception.

Method GET_AGENT_SESSION_POLLING_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	POLLING_KEY	Value transfer	☐	Type reference (TYPE)	STRING			20040304

Method GET_AGENT_SESSION_POLLING_KEY on class CL_ICWC_SESSION_REGISTRY has no exception.

Method GET_AGENT_SESSION_QUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	QUEUE	Value transfer	☐	Type reference (TYPE)	STRING			20040205

Method GET_AGENT_SESSION_QUEUE on class CL_ICWC_SESSION_REGISTRY has no exception.

Method GET_CLIENT_SESSION_POLLING_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID	Call by reference	☑	Type reference (TYPE)	STRING			20040311
2	Returning	POLLING_KEY	Value transfer	☐	Type reference (TYPE)	STRING			20040311

Method GET_CLIENT_SESSION_POLLING_KEY on class CL_ICWC_SESSION_REGISTRY has no exception.

Method GET_CLIENT_SESSION_QUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID	Call by reference	☑	Type reference (TYPE)	STRING			20040311
2	Returning	QUEUE	Value transfer	☐	Type reference (TYPE)	STRING			20040311

Method GET_CLIENT_SESSION_QUEUE on class CL_ICWC_SESSION_REGISTRY has no exception.

Method GET_DESTINATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DESTINATION	Value transfer	☐	Type reference (TYPE)	STRING			20040223

Method GET_DESTINATION on class CL_ICWC_SESSION_REGISTRY has no exception.

Method GET_SESSION_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SESSION_ID	Value transfer	☐	Type reference (TYPE)	STRING			20071121

Method GET_SESSION_ID on class CL_ICWC_SESSION_REGISTRY has no exception.

Method GET_SESSION_SYNC_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SESSION_SYNC_ID	Value transfer	☐	Type reference (TYPE)	STRING			20040405

Method GET_SESSION_SYNC_ID on class CL_ICWC_SESSION_REGISTRY has no exception.

Method GET_SNS_SERVICE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_SNS_SERVICE	Value transfer	☐	Object reference (TYPE REF TO)	CO_SNS_SERVER_PORT		16 Byte UUID in 16 Bytes (Raw Format)	20091209

Method GET_SNS_SERVICE on class CL_ICWC_SESSION_REGISTRY has no exception.

Method GET_WORKER_SAM_QUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	KEY	Call by reference	☐	Type reference (TYPE)	STRING		Worker Session Key	20071121
2	Returning	QUEUE	Value transfer	☐	Type reference (TYPE)	STRING		Worker Session Queue	20071121
3	Importing	WORKER_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Worker Session Client	20071121

Method GET_WORKER_SAM_QUEUE on class CL_ICWC_SESSION_REGISTRY has no exception.

Method GET_WORKER_SESSION_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ID	Value transfer	☐	Type reference (TYPE)	STRING			20040210

Method GET_WORKER_SESSION_ID on class CL_ICWC_SESSION_REGISTRY has no exception.

Method GET_WORKER_SESSION_POLLING_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	POLLING_KEY	Value transfer	☐	Type reference (TYPE)	STRING			20040304

Method GET_WORKER_SESSION_POLLING_KEY on class CL_ICWC_SESSION_REGISTRY has no exception.

Method GET_WORKER_SESSION_QUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	QUEUE	Value transfer	☐	Type reference (TYPE)	STRING			20040210

Method GET_WORKER_SESSION_QUEUE on class CL_ICWC_SESSION_REGISTRY has no exception.

Method GET_WORKER_SESSION_URI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	WORKER_URL	Value transfer	☐	Type reference (TYPE)	STRING			20040901

Method GET_WORKER_SESSION_URI on class CL_ICWC_SESSION_REGISTRY has no exception.

Method GET_WS_CL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_WS_CL	Value transfer	☐	Type reference (TYPE)	STRING			20071128

Method GET_WS_CL on class CL_ICWC_SESSION_REGISTRY has no exception.

Method REGISTER_AS_AGENT_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	QUEUE	Value transfer	☐	Type reference (TYPE)	STRING			20040210
2	Importing	RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	CL_BSP_RUNTIME		Business Server Pages (BSP) Runtime	20040210

Method REGISTER_AS_AGENT_SESSION on class CL_ICWC_SESSION_REGISTRY has no exception.

Method REGISTER_AS_WORKER_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	QUEUE	Value transfer	☐	Type reference (TYPE)	STRING			20040210
2	Importing	RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	CL_BSP_RUNTIME		Business Server Pages (BSP) Runtime	20040210

Method REGISTER_AS_WORKER_SESSION on class CL_ICWC_SESSION_REGISTRY has no exception.

Method REMOVE_AGENT_SESSION Signature

Method REMOVE_AGENT_SESSION on class CL_ICWC_SESSION_REGISTRY has no parameter.
Method REMOVE_AGENT_SESSION on class CL_ICWC_SESSION_REGISTRY has no exception.

Method REMOVE_WORKER_SESSION Signature

Method REMOVE_WORKER_SESSION on class CL_ICWC_SESSION_REGISTRY has no parameter.
Method REMOVE_WORKER_SESSION on class CL_ICWC_SESSION_REGISTRY has no exception.

Method SET_SESSION_SYNC_ID Signature

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

Method SET_SESSION_SYNC_ID on class CL_ICWC_SESSION_REGISTRY has no exception.

Method START_AGENT_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DATA	Value transfer	☐	Type reference (TYPE)	XSTRING			20040217
2	Importing	RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	CL_BSP_RUNTIME		Business Server Pages (BSP) Runtime	20040223

Method START_AGENT_SESSION on class CL_ICWC_SESSION_REGISTRY has no exception.

Method START_WORKER_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DATA	Value transfer	☐	Type reference (TYPE)	XSTRING			20040318
2	Importing	RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	CL_BSP_RUNTIME		Business Server Pages (BSP) Runtime	20040318

Method START_WORKER_SESSION on class CL_ICWC_SESSION_REGISTRY has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	400