SAP ABAP Class CL_TRACE_READER (Reads 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_READER
Short Description	Reads 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_READER has no interface implemented.

Friends

Class CL_TRACE_READER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_NEW_LINE	Static Attribute	Private	☐	Type reference (TYPE)	STRING	' '		20100723
2	GC_SEPARATOR	Static Attribute	Private	☐	Type reference (TYPE)	STRING	' '		20100723
3	GC_SPACE	Static Attribute	Private	☐	Type reference (TYPE)	STRING	' '		20100723
4	MT_CATEGORY_DOMAIN	Instance attribute	Private	☐	Type reference (TYPE)	DOMAIN_T			20110711
5	MT_SEVERITY_DOMAIN	Instance attribute	Private	☐	Type reference (TYPE)	DOMAIN_T			20110711

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_SESSION_MESSAGES	Instance method	Private	Method	For a message adds a row in the table with messages in HTML	20100723
2	ADD_TABLE_HEADER	Instance method	Private	Method	Adds the header of the table with trace messages to the HTML	20100723
3	ADD_TRACE_INFO	Instance method	Private	Method	Adds info for trace session into the header of the HTML	20100723
4	GET_ACTIVE_SESSION	Static method	Public	Method	Returns the active atrce session at the moment	20100723
5	GET_DOMAINS	Instance method	Private	Method	Get domains for category and severity	20110711
6	GET_FULL_DATE	Instance method	Private	Method	From a timestamp returns the date and time in string format	20100723
7	GET_HTML_HEADER	Instance method	Private	Method	Returns the header of the HTML which represents a session	20100723
8	GET_SESSION_HTML	Instance method	Public	Method	Returns an HTML representing specific trace session	20100723
9	GET_TIME	Instance method	Private	Method	From a timestamp returns the time in a string format	20100723
10	GET_TRACE_SESSIONS	Static method	Public	Method	Retruns one or all sessions or all sessions per category	20100723

Events

Class CL_TRACE_READER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	DOMAIN_T	Private	See coding			20100805	DOMAIN_T type table of dd07v
2	HTML_T	Private	See coding			20100723	HTML_T TYPE STANDARD TABLE OF w3html

Method Signatures

Method ADD_SESSION_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_HTML	Call by reference	☐	Type reference (TYPE)	STRING		HTML string to change	20100723
2	Importing	IV_SESSION_ID	Call by reference	☐	Type reference (TYPE)	SEC_INTEGER64		Session ID	20100723

Method ADD_SESSION_MESSAGES on class CL_TRACE_READER has no exception.

Method ADD_TABLE_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_HTML	Call by reference	☐	Type reference (TYPE)	STRING		HTML string to change	20100723

Method ADD_TABLE_HEADER on class CL_TRACE_READER has no exception.

Method ADD_TRACE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_HTML	Call by reference	☐	Type reference (TYPE)	STRING		HTML string to change	20100723
2	Importing	IS_SESSION_INFO	Call by reference	☐	Type reference (TYPE)	TRACE_SESSION_S		Represents a single trace session	20100723

Method ADD_TRACE_INFO on class CL_TRACE_READER has no exception.

Method GET_ACTIVE_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_CLIENT	Call by reference	☐	Type reference (TYPE)	SYMANDT		Client ID of Current User	20100723
3	Importing	IV_ONLY_RUNNING	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	True - return 'Running', false - 'Running' and 'Paused' .	20100727
4	Importing	IV_SESSION_SEVERITY	Call by reference	☐	Type reference (TYPE)	TRACE_SEVERITY	IF_TRACE_CONSTANTS=>GC_SEVERITY_DEBUG	Severity of a trace session or trace message	20100727
5	Returning	RV_SESSION	Value transfer	☐	Type reference (TYPE)	TRACE_SESSION_S		Represents a single trace session	20100723

#	Exception	Resumable	Description	Created on
1	CX_SEC_TRACE	☐	SAML20 Superclass Exceptions	20100723

Method GET_DOMAINS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CATEGORY_DOMAIN	Call by reference	☐	Type reference (TYPE)	DOMAIN_T		Domain for category	20110711
2	Exporting	EV_SEVERITY_DOMAIN	Call by reference	☐	Type reference (TYPE)	DOMAIN_T		Domain for severity	20110711

Method GET_DOMAINS on class CL_TRACE_READER has no exception.

Method GET_FULL_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TIMESTAMP	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		Timestampt to parse	20100723
2	Returning	RV_STRING	Value transfer	☐	Type reference (TYPE)	STRING		Date in format: 'hh:mm:ss:miliseconds day:month:year'	20100723

Method GET_FULL_DATE on class CL_TRACE_READER has no exception.

Method GET_HTML_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	SEC_INTEGER64		64-bit integer	20110124
2	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	CHAR30		Name of the trace session	20110124
3	Importing	IV_STARTED	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun)	20110124
4	Returning	RV_STRING	Value transfer	☐	Type reference (TYPE)	STRING		String containing the HTML header	20100723

Method GET_HTML_HEADER on class CL_TRACE_READER has no exception.

Method GET_SESSION_HTML 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_HTML	Value transfer	☐	Type reference (TYPE)	STRING		HTML representing the specified session	20100723

Method GET_SESSION_HTML on class CL_TRACE_READER has no exception.

Method GET_TIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TIMESTAMP	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		Timestamp to parse	20100723
2	Returning	RV_TIME	Value transfer	☐	Type reference (TYPE)	STRING		Time in format 'hh:mm:ss:miliseconds'	20100723

Method GET_TIME on class CL_TRACE_READER has no exception.

Method GET_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 a security trace	20100730
2	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	SYMANDT		Client ID of Current User	20100803
3	Importing	IV_SESSION_ID	Call by reference	☑	Type reference (TYPE)	SEC_INTEGER64		64-bit integer replacement	20100723
4	Returning	RV_SESSIONS	Value transfer	☐	Type reference (TYPE)	TRACE_SESSION_T		Table of trace sessions	20100723

Method GET_TRACE_SESSIONS on class CL_TRACE_READER has no exception.

History

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