SAP ABAP Class CL_ESH_CO_LOGGING (Logging)

Hierarchy

☛

SAP_BASIS (Software Component) SAP Basis Component
⤷

BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷

S_ESH_ENG_COMMON (Package) Common

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ESH_OM_APPLOG	Application Log	20070322

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_ESH_TST_HIL_LOG_HIERARCHY	Hierarchical Logging	20100218

Properties

Class	CL_ESH_CO_LOGGING
Short Description	Logging
Super Class
Instantiability of a Class	1	Protected
Final

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_COMMON	Common
Created	20070322	SAP
Last change	20140121	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	IF_ESH_OM_APPLOG	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ESH_OM_APPLOG			Application Log	20070322

Friends

Class CL_ESH_CO_LOGGING has no friend class.

Attributes

#	Attribute	Level	Visibility	Typing	Associated Type	Initial Value	Description	Created on
1	MS_APPLICATION_LOG	Instance attribute	Protected	Type reference (TYPE)	ESH_S_CO_APPLICATION_LOG_SORT		Application log	20070323
2	MS_APPLICATION_LOG_META	Instance attribute	Protected	Type reference (TYPE)	BAL_S_LOG		Application log: Log header data	20070323
3	MT_SAVE_POINTER	Instance attribute	Private	Type reference (TYPE)	LTT_SAVE_POINTER		Pointer to last log entries saved	20070323
4	MV_APPLICATION_LOG_HANDLE	Instance attribute	Protected	Type reference (TYPE)	BALLOGHNDL		Application log: Log handle	20070323
5	MV_DIFFERENTIATORS_ACTIVE	Instance attribute	Protected	Type reference (TYPE)	ABAP_BOOL	abap_true	Differentiators active	20130704
6	SC_HEADER_ENTRY_MSGID	Constant	Protected	Type reference (TYPE)	SYST-MSGID	'ESH_CO_COMMON'	ABAP System Field: Message ID	20130704
7	SC_MAX_LOG_ENQ_COUNTER	Constant	Public	Type reference (TYPE)	I	10	Maximum number of attempts to get a log enqueue	20070326

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_SY_MSG_TO_BAPIRETTAB	Static method	Public	Method	Add sy-messages to BAPIRETTAB messages	20100810
2	ADD_TYPE_ENTRIES_TO_MSG_LIST	Static method	Public	Method	Add headline per message type block	20130628
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20070323
4	FILL_BAPIRET_MESSAGE_TEXTS	Static method	Public	Method	Fill message texts in BAPIRET table	20090224
5	GET_APPLICATION_LOG_HANDLE	Instance method	Protected	Method	Provide reference to corresponding application log line	20070323
6	GET_CONTEXT_AND_PARAMETERS	Instance method	Protected	Method	Add a new message to the message log	20070328
7	GET_DIFFERENTIATOR_HASH	Instance method	Protected	Method	Get hash code for differentiator	20070412
8	GET_INSTANCE	Static method	Public	Method	Provide an instance for application logging	20070323
9	GET_IS_TOPIC_ENTRY	Static method	Public	Method	Is topic entry (message block header)	20130704
10	GET_IS_TYPE_ENTRY	Static method	Public	Method	Is type entry (message block header)	20130701
11	GET_NORMALIZED_MESSAGE_TYPE	Instance method	Protected	Method	Normalize message type	20070327
12	GET_REF_TO_APP_LOG_LINE	Instance method	Protected	Method	Provide reference to corresponding application log line	20070323
13	GET_TIMESTAMP	Instance method	Protected	Method	Normalize message type	20070323
14	GET_TYPE_ENTRY_DETAILS	Static method	Public	Method	Get details of type entry	20130701
15	INCREMENT_MESSAGE_COUNT	Instance method	Protected	Method	Increment message counter	20070323
16	MESSAGE_PREFIX_BY_MESSAGE_TYPE	Static method	Public	Method	Message prefix by message type	20090305
17	RESOLVE_EXCEPTION_MESSAGE_ATTR	Static method	Protected	Method	Resolve message variables with exception attributes	20090925
18	SAVE_LOG_MESSAGES	Instance method	Protected	Method	Save log messages and update save pointer	20070326
19	TEXT_MESSAGE_CONVERT_TO_SYMSG	Static method	Public	Method	Convert a text message (string) to sy-message	20080606

Events

