SAP ABAP Class CL_SAML20_AUDIT_LOG (SAML 2.0 Auditability Class)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SAML20_AUDIT_LOG	Audit Log	20100107

Properties

Class	CL_SAML20_AUDIT_LOG
Short Description	SAML 2.0 Auditability Class
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SAML2_COMMON	SAML2 Common
Created	20091130	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_SAML20_AUDIT_LOG has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SAML20_AUDIT_LOG	☐	☐	Audit Log	20100107

Friends

Class CL_SAML20_AUDIT_LOG has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CF_ENCRYPTED_ID	Constant	Private	☐	Type reference (TYPE)	SAML2_CHAR11	'ENCRYPTEDID'	SAML2: 11 byte field	20100107
2	CF_ERROR_REASON	Constant	Public	☐	Type reference (TYPE)	SAML2_CHAR9	'EXCREASON'	SAML2: 9 byte field	20100107
3	CF_EVT_ERROR_NOT_SIGNED	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_CHAR3	'CUH'	Event name for failed not signed message	20100202
4	CF_EVT_ERROR_NO_PARAMS	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_CHAR3	'CUC'	Event name for failed message without params	20100202
5	CF_EVT_ERROR_PARAMS	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_CHAR3	'CUB'	Event name for failed message with params	20100202
6	CF_EVT_ERROR_SIGNED	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_CHAR3	'CUG'	Event name for failed signed message	20100202
7	CF_EVT_SUCCESS_NOT_SIGNED	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_CHAR3	'BUR'	Event name for successfully parsed not signed message	20100202
8	CF_EVT_SUCCESS_NO_PARAMS	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_CHAR3	'BUP'	Event name for successfully parsed message without params	20100202
9	CF_EVT_SUCCESS_PARAMS	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_CHAR3	'BUL'	Event name for successfully parsed message with params	20100202
10	CF_EVT_SUCCESS_SIGNED	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_CHAR3	'BUQ'	Event name for successfully parsed signed message	20100202
11	CF_LOCAL_USER	Constant	Public	☐	Type reference (TYPE)	SAML2_CHAR9	'LOCALUSER'	SAML2: 9 byte field	20100107
12	CF_NAMEID	Constant	Public	☐	Type reference (TYPE)	SAML2_CHAR6	'NAMEID'	SAML2: 6 byte field	20100107
13	CF_NAMEID_FORMAT	Constant	Private	☐	Type reference (TYPE)	SAML2_CHAR14	'NAMEIDIDFORMAT'	SAML2: 14 byte field	20100107
14	CF_NAMEID_NAMEQUAL	Constant	Private	☐	Type reference (TYPE)	SAML2_CHAR19	'NAMEIDNAMEQUALIFIER'	SAML2: 19 byte field	20100107
15	CF_NAMEID_SPNAMEQUAL	Constant	Private	☐	Type reference (TYPE)	SAML2_CHAR21	'NAMEIDSPNAMEQUALIFIER'	SAML2: 21 byte field	20100107
16	CF_NAMEID_VALUE	Constant	Private	☐	Type reference (TYPE)	SAML2_CHAR12	'NAMEID_VALUE'	SAML2: 12 byte field	20100107
17	CF_NOTONORAFTER	Constant	Private	☐	Type reference (TYPE)	SAML2_CHAR12	'NOTONORAFTER'	SAML2: 12 byte field	20100107
18	CF_REQ_DESTINATION	Constant	Private	☐	Type reference (TYPE)	SAML2_CHAR18	'REQUESTDESTINATION'	SAML2: 18 byte field	20100107
19	CF_REQ_ID	Constant	Private	☐	Type reference (TYPE)	SAML2_CHAR9	'REQUESTID'	SAML2: 9 byte field	20100107
20	CF_REQ_ISSUEINSTANT	Constant	Private	☐	Type reference (TYPE)	SAML2_CHAR19	'REQUESTISSUEINSTANT'	SAML2: 19 byte field	20100107
21	CF_REQ_ISSUER_VALUE	Constant	Private	☐	Type reference (TYPE)	SAML2_CHAR19	'REQUESTISSUER_VALUE'	SAML2: 19 byte field	20100107
22	CF_SESSION_INDEX	Constant	Private	☐	Type reference (TYPE)	SAML2_CHAR12	'SESSIONINDEX'	SAML2: 12 byte field	20100107
23	M_AUDIT_EVENT	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_CHAR3		Audit event name	20100202
24	M_AUDIT_LOG	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_AUDIT_MESSAGE_T		SAML2 Audit Log: Message name table	20100107
25	M_ELEMENT_SIGNED	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_BOOLEAN		SAML2 Truth Value	20100107
26	M_ERROR_ADDED	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_BOOLEAN		Flag if an error has been added	20100107
27	M_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_SAML20_AUDIT_LOG		SAML 2.0 Auditability Class	20100107
28	M_MESSAGE_NAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Message name	20100107

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ELEMENT_TO_LOG_STRUCTURE	Instance method	Private	Method	Add element to Log structure	20100107
2	CONVERT_TIMESTAMP	Instance method	Private	Method	Convert timestamp to system date and time formats	20100107
3	GET_ELEMENT_DETAILS	Instance method	Private	Method	Get descriptive name and other props of the logged element	20100107
4	GET_INSTANCE	Static method	Public	Method	Get an instance of the Audit Log	20100107
5	IS_ERROR_ADDED	Instance method	Private	Method	Return a flag whether an error has been added	20100107
6	IS_MESSAGE_SIGNED	Instance method	Private	Method	Return a flag whether the message is signed	20100110
7	LOG_ASSERTION_ERROR_DATA	Static method	Public	Method	write errorat sso	20091130
8	LOG_ERROR_REASON	Static method	Public	Method	log error reason	20091211
9	PREPARE_LOG	Instance method	Private	Method	Set internal structure with messages data	20100107
10	RESET_AUDIT_EVENT	Instance method	Private	Method	Reset the audit event property	20100202
11	SPLIT_LONGER_TEXTS	Static method	Public	Method	split longer than 64 charcters texts	20091130
12	WRITE_ASSERTION_DATA	Static method	Public	Method	write genral assertion data	20091130
13	WRITE_LOG	Instance method	Private	Method	Write Log	20100107
14	WRITE_LOG_TITLE	Instance method	Private	Method	Write Log title	20100202

