SAP ABAP Class CL_SAML20_TRACE (SAML 2.0 Tracing)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SEC-LGN-SML (Application Component) SAML 2.0
     ⤷ SAML2_COMMON (Package) SAML2 Common

Properties

Class	CL_SAML20_TRACE
Short Description	SAML 2.0 Tracing
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SAML2_COMMON	SAML2 Common
Created	20090518	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_SAML20_TRACE has no interface implemented.

Friends

Class CL_SAML20_TRACE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_ACTION_CREATE	Constant	Public	☐	Type reference (TYPE)	I	1		20090518
2	CO_ACTION_CREATE_ERROR	Constant	Public	☐	Type reference (TYPE)	I	2		20090518
3	CO_ACTION_MAP	Constant	Public	☐	Type reference (TYPE)	I	4		20090518
4	CO_ACTION_MAP_ERROR	Constant	Public	☐	Type reference (TYPE)	I	5		20090518
5	CO_ACTION_TERMINATE	Constant	Public	☐	Type reference (TYPE)	I	3		20090518
6	CO_ACTION_TRIGGER	Constant	Public	☐	Type reference (TYPE)	I	6		20090518
7	CO_ACTION_UPDATE	Constant	Public	☐	Type reference (TYPE)	I	7		20090716
8	CO_OPCODE_READ	Constant	Private	☐	Type reference (TYPE)	X	02		20090518
9	CO_OPCODE_WRITE	Constant	Private	☐	Type reference (TYPE)	X	01		20090518
10	CO_PREFIX	Constant	Private	☐	Type reference (TYPE)	STRING	'SAML20'		20090518
11	CO_TRACE_LEVEL_1	Constant	Public	☐	Type reference (TYPE)	I	1		20090518
12	CO_TRACE_LEVEL_2	Constant	Public	☐	Type reference (TYPE)	I	2		20090518
13	CO_TRACE_LEVEL_3	Constant	Public	☐	Type reference (TYPE)	I	3		20090518
14	CO_TRACE_LEVEL_ERROR	Constant	Public	☐	Type reference (TYPE)	I	-1		20090518
15	GV_TRACE_SESSION	Instance attribute	Private	☐	Type reference (TYPE)	TRACE_SESSION_S			20100805
16	M_CLIENT	Instance attribute	Private	☐	Type reference (TYPE)	SYMANDT		Client ID of Current User	20090518
17	M_HTMLTIDY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_HTMLTIDY		HTML repair and conversion tool	20090518
18	M_TRACE_LEVEL	Instance attribute	Private	☐	Type reference (TYPE)	I			20090518

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CAN_BE_TRACED	Instance method	Private	Method		20100805
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20090518
3	CONVERT_XML2STRING	Instance method	Private	Method	Convert XML message to trace string	20090518
4	FORMAT_EXCEPTION	Static method	Public	Method	Retunrs a string presentation of an exception	20110602
5	GET_EXCEPTION_DESCRIPTION	Static method	Private	Method	Returns formatted description of an exception	20110601
6	GET_EXCEPTION_SOURCE_POSITION	Static method	Private	Method	Returns where the exception was thrown	20110601
7	GET_TRACE_SESSION_SEVERITY	Instance method	Public	Method	Returns the severity of the current trace session	20110706
8	IS_SIGNED	Instance method	Private	Method	Determines if the SAML2 message is signed	20101014
9	IS_TRACING	Instance method	Public	Method	Returns true if there is an opened trace session	20130813
10	TRACE_EXCEPTION	Instance method	Public	Method	Write trace entry in an exception	20090518
11	TRACE_FEDERATION	Instance method	Public	Method	Write trace entry for federation	20090518
12	TRACE_HTTP_REQUEST	Instance method	Public	Method	Trace an HTTP request	20101209
13	TRACE_IDP_SELECTION	Instance method	Public	Method	Write trace entry for identity provider selection	20090518
14	TRACE_MESSAGE	Instance method	Public	Method	Write trace entry for a message	20090518
15	TRACE_SAML_SESSION	Instance method	Public	Method	Write trace entry for the SAML session	20090518
16	TRACE_TEXT	Instance method	Public	Method	Write Trace Entry	20090518
17	TRACE_TEXT_INTERNAL	Instance method	Private	Method		20100902
18	WRITE_LOG	Static method	Public	Method	Write a log entry	20090519

Events

Class CL_SAML20_TRACE has no event.

Types

Class CL_SAML20_TRACE has no local type.

Method Signatures

Method CAN_BE_TRACED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SEVERITY	Call by reference	☐	Type reference (TYPE)	TRACE_CATEGORY			20100805
2	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100805

Method CAN_BE_TRACED on class CL_SAML20_TRACE has no exception.

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		Mandantenkennung des aktuellen Benutzers	20090518

Method CONSTRUCTOR on class CL_SAML20_TRACE has no exception.

Method CONVERT_XML2STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20090518
2	Importing	IF_XML	Call by reference	☐	Type reference (TYPE)	XSTRING			20090518

