SAP ABAP Class CL_XMS_EPCACHE (XI: Runtime Cache for Exchange Profile)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-XI-IS-WKB (Application Component) Runtime Workbench/Monitoring
     ⤷ SXMS_PF_AGG (Package) Aggregator for Performance Data

Properties

Class	CL_XMS_EPCACHE
Short Description	XI: Runtime Cache for Exchange Profile
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SXMS_PF_AGG	Aggregator for Performance Data
Created	20060110	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_XMS_EPCACHE has no forward declaration.

Interfaces

Class CL_XMS_EPCACHE has no interface implemented.

Friends

Class CL_XMS_EPCACHE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CACHE_ADMIN	Instance attribute	Private	☐	Type reference (TYPE)	SXMSEPCACHE		Administration Entry	20060110
2	CO_EP_SECTION_ADMIN	Instance attribute	Private	☐	Type reference (TYPE)	SXMSEPCACHE-EP_SECTION	'$CACHE_ADMIN'	Section for Administration Entries	20060110
3	CO_FALSE	Instance attribute	Private	☐	Type reference (TYPE)	SXMSFLAG	'0'	False	20060110
4	CO_LOG_CREATE_PARAM	Instance attribute	Private	☐	Type reference (TYPE)	CHAR255	'CREATE PARAM'	Log: Generate Parameter	20060110
5	CO_LOG_DEQUEUE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR255	'UNLOCK'	Log: Generate Parameter	20060110
6	CO_LOG_ENQUEUE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR255	'LOCK'	Log: Generate Parameter	20060110
7	CO_LOG_INIT	Instance attribute	Private	☐	Type reference (TYPE)	CHAR255	'INIT'	Log: Generate Parameter	20060110
8	CO_LOG_NOTIFY	Instance attribute	Private	☐	Type reference (TYPE)	CHAR255	'NOTIFY'	Log: Parameter not found	20060110
9	CO_LOG_NOTIFY_SINGLE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR255	'NOTIFY SINGLE'	Log: Parameter not found	20060110
10	CO_LOG_PARAM_EXPIRED	Instance attribute	Private	☐	Type reference (TYPE)	CHAR255	'PARAM EXPIRED'	Log: Parameter not found	20060110
11	CO_LOG_PARAM_NOT_FOUND	Instance attribute	Private	☐	Type reference (TYPE)	CHAR255	'PARAM NOT FOUND'	Log: Parameter not found	20060110
12	CO_LOG_REFRESH	Instance attribute	Private	☐	Type reference (TYPE)	CHAR255	'REFRESH'	Log: Parameter not found	20060110
13	CO_LOG_REFRESH_SINGLE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR255	'REFRESH SINGLE'	Log: Parameter not found	20060110
14	CO_LOG_REORG	Instance attribute	Private	☐	Type reference (TYPE)	CHAR255	'REORG'	Log: Parameter not found	20060110
15	CO_LOG_UPGRADE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR255	'UPGRADE'	Log: Parameter not found	20060110
16	CO_LOG_UPGRADE_SINGLE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR255	'UPGRADE SINGLE'	Log: Parameter not found	20060110
17	CO_TRUE	Instance attribute	Private	☐	Type reference (TYPE)	SXMSFLAG	'1'	True	20060110
18	CO_TYPE_BEGIN	Instance attribute	Private	☐	Type reference (TYPE)	SXMSTSTYPE	'B'	SXMS: Time Stamp Type	20060110
19	CO_TYPE_END	Instance attribute	Private	☐	Type reference (TYPE)	SXMSTSTYPE	'E'	SXMS: Time Stamp Type	20060110
20	CO_TYPE_FAILED	Instance attribute	Private	☐	Type reference (TYPE)	SXMSTSTYPE	'F'	SXMS: Time Stamp Type	20060110
21	CO_VALIDITY_EXTENSION	Instance attribute	Private	☐	Type reference (TYPE)	INT4	15	Extension of Validity in Event of Error [Minutes]	20060110
22	CO_VALIDITY_PERIOD	Instance attribute	Private	☐	Type reference (TYPE)	INT4	90	Validity Duration [Minutes]	20060110
23	CO_VERSION_MAJOR	Instance attribute	Private	☐	Type reference (TYPE)	SXMSEPCACHE-MAJOR	'XI7.11'	Version	20060110
24	CO_VERSION_MINOR	Instance attribute	Private	☐	Type reference (TYPE)	SXMSEPCACHE-MINOR	'0001'	Version	20060110
25	ID	Instance attribute	Private	☐	Type reference (TYPE)	SXMSGUID		ID for Log Entries	20060110
26	LINE	Instance attribute	Private	☐	Type reference (TYPE)	INT4		Line Number for Log	20060110
27	LOGLEVEL	Instance attribute	Private	☐	Type reference (TYPE)	SXMSLOGLEV	1	Log Level	20060110
28	LOGTAB	Instance attribute	Private	☐	Type reference (TYPE)	SXMSEPCLOGTAB		Buffer for Log	20060110

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_VERSION	Instance method	Private	Method	Checks Version of Cache	20060110
2	CLOG	Instance method	Private	Method	Write Log Entries	20060110
3	CONSTRUCTOR	Instance method	Public	Constructor	Initialization	20060110
4	GET_PARAMETER	Instance method	Public	Method	Gets Value of Parameter	20060110
5	HANDLE_EXPIRY	Instance method	Private	Method	Handling of Invalid Entry	20060110
6	LOCK	Instance method	Private	Method	Lock One or All Entries of a Client	20060110
7	NOTIFY	Instance method	Private	Method	Invalidate Cache Content of all ApplServs for Current Client	20060110
8	REFRESH	Instance method	Private	Method	Refresh Cache Content	20060110
9	REORG	Instance method	Private	Method	Reorganization of Log	20060110
10	SYSLOG	Instance method	Private	Method	Write Syslog Entry	20060110
11	UNLOCK	Instance method	Private	Method	Unlock One or All Entries of a Client	20060110
12	UPGRADE	Instance method	Private	Method	Hidden Upgrade of Cache Content	20060110
13	WAIT	Instance method	Private	Method	Wait	20060110
14	_LOCK	Instance method	Private	Method	Execute Lock Request	20060110
15	_LOG	Instance method	Private	Method	Write Log Entry	20060110
16	_REFRESH	Instance method	Private	Method	Refresh an Invalid Entry	20060110
17	_UPGRADE	Instance method	Private	Method	Hidden Upgrade of Cache Entry	20060110