Events

Class CL_SAML20_AUDIT_LOG has no event.

Types

Class CL_SAML20_AUDIT_LOG has no local type.

Method Signatures

Method ADD_ELEMENT_TO_LOG_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_ELEMENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100107
2	Importing	I_DATA	Call by reference	☑	Type reference (TYPE)	DATA			20100107

Method ADD_ELEMENT_TO_LOG_STRUCTURE on class CL_SAML20_AUDIT_LOG has no exception.

Method CONVERT_TIMESTAMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_TIMESTAMP	Call by reference	☐	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20100107
2	Returning	RF_DATETIME	Value transfer	☐	Type reference (TYPE)	STRING			20100107

Method CONVERT_TIMESTAMP on class CL_SAML20_AUDIT_LOG has no exception.

Method GET_ELEMENT_DETAILS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_DATA	Call by reference	☐	Type reference (TYPE)	SAML2_AUDIT_PROPERTY_VAL		SAML2 Audit Log: An xml element content to be written	20100107
2	Exporting	EF_DESCRIPTIVE_NAME	Call by reference	☐	Type reference (TYPE)	SAML2_AUDIT_PROPERTY		Descriptive name of the element	20100107
3	Exporting	EF_ELEMENT_ORDER	Call by reference	☐	Type reference (TYPE)	SAML2_AUDIT_PRIORITY		The element order in the Log	20100107
4	Importing	IF_ELEMENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Element name to log	20100107
5	Importing	I_DATA	Call by reference	☑	Type reference (TYPE)	DATA		Element content to change before log	20100107

Method GET_ELEMENT_DETAILS on class CL_SAML20_AUDIT_LOG has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	IF_SAML20_AUDIT_LOG		Audit Log	20100107

Method GET_INSTANCE on class CL_SAML20_AUDIT_LOG has no exception.