Class CL_ESH_CO_LOGGING has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LST_SAVE_POINTER	Private	See coding			20070323	`BEGIN OF lst_save_pointer, differentiator TYPE char40, last_saved TYPE i, END OF lst_save_pointer`
2	LTT_SAVE_POINTER	Private	See coding			20070323	`ltt_save_pointer TYPE SORTED TABLE OF lst_save_pointer WITH UNIQUE KEY differentiator`

Method Signatures

Method ADD_SY_MSG_TO_BAPIRETTAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGES	Call by reference		Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20100810
2	Importing	IS_MESSAGE	Value transfer		Type reference (TYPE)	BAPIRET2		Return Parameter	20100810

Method ADD_SY_MSG_TO_BAPIRETTAB on class CL_ESH_CO_LOGGING has no exception.

Method ADD_TYPE_ENTRIES_TO_MSG_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_MESSAGES	Call by reference		Type reference (TYPE)	DATA			20130628

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE		Common ESH Engine Exception	20130628
2	CX_ESH_CO_INVALID_PARAMETER		Invalid Parameter	20130628

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_APPLICATION_LOG_HANDLE	Call by reference	Type reference (TYPE)	BALLOGHNDL	Application Log: Log Handle	20070626
2	Importing	IV_APPLICATION_LOG_OBJECT	Call by reference	Type reference (TYPE)	BALOBJ_D	Application log: Object name (Application code)	20070323
3	Importing	IV_APPLICATION_LOG_SUBOBJECT	Call by reference	Type reference (TYPE)	BALSUBOBJ	Application Log: Subobject	20070323

Method CONSTRUCTOR on class CL_ESH_CO_LOGGING has no exception.

Method FILL_BAPIRET_MESSAGE_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_BAPIRETTAB	Call by reference		Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20090224
2	Importing	IV_OVERWRITE_EXISTING_TEXT	Call by reference		Type reference (TYPE)	ABAP_BOOL		Overwrite existing message texts	20090224

Method FILL_BAPIRET_MESSAGE_TEXTS on class CL_ESH_CO_LOGGING has no exception.

Method GET_APPLICATION_LOG_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION_LOG_SUBOBJECT	Call by reference		Type reference (TYPE)	BALSUBOBJ		Application log	20070323
2	Returning	RV_APPLICATION_LOG_HANDLE	Value transfer		Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070323

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_INVALID_PARAMETER		Invalid paramter	20070323

Method GET_CONTEXT_AND_PARAMETERS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Changing	CS_MESSAGE	Call by reference	Type reference (TYPE)	BAL_S_MSG		20070328
2	Importing	IS_TABLE_LINE	Call by reference	Type reference (TYPE)	ANY		20070328
3	Importing	IV_DIFFERENTIATOR	Call by reference	Type reference (TYPE)	ANY		20070328
4	Importing	IV_FIELD10_VALUE	Call by reference	Type reference (TYPE)	ANY		20070328
5	Importing	IV_FIELD11_VALUE	Call by reference	Type reference (TYPE)	ANY		20070427
6	Importing	IV_FIELD12_VALUE	Call by reference	Type reference (TYPE)	ANY		20070427
7	Importing	IV_FIELD13_VALUE	Call by reference	Type reference (TYPE)	ANY		20070427
8	Importing	IV_FIELD14_VALUE	Call by reference	Type reference (TYPE)	ANY		20070427
9	Importing	IV_FIELD15_VALUE	Call by reference	Type reference (TYPE)	ANY		20070427
10	Importing	IV_FIELD16_VALUE	Call by reference	Type reference (TYPE)	ANY		20070427
11	Importing	IV_FIELD17_VALUE	Call by reference	Type reference (TYPE)	ANY		20070427
12	Importing	IV_FIELD18_VALUE	Call by reference	Type reference (TYPE)	ANY		20070427
13	Importing	IV_FIELD19_VALUE	Call by reference	Type reference (TYPE)	ANY		20070427
14	Importing	IV_FIELD1_VALUE	Call by reference	Type reference (TYPE)	ANY		20070328
15	Importing	IV_FIELD20_VALUE	Call by reference	Type reference (TYPE)	ANY		20070427
16	Importing	IV_FIELD2_VALUE	Call by reference	Type reference (TYPE)	ANY		20070328
17	Importing	IV_FIELD3_VALUE	Call by reference	Type reference (TYPE)	ANY		20070328
18	Importing	IV_FIELD4_VALUE	Call by reference	Type reference (TYPE)	ANY		20070328
19	Importing	IV_FIELD5_VALUE	Call by reference	Type reference (TYPE)	ANY		20070328
20	Importing	IV_FIELD6_VALUE	Call by reference	Type reference (TYPE)	ANY		20070328
21	Importing	IV_FIELD7_VALUE	Call by reference	Type reference (TYPE)	ANY		20070328
22	Importing	IV_FIELD8_VALUE	Call by reference	Type reference (TYPE)	ANY		20070328
23	Importing	IV_FIELD9_VALUE	Call by reference	Type reference (TYPE)	ANY		20070328
24	Importing	IV_FOCUS_NAME	Call by reference	Type reference (TYPE)	ANY	Component name	20070328
25	Importing	IV_FOCUS_VALUE	Call by reference	Type reference (TYPE)	ANY		20070328
26	Importing	IV_TABLE_NAME	Call by reference	Type reference (TYPE)	BALTABNAME	Application Log: Context: DDIC structure name	20070328