Method CONVERT_XML2STRING on class CL_SAML20_TRACE has no exception.

Method FORMAT_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_SAML20		SAML20 Superclass Exceptions	20110602
2	Importing	IV_PREFIX	Call by reference	☐	Type reference (TYPE)	STRING	''	Prefix before every exception line	20110602
3	Returning	RV_EXCEPTION_STACK_STR	Value transfer	☐	Type reference (TYPE)	STRING		exception stack	20110602

Method FORMAT_EXCEPTION on class CL_SAML20_TRACE has no exception.

Method GET_EXCEPTION_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass for All Global Exceptions	20110601
2	Returning	RV_DESCRIPTION	Value transfer	☐	Type reference (TYPE)	STRING			20110601

Method GET_EXCEPTION_DESCRIPTION on class CL_SAML20_TRACE has no exception.

Method GET_EXCEPTION_SOURCE_POSITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_ROOT		Abstract Superclass for All Global Exceptions	20110601
2	Returning	RV_SOURCE_POSITION	Value transfer	☐	Type reference (TYPE)	STRING			20110601

Method GET_EXCEPTION_SOURCE_POSITION on class CL_SAML20_TRACE has no exception.

Method GET_TRACE_SESSION_SEVERITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SEVERITY	Value transfer	☐	Type reference (TYPE)	TRACE_SEVERITY		Severity of a trace session or trace message	20110706

Method GET_TRACE_SESSION_SEVERITY on class CL_SAML20_TRACE has no exception.

Method IS_SIGNED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_TRUSTED_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	CL_SAML20_ENTITY		SAML20 Entity Object	20101014
2	Importing	IV_BINDING_TYPE	Call by reference	☐	Type reference (TYPE)	SAML2_BINDING_TYPE		SAML2 Binding Type	20101014
3	Importing	IV_IS_INCOMING	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20101014
4	Importing	IV_SERVICE_TYPE	Call by reference	☐	Type reference (TYPE)	SAML2_PROFILE_TYPE		SAML2 Profiles	20101014
5	Importing	IV_SIGNED	Call by reference	☑	Type reference (TYPE)	SAML2_BOOLEAN		SAML2 Truth Value	20110121
6	Returning	RV_SIGNED	Value transfer	☐	Type reference (TYPE)	STRING			20101014

Method IS_SIGNED on class CL_SAML20_TRACE has no exception.

Method IS_TRACING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	SAML2_BOOLEAN		SAML2 Truth Value	20130813

Method IS_TRACING on class CL_SAML20_TRACE has no exception.

Method TRACE_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_SAML20		Oberklasse SAML20 Ausnahmen	20090518
2	Importing	IV_TRACE_SEVERITY	Call by reference	☐	Type reference (TYPE)	TRACE_SEVERITY	IF_TRACE_CONSTANTS=>GC_SEVERITY_ERROR	Severity of a trace session or trace message	20100805
3	Importing	IV_TRACE_SP_CLIENT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20110707

Method TRACE_EXCEPTION on class CL_SAML20_TRACE has no exception.

Method TRACE_FEDERATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_ACTION	Call by reference	☐	Type reference (TYPE)	I			20090518
2	Importing	IF_NAMEID	Call by reference	☐	Type reference (TYPE)	SAML2_NAMEID_IDP		SAML2 Name am IDP	20090518
3	Importing	IF_NAMEID_KEY	Call by reference	☐	Type reference (TYPE)	SAML2_NAMEID_KEY		SAML2 Anmeldeformat	20090518
4	Importing	IF_USER_ID	Call by reference	☑	Type reference (TYPE)	XUBNAME		Benutzername im Benutzerstamm	20090518
5	Importing	IV_TRACE_SEVERITY	Call by reference	☐	Type reference (TYPE)	TRACE_CATEGORY	IF_TRACE_CONSTANTS=>GC_SEVERITY_INFO		20100805
6	Importing	IV_TRACE_SP_CLIENT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20110707

Method TRACE_FEDERATION on class CL_SAML20_TRACE has no exception.

Method TRACE_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 Framework (iHTTP) HTTP Server	20101209
2	Importing	IV_TRACE_SEVERITY	Call by reference	☐	Type reference (TYPE)	TRACE_SEVERITY	IF_TRACE_CONSTANTS=>GC_SEVERITY_INFO	Severity of a trace session or trace message	20101209
3	Importing	IV_TRACE_SP_CLIENT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20110707

Method TRACE_HTTP_REQUEST on class CL_SAML20_TRACE has no exception.

Method TRACE_IDP_SELECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_IDP_NAME	Call by reference	☐	Type reference (TYPE)	SAML2_ENTITY_NAME		SAML2 Entitätskennung	20090518
2	Importing	IF_SOURCE	Call by reference	☐	Type reference (TYPE)	STRING			20090518
3	Importing	IV_TRACE_SEVERITY	Call by reference	☐	Type reference (TYPE)	TRACE_CATEGORY	IF_TRACE_CONSTANTS=>GC_SEVERITY_INFO		20100805
4	Importing	IV_TRACE_SP_CLIENT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20110707

