SAP ABAP Class CL_TRACE_LOGGER (Logs trace messages)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SEC-LGN-SML (Application Component) SAML 2.0
     ⤷ SEC_TRACE (Package) Generic functionality for security tracing

Properties

Class	CL_TRACE_LOGGER
Short Description	Logs trace messages
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SEC_TRACE	Generic functionality for security tracing
Created	20100723	SAP
Last change	20130531	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_TRACE_CONSTANTS	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_TRACE_LOGGER has no interface implemented.

Friends

Class CL_TRACE_LOGGER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_CHUNK_SIZE	Static Attribute	Private	☐	Type reference (TYPE)	I	5	Max number of of elemnts in a where clause	20110124
2	GV_CLIENT	Instance attribute	Private	☐	Type reference (TYPE)	SYMANDT			20100723

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Public constructor	20100723
2	CONVERT_ABAP_TIMESTAMP_TO_JAVA	Instance method	Private	Method	Converts abap timestam to java format in miliseconds	20100920
3	CREATE_TRACE_SESSION	Instance method	Public	Method	Creates a new trace session with status 'Running'	20100723
4	DELETE_CHUNK	Instance method	Private	Method	Deletes a chunk of trace sessions	20110124
5	DELETE_MULTIPLE_SESSIONS	Instance method	Public	Method	Deletes multiple trace sessions	20110124
6	DELETE_TRACE_SESSIONS	Instance method	Public	Method	Deletes a specific traces session or all sessions	20100723
7	FORMAT_CALLSTACK	Static method	Public	Method	Creates a string representation of a callstack	20110601
8	FORMAT_MESSAGE_STRING	Instance method	Private	Method	Splits long strings into line with up to 120 characters	20101130
9	GET_MSGS_COUNT	Instance method	Private	Method	Returns the count of the messages per session	20100723
10	GET_NEW_SESSION_ID	Instance method	Private	Method	Creates a new session ID	20100723
11	GET_SERVER_NAME	Instance method	Private	Method	Returns the name of the application server	20101020
12	LOCK	Instance method	Private	Method	Sets a lock on the 'E_TRACE_SESSION' lock object	20100723
13	LOG_HTTP_REQUEST	Instance method	Public	Method	Logs an HTTP reques	20101209
14	LOG_TRACE_ENTRY	Instance method	Public	Method	Logs a message in a trace session	20100723
15	SET_TRACE_SESSION_SEVERITY	Instance method	Public	Method	Changes the severity of a trace session	20100723
16	SET_TRACE_SESSION_STATUS	Instance method	Public	Method	Changes the status of a trace session	20100723
17	UNLOCK	Instance method	Private	Method	Removes the lock on the 'E_TRACE_SESSION' lock object	20100723

Events

Class CL_TRACE_LOGGER has no event.

Types

Class CL_TRACE_LOGGER has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_CLIENT	Call by reference	☐	Type reference (TYPE)	SYMANDT		Client ID of Current User	20100723

Method CONSTRUCTOR on class CL_TRACE_LOGGER has no exception.

Method CONVERT_ABAP_TIMESTAMP_TO_JAVA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_TIMESTAMP	Call by reference	☐	Type reference (TYPE)	STRING		Time in Milliseconds since January 1, 1970, 00:00:00 GMT	20100920
2	Importing	IM_DATE	Call by reference	☐	Type reference (TYPE)	SYDATE		Date Data Element for SYST	20100920
3	Importing	IM_MSEC	Call by reference	☐	Type reference (TYPE)	NUM03	000	Remaining Milliseconds	20100920
4	Importing	IM_TIME	Call by reference	☐	Type reference (TYPE)	SYUZEIT		Date and Time, Current Application Server Time	20100920

Method CONVERT_ABAP_TIMESTAMP_TO_JAVA on class CL_TRACE_LOGGER has no exception.

Method CREATE_TRACE_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CATEGORY	Call by reference	☑	Type reference (TYPE)	TRACE_CATEGORY		Category of a security trace	20100723
2	Importing	IV_MSG_CNT	Call by reference	☐	Type reference (TYPE)	INT4	10000	Maximum number of messages for this session	20100723
3	Importing	IV_SESSION_NAME	Call by reference	☑	Type reference (TYPE)	CHAR30		Name of the session	20100723
4	Importing	IV_SEVERITY	Call by reference	☐	Type reference (TYPE)	TRACE_SEVERITY		Trace session severity	20100723
5	Returning	RV_SESSION_ID	Value transfer	☐	Type reference (TYPE)	SEC_INTEGER64		The ID of the created session	20100723

#	Exception	Resumable	Description	Created on
1	CX_SEC_TRACE	☐		20100723

Method DELETE_CHUNK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SESSIONS	Call by reference	☐	Type reference (TYPE)	TRACE_SESSION_ID_T		Table of session IDs	20110124

#	Exception	Resumable	Description	Created on
1	CX_SEC_TRACE	☐	Security diagnostic tool exception	20110124

