SAP ABAP Class CL_XI_ALERT_POOL_MANAGER (Manages the pool with alerts)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-XI-IS-WKB (Application Component) Runtime Workbench/Monitoring
     ⤷ SXMSALERT (Package) XI Alert Framework

Properties

Class	CL_XI_ALERT_POOL_MANAGER
Short Description	Manages the pool with alerts
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SXMSALERT	XI Alert Framework
Created	20101110	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	TMATP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_XI_ALERT_POOL_MANAGER has no interface implemented.

Friends

Class CL_XI_ALERT_POOL_MANAGER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MC_MAX_CHUNK_SIZE	Constant	Private	☐	Type reference (TYPE)	INT4	5000	Natural number	20110308
2	MC_MAX_POOL_SIZE	Constant	Private	☐	Type reference (TYPE)	INT4	1000000	Natural number	20101126
3	MS_ALERT_ITEM	Instance attribute	Private	☐	Type reference (TYPE)	SXMSALERTINFO		Alert data in an internal format	20101122
4	MS_SRV_ALERT	Instance attribute	Private	☐	Type reference (TYPE)	SXMSALERTCONTENT		PI Alerting: Alert Information	20110117
5	MT_ALERT_JSON	Instance attribute	Private	☐	Type reference (TYPE)	SXMSALERTINFO_JSON_T		Table type for external alert format - JSON	20101126
6	MT_KEYTAB	Instance attribute	Private	☐	Type reference (TYPE)	SXMSALERTCONTENT_T		Table type for the IDX table containing JSON alerts	20101124
7	MT_SRV_ALERTTAB	Instance attribute	Private	☐	Type reference (TYPE)	SXMSALERTCONTENT_T		Table type for the IDX table containing JSON alerts	20110117
8	MV_ALERT_JSON	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20101126
9	MV_MAX_POOL_SIZE	Instance attribute	Private	☐	Type reference (TYPE)	INT4		Natural number	20101126

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ALERTS	Instance method	Public	Method	For adding alert data to the alert pool	20101110
2	CLEAR_POOL_ALL_CONSUMERS	Instance method	Public	Method	Clears the pool for all the consumers	20101126
3	CONSTRUCTOR	Instance method	Public	Constructor	Initialize POOL size	20101126
4	GET_ALERTS	Instance method	Public	Method	For reading alert info from the pool + delete read entries	20101110
5	GET_ALERTS_AGGREGATED	Instance method	Public	Method	Getting aggregated alerts from the pool + delete	20110413
6	GET_DEFAULT_CHUNK_SIZE	Instance method	Public	Method	Returns the default chunk size	20110406
7	IMPORT_ENTRY_FROM_POOL	Instance method	Public	Method	Import JSON alert from shared media/cluster DB	20110413
8	READ_ALERTS	Instance method	Public	Method	For reading alert info from the pool w/o deletion	20101110
9	_ANALYZE_POOL	Instance method	Private	Method	Analyzes the existing alerts per alert rule && type	20110117
10	_AUTHORITY_CHECK	Instance method	Private	Method	Checks read + delete authority	20110413
11	_CLEAR_POOL	Instance method	Private	Method	Delete ALL alerts from shared media/cluster DB	20101110
12	_DELETE_FROM_POOL	Instance method	Private	Method	Delete given alert from shared media/cluster DB	20101110
13	_EXPORT_TO_POOL	Instance method	Private	Method	Export JSON alert to shared media/cluster DB	20101110
14	_GET_KEYS_4_CONSUMER	Instance method	Private	Method	Reads the alert IDs into attr MT_KEYTAB	20101124
15	_IMPORT_FROM_POOL	Instance method	Private	Method	Import JSON alerts table from shared media/cluster DB	20101110
16	_IS_POOL_OVERFLOWN	Instance method	Private	Method	Invoked each time an alert is added to check size>conf size	20101124
17	_SERIALIZE_IN_JSON	Instance method	Private	Method	Serializer for alert records in JSON format	20101110

Events

Class CL_XI_ALERT_POOL_MANAGER has no event.

Types

Class CL_XI_ALERT_POOL_MANAGER has no local type.

Method Signatures

Method ADD_ALERTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PI_ALERTS_TABLE	Call by reference	☐	Type reference (TYPE)	SXMSALERTINFO_T		Table type for the consumer alerts pool	20101122

Method ADD_ALERTS on class CL_XI_ALERT_POOL_MANAGER has no exception.

Method CLEAR_POOL_ALL_CONSUMERS Signature

Method CLEAR_POOL_ALL_CONSUMERS on class CL_XI_ALERT_POOL_MANAGER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SXMSALERT_EXPROF_ERR	☐	Utilities for Alerting	20110413

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PI_MAX_POOL_SIZE	Call by reference	☑	Type reference (TYPE)	INT4		Natural number	20101126

Method CONSTRUCTOR on class CL_XI_ALERT_POOL_MANAGER has no exception.

Method GET_ALERTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	PE_ALERTS_TABLE_JSON	Call by reference	☐	Type reference (TYPE)	SXMSALERTINFO_JSON_T		Table type for external alert format - JSON	20101126
2	Importing	PI_CONSUMER	Call by reference	☐	Type reference (TYPE)	SXMSALERTCONSUMER		PI: Consumer of a PI Alert	20101124
3	Importing	PI_MAX_CHUNK_SIZE	Call by reference	☑	Type reference (TYPE)	INT4		Natural number	20110308