Method GET_CONTEXT_AND_PARAMETERS on class CL_ESH_CO_LOGGING has no exception.

Method GET_DIFFERENTIATOR_HASH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DIFFERENTIATOR	Call by reference		Type reference (TYPE)	ANY			20070412
2	Returning	RV_DIFFERENTIATOR_HASH	Value transfer		Type reference (TYPE)	CHAR40		Character field of length 40	20070412

Method GET_DIFFERENTIATOR_HASH on class CL_ESH_CO_LOGGING has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_APPLICATION_LOG_HANDLE	Call by reference	Type reference (TYPE)	BALLOGHNDL	Application Log: Log Handle	20070626
2	Importing	IV_APPLICATION_LOG_SUBOBJECT	Call by reference	Type reference (TYPE)	BALSUBOBJ	Application Log: Subobject	20070323
3	Returning	RR_APPLICATION_LOG	Value transfer	Object reference (TYPE REF TO)	IF_ESH_OM_APPLOG	Application Log	20070323

Method GET_INSTANCE on class CL_ESH_CO_LOGGING has no exception.

Method GET_IS_TOPIC_ENTRY Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_ENTRY_MSGID	Call by reference	Type reference (TYPE)	SYST-MSGID	ABAP System Field: Message ID	20130704
2	Importing	IV_ENTRY_MSGNO	Call by reference	Type reference (TYPE)	SYST-MSGNO	ABAP System Field: Message Number	20130704
3	Importing	IV_ENTRY_MSGTY	Call by reference	Type reference (TYPE)	SYST-MSGTY	ABAP System Field: Message Type	20130704
4	Returning	RV_IS_TOPIC_ENTRY	Value transfer	Type reference (TYPE)	ABAP_BOOL		20130704

Method GET_IS_TOPIC_ENTRY on class CL_ESH_CO_LOGGING has no exception.

Method GET_IS_TYPE_ENTRY Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_ENTRY_MSGID	Call by reference	Type reference (TYPE)	SYST-MSGID	ABAP System Field: Message ID	20130701
2	Importing	IV_ENTRY_MSGNO	Call by reference	Type reference (TYPE)	SYST-MSGNO	ABAP System Field: Message Number	20130701
3	Importing	IV_ENTRY_MSGTY	Call by reference	Type reference (TYPE)	SYST-MSGTY	ABAP System Field: Message Type	20130701
4	Returning	RV_IS_TYPE_ENTRY	Value transfer	Type reference (TYPE)	ABAP_BOOL		20130701

Method GET_IS_TYPE_ENTRY on class CL_ESH_CO_LOGGING has no exception.

Method GET_NORMALIZED_MESSAGE_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_MESSAGE_TYPE	Call by reference		Type reference (TYPE)	SYMSGTY		Message Type	20070327

Method GET_NORMALIZED_MESSAGE_TYPE on class CL_ESH_CO_LOGGING has no exception.

Method GET_REF_TO_APP_LOG_LINE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_DIFFERENTIATOR	Call by reference	Type reference (TYPE)	ANY		20070323
2	Importing	IV_DIFFERENTIATOR_HASH	Call by reference	Type reference (TYPE)	CHAR40		20110120
3	Returning	RR_LOG_MESSAGES	Value transfer	Object reference (TYPE REF TO)	ESH_S_CO_LOG_MESSAGES	Log messages	20070323