Method DELETE_MULTIPLE_SESSIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SESSIONS	Call by reference	☐	Type reference (TYPE)	TRACE_SESSION_ID_T		Table of session IDs	20110124

#	Exception	Resumable	Description	Created on
1	CX_SEC_TRACE	☐	Security diagnostic tool exception	20110124

Method DELETE_TRACE_SESSIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CATEGORY	Call by reference	☑	Type reference (TYPE)	TRACE_CATEGORY		Category of the sessions to be deleted	20100723
2	Importing	IV_SESSION_ID	Call by reference	☑	Type reference (TYPE)	SEC_INTEGER64		The ID of the session to delete	20100723

#	Exception	Resumable	Description	Created on
1	CX_SEC_TRACE	☐		20100723

Method FORMAT_CALLSTACK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CALLSTACK	Call by reference	☐	Type reference (TYPE)	ABAP_CALLSTACK		ABAP Call Stack	20110601
2	Importing	IV_IS_EXCEPTION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		True if this is a callstack of an exception	20110601
3	Importing	IV_PREFIX	Call by reference	☑	Type reference (TYPE)	STRING		Prefix to insert at every line	20110601
4	Returning	RV_CALLSTACK	Value transfer	☐	Type reference (TYPE)	STRING		Formatted callstack	20110601

Method FORMAT_CALLSTACK on class CL_TRACE_LOGGER has no exception.

Method FORMAT_MESSAGE_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING			20101130
2	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20101130

Method FORMAT_MESSAGE_STRING on class CL_TRACE_LOGGER has no exception.

Method GET_MSGS_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SESSION_ID	Call by reference	☐	Type reference (TYPE)	SEC_INTEGER64		ID of the session	20100723
2	Returning	RV_COUNT	Value transfer	☐	Type reference (TYPE)	I		Number of the messages in the specified session	20100723

Method GET_MSGS_COUNT on class CL_TRACE_LOGGER has no exception.

Method GET_NEW_SESSION_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SESSION_ID	Value transfer	☐	Type reference (TYPE)	SEC_INTEGER64		Returns a new session ID	20100723

Method GET_NEW_SESSION_ID on class CL_TRACE_LOGGER has no exception.

Method GET_SERVER_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SERVER_NAME	Value transfer	☐	Type reference (TYPE)	MSHOST2		Name of Application Server	20101020

Method GET_SERVER_NAME on class CL_TRACE_LOGGER has no exception.

Method LOCK Signature

Method LOCK on class CL_TRACE_LOGGER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SEC_TRACE	☐		20100723

Method LOG_HTTP_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SERVER	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Server	20101209
2	Importing	IV_CALLSTACK	Call by reference	☐	Type reference (TYPE)	ABAP_CALLSTACK		Callstack from which the message is logged	20101209
3	Importing	IV_SESSION_ID	Call by reference	☐	Type reference (TYPE)	SEC_INTEGER64		ID of the session where the message will be logged	20101209
4	Importing	IV_SEVERITY	Call by reference	☐	Type reference (TYPE)	TRACE_SEVERITY		Severity of the message	20101209
5	Returning	RV_INSERTED_MSGS	Value transfer	☐	Type reference (TYPE)	I		Number of inserted messages	20101209

#	Exception	Resumable	Description	Created on
1	CX_SEC_TRACE	☐	Security diagnostic tool exception	20101209

Method LOG_TRACE_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CALLSTACK	Call by reference	☐	Type reference (TYPE)	ABAP_CALLSTACK		Callstack from which the message is logged	20100723
2	Importing	IV_MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING		Message to be logged	20100723
3	Importing	IV_SESSION_ID	Call by reference	☐	Type reference (TYPE)	SEC_INTEGER64		ID of the session where the message will be logged	20100723
4	Importing	IV_SEVERITY	Call by reference	☐	Type reference (TYPE)	TRACE_SEVERITY		Severity of the message	20100723
5	Returning	RV_INSERTED_MSGS	Value transfer	☐	Type reference (TYPE)	I		Number of inserted messages	20100730

#	Exception	Resumable	Description	Created on
1	CX_SEC_TRACE	☐		20100723

Method SET_TRACE_SESSION_SEVERITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SESSION_ID	Call by reference	☐	Type reference (TYPE)	SEC_INTEGER64		ID of the session to be changed	20100723
2	Importing	IV_SESSION_SEVERITY	Call by reference	☐	Type reference (TYPE)	TRACE_SEVERITY		The new severity	20100723

#	Exception	Resumable	Description	Created on
1	CX_SEC_TRACE	☐		20100723

Method SET_TRACE_SESSION_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SESSION_ID	Call by reference	☐	Type reference (TYPE)	SEC_INTEGER64		ID of the session to be changed	20100723
2	Importing	IV_STATUS	Call by reference	☐	Type reference (TYPE)	TRACE_SESSION_STATUS		The new status of the trace session	20100723

#	Exception	Resumable	Description	Created on
1	CX_SEC_TRACE	☐		20100723

Method UNLOCK Signature

Method UNLOCK on class CL_TRACE_LOGGER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SEC_TRACE	☐		20100723

History

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