Method TRACE_IDP_SELECTION on class CL_SAML20_TRACE has no exception.

Method TRACE_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_ARTIFACT	Call by reference	☑	Type reference (TYPE)	STRING			20090518
2	Importing	IF_BINDING_TYPE	Call by reference	☑	Type reference (TYPE)	SAML2_BINDING_TYPE		SAML2 Bindungsart	20090518
3	Importing	IF_DESTINATION	Call by reference	☑	Type reference (TYPE)	STRING			20090518
4	Importing	IF_IDP_NAME	Call by reference	☑	Type reference (TYPE)	SAML2_ENTITY_NAME		SAML2 Entitätskennung	20090518
5	Importing	IF_IS_DECRYPTED	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20101123
6	Importing	IF_MESSAGE_INCOMING	Call by reference	☑	Type reference (TYPE)	STRING			20090518
7	Importing	IF_MESSAGE_OUTGOING	Call by reference	☑	Type reference (TYPE)	STRING			20090518
8	Importing	IF_SIGNED	Call by reference	☑	Type reference (TYPE)	SAML2_BOOLEAN		SAML2 Truth Value	20110121
9	Importing	IF_STATUS_CODE	Call by reference	☑	Type reference (TYPE)	SAML2_STATUS_CODE		Statuswert einer SAML2 Nachricht	20090518
10	Importing	IF_XML	Call by reference	☑	Type reference (TYPE)	XSTRING			20090518
11	Importing	IF_XML_STR	Call by reference	☑	Type reference (TYPE)	STRING			20101123
12	Importing	IO_TRUSTED_ENTITY	Call by reference	☑	Object reference (TYPE REF TO)	CL_SAML20_ENTITY		SAML20 Entity Object	20101014
13	Importing	IV_SERVICE_TYPE	Call by reference	☑	Type reference (TYPE)	SAML2_PROFILE_TYPE		SAML2 Profiles	20101014
14	Importing	IV_TRACE_SEVERITY	Call by reference	☐	Type reference (TYPE)	TRACE_CATEGORY	IF_TRACE_CONSTANTS=>GC_SEVERITY_INFO		20100805
15	Importing	IV_TRACE_SP_CLIENT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20110707

Method TRACE_MESSAGE on class CL_SAML20_TRACE has no exception.

Method TRACE_SAML_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_ACTION	Call by reference	☐	Type reference (TYPE)	I			20090518
2	Importing	IF_REASON	Call by reference	☐	Type reference (TYPE)	CLIKE			20090518
3	Importing	IF_SECURITY_CONTEXT_REF	Call by reference	☐	Type reference (TYPE)	SECURITY_CONTEXT_REF		interne Referenz auf Sicherheitskontext (zeitinvariant)	20090518
4	Importing	IV_TRACE_SEVERITY	Call by reference	☐	Type reference (TYPE)	TRACE_CATEGORY	IF_TRACE_CONSTANTS=>GC_SEVERITY_INFO		20100805
5	Importing	IV_TRACE_SP_CLIENT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20110707

Method TRACE_SAML_SESSION on class CL_SAML20_TRACE has no exception.

Method TRACE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Daten für die Trace-Zeile	20090518
2	Importing	IF_TRACE_LEVEL	Call by reference	☐	Type reference (TYPE)	I	2	Tracelevel (-1 = TRCERR)	20090518
3	Importing	IV_TRACE_SEVERITY	Call by reference	☐	Type reference (TYPE)	TRACE_SEVERITY	IF_TRACE_CONSTANTS=>GC_SEVERITY_INFO		20100805
4	Importing	IV_TRACE_SP_CLIENT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20110707

Method TRACE_TEXT on class CL_SAML20_TRACE has no exception.

Method TRACE_TEXT_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_TEXT	Call by reference	☑	Type reference (TYPE)	STRING		Data for the Trace Line	20100902
2	Importing	IF_TRACE_LEVEL	Call by reference	☐	Type reference (TYPE)	I	2	Trace Level (-1 = TRCERR)	20100902
3	Importing	IF_TRACE_SESSION_TEXT	Call by reference	☑	Type reference (TYPE)	STRING			20100902
4	Importing	IO_SERVER	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20101209
5	Importing	IV_TRACE_SEVERITY	Call by reference	☐	Type reference (TYPE)	TRACE_SEVERITY	IF_TRACE_CONSTANTS=>GC_SEVERITY_INFO		20100902
6	Importing	IV_TRACE_SP_CLIENT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	True if the abap client should be dumped in the prefix	20110707

Method TRACE_TEXT_INTERNAL on class CL_SAML20_TRACE has no exception.

Method WRITE_LOG Signature

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

Method WRITE_LOG on class CL_SAML20_TRACE has no exception.

History

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