Events

Class CL_XMS_EPCACHE has no event.

Types

Class CL_XMS_EPCACHE has no local type.

Method Signatures

Method CHECK_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EX_VERSION_OK	Value transfer	☐	Type reference (TYPE)	SXMSFLAG		0: version mismatch 1: OK	20060110

Method CHECK_VERSION on class CL_XMS_EPCACHE has no exception.

Method CLOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FLUSH	Call by reference	☐	Type reference (TYPE)	SXMSFLAG	'0'	0: no flush 1:flush	20060110
2	Importing	IM_NAME	Call by reference	☑	Type reference (TYPE)	SXMSEPCACHE-EP_NAME		char255	20060110
3	Importing	IM_SECTION	Call by reference	☑	Type reference (TYPE)	SXMSEPCACHE-EP_SECTION		char255	20060110
4	Importing	IM_TYPE	Call by reference	☑	Type reference (TYPE)	SXMSTSTYPE		SXMS: Typ eines Timestamps	20060110
5	Importing	TEXT	Call by reference	☑	Type reference (TYPE)	SXMSEPCLOG-TEXT		Logeintrag	20060110

Method CLOG on class CL_XMS_EPCACHE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_LOGLEVEL	Call by reference	☐	Type reference (TYPE)	SXMSLOGLEV	'1'	XI: Logging Level	20060110

