SAP ABAP Class CL_SWF_CNT_FACTORY_SHMEM (Container Factory in Shared Memory: Access Class)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-BMT-WFM (Application Component) SAP Business Workflow
     ⤷ SWF_CNT (Package) Workflow: Container

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SWF_RUN_WIM_REMOTE_SERVICE	Workflow: Remote-Services for WIM	20041029

Properties

Class	CL_SWF_CNT_FACTORY_SHMEM
Short Description	Container Factory in Shared Memory: Access Class
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SWF_CNT	Workflow: Container
Created	20041005	SAP
Last change	20110908	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	SWFCN	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	T	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SWF_RUN_WIM_REMOTE_SERVICE	☐	☐	Workflow: Remote-Services for WIM	20041029

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SWF_CNT_FACTORY	☐	20041112	Factory for Creating a Container
2	CL_SWF_CNT_TEST_FACTORY_SHMEM	☐	20050317	ABAP Unit Test

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_ATTACH_FAILED	Constant	Private	☐	Type reference (TYPE)	I	5	Return Code	20050317
2	CO_COMMIT_EXT_TYPE	Constant	Private	☐	Type reference (TYPE)	I	4	Close_Area Returncode	20050317
3	CO_COMMIT_FAILED	Constant	Private	☐	Type reference (TYPE)	I	2	Close_Area Returncode	20050317
4	CO_ROLLBACK_FAILED	Constant	Private	☐	Type reference (TYPE)	I	3	Close_Area Returncode	20050317
5	CO_SHM_OUT_OF_MEM	Constant	Private	☐	Type reference (TYPE)	I	6	Return Code	20051122
6	CO_TYPE_UNSUPPORTED	Constant	Private	☐	Type reference (TYPE)	I	1	Buffer_Instance Returncode	20050317
7	MC_AREA_INSTANCE_NAME	Constant	Public	☐	Type reference (TYPE)	SHM_INST_NAME	'CL_SWF_CNT_FACTORY_SHMEM_AREA'	Name of Default Area	20041022
8	MC_BUFFER_LOCAL	Constant	Public	☐	Type reference (TYPE)	CHAR1	'L'	Flag Buffer Type - Local	20041005
9	MC_BUFFER_SHARED	Constant	Public	☐	Type reference (TYPE)	CHAR1	'S'	Flag Buffer Type - Shared	20041005
10	M_BUFFER_METHOD	Static Attribute	Private	☐	Type reference (TYPE)	CHAR1	MC_BUFFER_LOCAL	Buffer Type: 'S' - Shared Memory / 'L' - Local	20041005
11	M_REMOTE_PARAM	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SWF_CNT_CONTAINER		Container for Parameters in Remote Call	20041029

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_INSTANCE	Static method	Protected	Method	Buffer Miss: Flag Instance for Buffer Update	20041005
2	BUFFER_INSTANCE	Static method	Private	Method	Copy Single Container Instance to Buffer	20050317
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20041124
4	CLEAR_BUFFER	Instance method	Public	Method	Local Buffer Invalidation on Appserver	20041007
5	CLEAR_BUFFER_GLOBAL	Static method	Public	Method	Invalidate Shared Memory Buffer System-Wide	20041019
6	CLEAR_BUFFER_VIA_REMOTE	Instance method	Public	Method	Local Buffer Invalidation on Appserver	20100422
7	CLOSE_AREA	Static method	Private	Method	Close Shared Memory Area	20050317
8	GET_BUFFER_METHOD	Static method	Public	Method	Query Buffer Method	20041005
9	GET_INSTANCE	Static method	Protected	Method	Buffer Lookup: Get Instance from Buffer when Available	20041005
10	OPEN_AREA	Static method	Private	Method	Initialize Shared Memory Area	20050317
11	SET_BUFFER_METHOD	Static method	Public	Method	Define Buffer Method	20041005
12	UPDATE_BUFFER	Instance method	Public	Method	Local Buffer Update on Appserver	20041007
13	UPDATE_BUFFER_GLOBAL	Static method	Public	Method	Update Shared Memory Buffer System-Wide	20041019
14	UPDATE_BUFFER_VIA_REMOTE	Instance method	Public	Method	Local Buffer Update on Appserver	20100422
15	UPDATE_JOB_SCHEDULE	Static method	Public	Method	Scheduling Batch Job for Automated Area Update	20070109

Events

Class CL_SWF_CNT_FACTORY_SHMEM has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	INSTANCE_TAB	Private	See coding			20041116	INSTANCE_TAB type standard table of swfcntbuf with non-unique default key

Method Signatures

Method ADD_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IBF_POR	Call by reference	☐	Type reference (TYPE)	SIBFLPOR		Spezieller Schlüssel im SIBFLPOR-Format	20041005
2	Importing	INSTANCE	Call by reference	☐	Object reference (TYPE REF TO)	IF_SWF_CNT_CONTAINER		Referenz auf Objekt, das das Containerinterface erfüllt	20041005
3	Returning	RETCODE	Value transfer	☐	Type reference (TYPE)	INT4		0 - Registrierung erfolgreich	20041005

Method ADD_INSTANCE on class CL_SWF_CNT_FACTORY_SHMEM has no exception.