Method GET_REF_TO_APP_LOG_LINE on class CL_ESH_CO_LOGGING has no exception.

Method GET_TIMESTAMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TIMESTAMP	Value transfer		Type reference (TYPE)	BALTIMSTMP			20070323

Method GET_TIMESTAMP on class CL_ESH_CO_LOGGING has no exception.

Method GET_TYPE_ENTRY_DETAILS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_BLOCK_MSGTY	Call by reference	Type reference (TYPE)	SYST-MSGTY	ABAP System Field: Message Type	20130701
2	Exporting	EV_IS_TYPE_ENTRY	Call by reference	Type reference (TYPE)	ABAP_BOOL		20130701
3	Importing	IV_ENTRY_MSGID	Call by reference	Type reference (TYPE)	SYST-MSGID	ABAP System Field: Message ID	20130701
4	Importing	IV_ENTRY_MSGNO	Call by reference	Type reference (TYPE)	SYST-MSGNO	ABAP System Field: Message Number	20130701
5	Importing	IV_ENTRY_MSGTY	Call by reference	Type reference (TYPE)	SYST-MSGTY	ABAP System Field: Message Type	20130701

Method GET_TYPE_ENTRY_DETAILS on class CL_ESH_CO_LOGGING has no exception.

Method INCREMENT_MESSAGE_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_MESSAGE_COUNT	Call by reference		Type reference (TYPE)	ESH_S_CO_MESSAGE_TYPE_COUNTERS		Message type counters	20070323
2	Importing	IV_MESSAGE_TYPE	Call by reference		Type reference (TYPE)	SYMSGTY		Message Type	20070323

Method INCREMENT_MESSAGE_COUNT on class CL_ESH_CO_LOGGING has no exception.

Method MESSAGE_PREFIX_BY_MESSAGE_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MESSAGE_TYPE	Call by reference		Type reference (TYPE)	BAL_S_MSG-MSGTY		Message Type	20090305
2	Returning	RV_MESSAGE_PREFIX	Value transfer		Type reference (TYPE)	CHAR80		Char 80	20090305

Method MESSAGE_PREFIX_BY_MESSAGE_TYPE on class CL_ESH_CO_LOGGING has no exception.

Method RESOLVE_EXCEPTION_MESSAGE_ATTR Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	EV_MESSAGE_VARIABLE	Call by reference	Type reference (TYPE)	SYMSGV	Message Variable	20090925
2	Importing	IV_T100KEY_ATTRIBUTE	Call by reference	Type reference (TYPE)	SCX_ATTRNAME	Attribute Name	20090925
3	Importing	IX_EXCEPTION	Call by reference	Object reference (TYPE REF TO)	CX_ROOT	Abstract Superclass for All Global Exceptions	20090925

Method RESOLVE_EXCEPTION_MESSAGE_ATTR on class CL_ESH_CO_LOGGING has no exception.

Method SAVE_LOG_MESSAGES Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LOG	Call by reference	Type reference (TYPE)	ESH_S_CO_LOG_MESSAGES		Log messages	20070326
2	Importing	IV_CLEAR_PARAMS	Call by reference	Type reference (TYPE)	BOOLEAN	SPACE	Boolean Variable (X=True, -=False, Space=Unknown)	20090119
3	Importing	IV_LOG_HANDLE	Call by reference	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20070326

#	Exception	Resumable	Description	Created on
1	CX_ESH_CO_ENGINE		Common ESH Engine Exception	20070326

Method TEXT_MESSAGE_CONVERT_TO_SYMSG Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IV_MESSAGE_ID	Call by reference	Type reference (TYPE)	SYMSGID	Message ID	20080606
2	Importing	IV_MESSAGE_NO	Call by reference	Type reference (TYPE)	SYMSGNO	Message No (has to contain &1&2&3&4)	20080606
3	Importing	IV_MESSAGE_TYPE	Call by reference	Type reference (TYPE)	SYMSGTY	Message Type A, E, W, I, S	20080606
4	Importing	IV_TEXT	Call by reference	Type reference (TYPE)	STRING	Message Text	20080606

Method TEXT_MESSAGE_CONVERT_TO_SYMSG on class CL_ESH_CO_LOGGING has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	100

Object Hierarchy

Using

Used by

Advertise Links