#	Exception	Resumable	Description	Created on
1	CX_XMS_LOCK_ERROR	☐		20060110

Method GET_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_VALUE	Call by reference	☐	Type reference (TYPE)	SXMSEPCACHE-EP_VALUE		Wert des Parameters	20060110
2	Exporting	EX_WAS_CACHED	Call by reference	☐	Type reference (TYPE)	SXMSFLAG		0: Exchange Profile 1: Cache	20060110
3	Importing	IM_NAME	Call by reference	☐	Type reference (TYPE)	SXMSEPCACHE-EP_NAME		NameName des Parameters	20060110
4	Importing	IM_SECTION	Call by reference	☐	Type reference (TYPE)	SXMSEPCACHE-EP_SECTION		Section im Exchange Profile	20060110

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSERR_ENGINE	☐	XI: Systemfehler der Integration-Engine	20060110

Method HANDLE_EXPIRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_PARAM	Call by reference	☐	Type reference (TYPE)	SXMSEPCACHE		zu behandelnder Parameter	20060110
2	Exporting	EX_WAS_CACHED	Call by reference	☐	Type reference (TYPE)	SXMSFLAG		0: Exchange Profile 1: Cache	20060110
3	Importing	IM_NOW	Call by reference	☐	Type reference (TYPE)	TIMESTAMP		augenblickliche Zeit	20060110

Method HANDLE_EXPIRY on class CL_XMS_EPCACHE has no exception.

Method LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_WAIT	Call by reference	☐	Type reference (TYPE)	SXMSFLAG	'0'	0: kein Warten 1: exponentielles Warten	20060110

#	Exception	Resumable	Description	Created on
1	CX_XMS_LOCK_ERROR	☐		20060110

Method NOTIFY Signature

Method NOTIFY on class CL_XMS_EPCACHE has no parameter.
Method NOTIFY on class CL_XMS_EPCACHE has no exception.

Method REFRESH Signature

Method REFRESH on class CL_XMS_EPCACHE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSERR_ENGINE	☐	XI: Systemfehler der Integration-Engine	20060110

Method REORG Signature

Method REORG on class CL_XMS_EPCACHE has no parameter.
Method REORG on class CL_XMS_EPCACHE has no exception.

Method SYSLOG Signature

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

Method SYSLOG on class CL_XMS_EPCACHE has no exception.

Method UNLOCK Signature

Method UNLOCK on class CL_XMS_EPCACHE has no parameter.
Method UNLOCK on class CL_XMS_EPCACHE has no exception.

Method UPGRADE Signature

Method UPGRADE on class CL_XMS_EPCACHE has no parameter.
Method UPGRADE on class CL_XMS_EPCACHE has no exception.

Method WAIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	WAIT_MILLISECONDS	Call by reference	☐	Type reference (TYPE)	INT4		Natürliche Zahl	20060110

Method WAIT on class CL_XMS_EPCACHE has no exception.

Method _LOCK Signature

Method _LOCK on class CL_XMS_EPCACHE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_XMS_LOCK_ERROR	☐		20060110

Method _LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FLUSH	Call by reference	☐	Type reference (TYPE)	SXMSFLAG	'0'	0: no flush 1:flush	20060110
2	Importing	TEXT	Call by reference	☐	Type reference (TYPE)	SXMSEPCLOG-TEXT		Logeintrag	20060110

Method _LOG on class CL_XMS_EPCACHE has no exception.

Method _REFRESH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_CACHE_ITEM	Call by reference	☐	Type reference (TYPE)	SXMSEPCACHE		SXMSEPCACHE	20060110

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSERR_ENGINE	☐	XI: Systemfehler der Integration-Engine	20060110

Method _UPGRADE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_CACHE_ITEM	Call by reference	☐	Type reference (TYPE)	SXMSEPCACHE		zu behandelnder Eintrag	20060110

Method _UPGRADE on class CL_XMS_EPCACHE has no exception.

History

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