Method BUFFER_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DEFEXT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SWF_CNT_CONTAINER		Container - Implementierung einer 'Collection'	20050317
2	Importing	IM_REGKEY	Call by reference	☐	Type reference (TYPE)	SWFCNTRKEY		Schlüsselstruktur für Container Instanzverwaltung	20050317
3	Importing	IM_ROOT	Call by reference	☐	Object reference (TYPE REF TO)	CL_SWF_CNT_FACTORY_SHMEM_ROOT		Containerfactory im Shared Memory: Rootobject	20050317
4	Returning	RE_RETCODE	Value transfer	☐	Type reference (TYPE)	I		Returncode	20050317

Method BUFFER_INSTANCE on class CL_SWF_CNT_FACTORY_SHMEM has no exception.

Method CLASS_CONSTRUCTOR Signature

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

Method CLEAR_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_RETCODE	Value transfer	☐	Type reference (TYPE)	I			20041111

Method CLEAR_BUFFER on class CL_SWF_CNT_FACTORY_SHMEM has no exception.

Method CLEAR_BUFFER_GLOBAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DEBUG	Value transfer	☑	Type reference (TYPE)	XFELD	SPACE	'X' - Debugging des Remoteaufrufs	20041116

Method CLEAR_BUFFER_GLOBAL on class CL_SWF_CNT_FACTORY_SHMEM has no exception.

Method CLEAR_BUFFER_VIA_REMOTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_RETCODE	Call by reference	☐	Type reference (TYPE)	I			20100422
2	Exporting	EX_XML_SIZE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Index interner Tabellen	20100422
3	Exporting	EX_XML_TABLE	Call by reference	☐	Type reference (TYPE)	SWF_XMLCNT		Container als XML-Strom fixer Breite	20100422

Method CLEAR_BUFFER_VIA_REMOTE on class CL_SWF_CNT_FACTORY_SHMEM has no exception.

Method CLOSE_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_AREA	Value transfer	☐	Object reference (TYPE REF TO)	CL_SWF_CNT_FACTORY_SHMEM_AREA		Containerfactory im Shared Memory: Gebietsklasse	20050317
2	Importing	IM_ROLLBACK	Value transfer	☐	Type reference (TYPE)	XFLAG		neue Eingabewerte	20050317
3	Returning	RE_RETCODE	Value transfer	☐	Type reference (TYPE)	I		Returncode	20050317

Method CLOSE_AREA on class CL_SWF_CNT_FACTORY_SHMEM has no exception.

Method GET_BUFFER_METHOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_BUFFER_METHOD	Value transfer	☐	Type reference (TYPE)	CHAR1		Pufferungsmethode	20041005

Method GET_BUFFER_METHOD on class CL_SWF_CNT_FACTORY_SHMEM has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IBF_POR	Call by reference	☐	Type reference (TYPE)	SIBFLPOR		Spezieller Schlüssel im SIBFLPOR-Format	20041005
2	Returning	INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	IF_SWF_CNT_CONTAINER		Referenz auf Container, falls vorhanden	20041005

Method GET_INSTANCE on class CL_SWF_CNT_FACTORY_SHMEM has no exception.

Method OPEN_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_AREA	Value transfer	☐	Object reference (TYPE REF TO)	CL_SWF_CNT_FACTORY_SHMEM_AREA		Containerfactory im Shared Memory: Gebietsklasse	20060302
2	Exporting	EX_RETCODE	Call by reference	☐	Type reference (TYPE)	I		Returncode	20060302
3	Importing	IM_AREAINST	Call by reference	☐	Type reference (TYPE)	SHM_INST_NAME	MC_AREA_INSTANCE_NAME	Name einer Shared Object Instanz eines Areas	20050317
4	Importing	IM_UPDATE	Call by reference	☐	Type reference (TYPE)	XFLAG	'X'	'X' - Aktualisieren der Shared Memory Instanz	20050317

Method OPEN_AREA on class CL_SWF_CNT_FACTORY_SHMEM has no exception.

Method SET_BUFFER_METHOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BUFFER_METHOD	Value transfer	☐	Type reference (TYPE)	CHAR1		Pufferungsart	20041005

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Falsche Pufferungsart angegeben (erlaubt: 'S' , 'L')	20041005

Method UPDATE_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_RETCODE	Value transfer	☐	Type reference (TYPE)	I		Returncode	20041029

Method UPDATE_BUFFER on class CL_SWF_CNT_FACTORY_SHMEM has no exception.

Method UPDATE_BUFFER_GLOBAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DEBUG	Value transfer	☑	Type reference (TYPE)	XFELD	SPACE	'X' - Debugging des Remoteaufrufs	20041116

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Auffrischen des Shared Object Buffers fehlgeschlagen	20041019

Method UPDATE_BUFFER_VIA_REMOTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_RETCODE	Call by reference	☐	Type reference (TYPE)	I			20100422
2	Exporting	EX_XML_SIZE	Call by reference	☐	Type reference (TYPE)	SYTABIX			20100422
3	Exporting	EX_XML_TABLE	Call by reference	☐	Type reference (TYPE)	SWF_XMLCNT			20100422

Method UPDATE_BUFFER_VIA_REMOTE on class CL_SWF_CNT_FACTORY_SHMEM has no exception.

Method UPDATE_JOB_SCHEDULE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_SHMEM_ENABLED	Call by reference	☐	Type reference (TYPE)	SWF_CNTUSESHMEM		Kennzeichen: Containerpufferung mit Shared Objects	20070109

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Scheduling of update task failed	20070109

History

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