#	Exception	Resumable	Description	Created on
1	CX_SXMSALERT_EXPROF_ERR	☐	Utilities for Alerting	20110331

Method GET_ALERTS_AGGREGATED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	PE_AGGR_ALERTS	Call by reference	☐	Type reference (TYPE)	SXMSALERTINFO_AGGR_T		Table type for external alert format - JSON	20110413
2	Importing	PI_CONSUMER	Call by reference	☐	Type reference (TYPE)	SXMSALERTCONSUMER		PI: Consumer of a PI Alert	20110413
3	Importing	PI_MAX_CHUNK_SIZE	Call by reference	☑	Type reference (TYPE)	INT4		Natural number	20110413
4	Importing	PI_MAX_NUM_PAYLOAD	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20110413

#	Exception	Resumable	Description	Created on
1	CX_SXMSALERT_EXPROF_ERR	☐	Utilities for Alerting	20110413

Method GET_DEFAULT_CHUNK_SIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PR_CHUNK_SIZE	Value transfer	☐	Type reference (TYPE)	INT4		Natural number	20110406

Method GET_DEFAULT_CHUNK_SIZE on class CL_XI_ALERT_POOL_MANAGER has no exception.

Method IMPORT_ENTRY_FROM_POOL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PI_ALERT_HEADER	Call by reference	☐	Type reference (TYPE)	SXMSALERTCONTENT		PI Alerting: Alert Information	20110413
2	Returning	PR_JSON_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20110413

Method IMPORT_ENTRY_FROM_POOL on class CL_XI_ALERT_POOL_MANAGER has no exception.

Method READ_ALERTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	PE_ALERTS_TABLE_JSON	Call by reference	☐	Type reference (TYPE)	SXMSALERTINFO_JSON_T		Table type for external alert format - JSON	20101126
2	Importing	PI_CONSUMER	Call by reference	☐	Type reference (TYPE)	SXMSALERTCONSUMER		PI: Consumer of a PI Alert	20101124
3	Importing	PI_MAX_CHUNK_SIZE	Call by reference	☑	Type reference (TYPE)	INT4		Natural number	20110308

#	Exception	Resumable	Description	Created on
1	CX_SXMSALERT_EXPROF_ERR	☐	Utilities for Alerting	20110331

Method _ANALYZE_POOL Signature

Method _ANALYZE_POOL on class CL_XI_ALERT_POOL_MANAGER has no parameter.
Method _ANALYZE_POOL on class CL_XI_ALERT_POOL_MANAGER has no exception.

Method _AUTHORITY_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PI_CONSUMER	Call by reference	☐	Type reference (TYPE)	SXMSALERTCONSUMER		PI: Consumer of a PI Alert	20110413

#	Exception	Resumable	Description	Created on
1	CX_SXMSALERT_EXPROF_ERR	☐	Utilities for Alerting	20110413

Method _CLEAR_POOL Signature

Method _CLEAR_POOL on class CL_XI_ALERT_POOL_MANAGER has no parameter.
Method _CLEAR_POOL on class CL_XI_ALERT_POOL_MANAGER has no exception.

Method _DELETE_FROM_POOL Signature

Method _DELETE_FROM_POOL on class CL_XI_ALERT_POOL_MANAGER has no parameter.
Method _DELETE_FROM_POOL on class CL_XI_ALERT_POOL_MANAGER has no exception.

Method _EXPORT_TO_POOL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PI_ALERT_TYPE	Call by reference	☐	Type reference (TYPE)	SXMSALERTTYPE		PI Alerting: Type of alert: Business or Service	20110117

Method _EXPORT_TO_POOL on class CL_XI_ALERT_POOL_MANAGER has no exception.

Method _GET_KEYS_4_CONSUMER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PI_CONSUMER	Call by reference	☐	Type reference (TYPE)	SXMSALERTCONSUMER		PI: Consumer of a PI Alert	20101124
2	Importing	PI_MAX_CHUNK_SIZE	Call by reference	☑	Type reference (TYPE)	INT4		Natural number	20110308

Method _GET_KEYS_4_CONSUMER on class CL_XI_ALERT_POOL_MANAGER has no exception.

Method _IMPORT_FROM_POOL Signature

Method _IMPORT_FROM_POOL on class CL_XI_ALERT_POOL_MANAGER has no parameter.
Method _IMPORT_FROM_POOL on class CL_XI_ALERT_POOL_MANAGER has no exception.

Method _IS_POOL_OVERFLOWN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PR_IS_OVERFLOWN	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20101124

Method _IS_POOL_OVERFLOWN on class CL_XI_ALERT_POOL_MANAGER has no exception.

Method _SERIALIZE_IN_JSON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PI_ALERT_TYPE	Call by reference	☐	Type reference (TYPE)	SXMSALERTTYPE		PI Alerting: Type of alert: Business or Service	20110117

Method _SERIALIZE_IN_JSON on class CL_XI_ALERT_POOL_MANAGER has no exception.

History

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