Method IS_ERROR_ADDED Signature

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

Method IS_ERROR_ADDED on class CL_SAML20_AUDIT_LOG has no exception.

Method IS_MESSAGE_SIGNED Signature

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

Method IS_MESSAGE_SIGNED on class CL_SAML20_AUDIT_LOG has no exception.

Method LOG_ASSERTION_ERROR_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_ASSERTION	Call by reference	☑	Type reference (TYPE)	SAML2_ASSERTION			20091130
2	Importing	IF_CONSENT	Call by reference	☑	Type reference (TYPE)	STRING			20101202
3	Importing	IF_ERR_TEXT	Call by reference	☑	Type reference (TYPE)	STRING			20091130
4	Importing	IF_RESPONSE	Call by reference	☑	Type reference (TYPE)	SAML2P_RESPONSE			20091130
5	Importing	IF_SUBJECT_NAMEID	Call by reference	☑	Type reference (TYPE)	SAML2_NAME_ID			20091130
6	Importing	IT_ATTRIBUTES	Call by reference	☑	Type reference (TYPE)	SAML2_ASSERTION_ATTRIBUTES_T		Table of SAML2 attribute couples	20091130
7	Importing	IT_TEXTS	Call by reference	☑	Type reference (TYPE)	SAML2_ANYURI_T			20091130

Method LOG_ASSERTION_ERROR_DATA on class CL_SAML20_AUDIT_LOG has no exception.

Method LOG_ERROR_REASON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_ERR_TEXT	Call by reference	☑	Type reference (TYPE)	SAML2_ANYURI		SAML2 URI	20091211
2	Importing	IT_TEXTS	Call by reference	☑	Type reference (TYPE)	SAML2_ANYURI_T		SAML 2.0 URI Table	20091211

Method LOG_ERROR_REASON on class CL_SAML20_AUDIT_LOG has no exception.

Method PREPARE_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_ELEMENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100107
2	Importing	I_DATA	Call by reference	☐	Type reference (TYPE)	DATA			20100107

Method PREPARE_LOG on class CL_SAML20_AUDIT_LOG has no exception.

Method RESET_AUDIT_EVENT Signature

Method RESET_AUDIT_EVENT on class CL_SAML20_AUDIT_LOG has no parameter.
Method RESET_AUDIT_EVENT on class CL_SAML20_AUDIT_LOG has no exception.

Method SPLIT_LONGER_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_LEN	Call by reference	☐	Type reference (TYPE)	I			20091130
2	Importing	IF_TEXT	Call by reference	☐	Type reference (TYPE)	SAML2_ANYURI			20091130
3	Returning	RT_TABLE	Value transfer	☐	Type reference (TYPE)	SAML2_ANYURI_T			20091130

Method SPLIT_LONGER_TEXTS on class CL_SAML20_AUDIT_LOG has no exception.

Method WRITE_ASSERTION_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_ASSERTION	Call by reference	☑	Type reference (TYPE)	SAML2_ASSERTION			20091130
2	Importing	IF_CONSENT	Call by reference	☑	Type reference (TYPE)	STRING			20101202
3	Importing	IF_ENCRYPTED	Call by reference	☑	Type reference (TYPE)	SAML2_BOOLEAN			20091130
4	Importing	IF_SUBJECT_NAMEID	Call by reference	☑	Type reference (TYPE)	SAML2_NAME_ID			20091130
5	Importing	IT_ATTRIBUTES	Call by reference	☑	Type reference (TYPE)	SAML2_ASSERTION_ATTRIBUTES_T		Table of SAML2 attribute couples	20091130

Method WRITE_ASSERTION_DATA on class CL_SAML20_AUDIT_LOG has no exception.

Method WRITE_LOG Signature

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

Method WRITE_LOG on class CL_SAML20_AUDIT_LOG has no exception.

Method WRITE_LOG_TITLE Signature

Method WRITE_LOG_TITLE on class CL_SAML20_AUDIT_LOG has no parameter.
Method WRITE_LOG_TITLE on class CL_SAML20_AUDIT_LOG has no exception.

History

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