SAP ABAP Class CL_SAML20_FEDERATION (SAML20 Federation Object)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SEC-LGN-SML (Application Component) SAML 2.0
     ⤷ SAML2_CORE (Package) SAML2 Core Functionality

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SAML20_CONSTANTS	Constants Within SAML2	20081111

Properties

Class	CL_SAML20_FEDERATION
Short Description	SAML20 Federation Object
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status	P	SAP Standard Production Program
Category	0
Package	SAML2_CORE	SAML2 Core Functionality
Created	20081110	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_SAML20_CONSTANTS	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SAML20_CONSTANTS	☐	☐	Constants Within SAML2	20081111

Friends

Class CL_SAML20_FEDERATION has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_LOGONTYPE_ALIAS	Instance attribute	Private	☐	Attribute reference (LIKE)				20090424
2	CO_LOGONTYPE_ATTRIBUTE	Instance attribute	Private	☐	Attribute reference (LIKE)				20090424
3	CO_LOGONTYPE_SAML	Instance attribute	Private	☐	Attribute reference (LIKE)				20090424
4	CO_LOGONTYPE_USER	Instance attribute	Private	☐	Attribute reference (LIKE)				20090424
5	CO_NAMEIDFORMAT10_UNSPECIFIED	Instance attribute	Private	☐	Attribute reference (LIKE)				20090424
6	CO_NAMEIDFORMAT11_EMAIL	Instance attribute	Private	☐	Attribute reference (LIKE)				20090424
7	CO_NAMEIDFORMAT11_NTDOMAINUSER	Instance attribute	Private	☐	Attribute reference (LIKE)				20090424
8	CO_NAMEIDFORMAT11_UNSPECIFIED	Instance attribute	Private	☐	Attribute reference (LIKE)				20090424
9	CO_NAMEIDFORMAT11_X509SUBJECT	Instance attribute	Private	☐	Attribute reference (LIKE)				20090424
10	CO_NAMEIDFORMAT20_KERBEROS	Instance attribute	Private	☐	Attribute reference (LIKE)				20090424
11	CO_NAMEIDFORMAT20_PERSISTENT	Instance attribute	Private	☐	Attribute reference (LIKE)				20090424
12	CO_NAMEIDFORMAT20_TRANSIENT	Instance attribute	Private	☐	Attribute reference (LIKE)				20090424
13	M_ENTITY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SAML20_ENTITY		SAML20 Entity Object	20081110
14	M_ENTITY_TRUSTED	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SAML20_ENTITY		Separate SAML2 Entity	20090326
15	M_NAMEID_KEY	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_NAMEID_KEY		SAML2 Name at IDP	20081216
16	M_NAMEID_LOGON_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_ID_MAPPING_UNSPECIFIED		Undefined User Assignment	20090430
17	M_NAME_FMT	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_ENT_NFMT		Line from the SAML2_ENT_NFMT table	20130705
18	M_PERSISTENT	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_PIDFED		SAML2 Persistent Federation of Users	20081111
19	M_SPNAMEQUAL_KEY	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_ENTITY_KEY		SAML2 NameID Key	20090309
20	M_TRANSIENT	Instance attribute	Private	☐	Type reference (TYPE)	SAML2_TIDFED		SAML2 Transient Federation of Users	20081111
21	M_USER_ID	Instance attribute	Private	☐	Type reference (TYPE)	XUBNAME		Assignment of External ID to Users	20090129
22	M_USREXTID	Instance attribute	Private	☐	Type reference (TYPE)	EXTID_OPS		External ID of a User	20090202
23	M_USREXTID_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	EXTID_TYPE		External ID Type	20090203

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHANGE_NAMEID	Instance method	Public	Method	Change the Name ID	20090120
2	CONSTRUCTOR	Instance method	Private	Constructor	Constructor	20081118
3	CREATE_INSTANCE	Static method	Public	Method	Generates a federation object	20081118
4	CREATE_NEW	Static method	Public	Method	Generate federation entry	20090203
5	CREATE_PERSISTENT	Instance method	Private	Method	Generate new federation entry	20090203
6	CREATE_TRANSIENT	Instance method	Private	Method	Generates a federation object	20090203
7	CREATE_USREXTID	Instance method	Private	Method	Generate federation entry in USREXTID	20090203
8	DELETE	Instance method	Public	Method	Deletes the federation	20081119
9	GET_IDP_USER_ID	Static method	Public	Method	Determines the IDP user ID based on NameID and SAP-ID	20081208
10	GET_SAP_USER_ID	Instance method	Public	Method	Determines the SAP user name based on assertions	20081118
11	GET_SAP_USER_ID_FROM_USREXTID	Static method	Private	Method	Determines the SAP user name using the table USREXTID	20090129
12	GET_USER_FEDERATIONS	Static method	Public	Method	Get all user federations	20090424
13	GET_USER_FROM_ASSRT_ATTRIBUTES	Static method	Private	Method	Searches for user ID in the assertion attributes	20130705
14	MAP_USERSOURCE_TO_USER_ID	Static method	Private	Method	Maps user source to user ID and stores it in io_object param	20130705
15	SAVE	Instance method	Private	Method	Stores the Federation	20081119

Events

Class CL_SAML20_FEDERATION has no event.

Types

Class CL_SAML20_FEDERATION has no local type.

Method Signatures

Method CHANGE_NAMEID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_NAMEID_NEW	Call by reference	☐	Type reference (TYPE)	SAML2_NAMEID_IDP		SAML2 Name am IDP	20090120

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	Oberklasse SAML20 Ausnahmen	20090120

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ENTITY_OBJ	Call by reference	☐	Object reference (TYPE REF TO)	CL_SAML20_ENTITY		SAML20 Entitätsobjekt	20081118

Method CONSTRUCTOR on class CL_SAML20_FEDERATION has no exception.

Method CREATE_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	CL_SAML20_FEDERATION		SAML20 Federationobjekt	20081118
2	Importing	IF_NAMEID	Call by reference	☐	Type reference (TYPE)	SAML2_NAMEID_IDP			20090309
3	Importing	IF_NAMEID_KEY	Call by reference	☐	Type reference (TYPE)	SAML2_NAMEID_KEY			20090309
4	Importing	IF_NAMEQUALIFIER	Call by reference	☐	Type reference (TYPE)	STRING			20090326
5	Importing	IF_NO_FORMAT_CHECK	Call by reference	☐	Type reference (TYPE)	SAML2_BOOLEAN	ABAP_FALSE	SAML2 Wahrheitswert	20090424
6	Importing	IF_SPNAMEQUAL_KEY	Call by reference	☐	Type reference (TYPE)	SAML2_ENTITY_KEY			20090309
7	Importing	IF_UNSPECIFIED_MAPPING	Call by reference	☐	Type reference (TYPE)	SAML2_ID_MAPPING_UNSPECIFIED	IF_SAML20_CONSTANTS=>CO_LOGONTYPE_USER	Nicht-definierte Benutzerzuordnung	20090424
8	Importing	IO_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	CL_SAML20_ENTITY		SAML20 Entitätsobjekt	20081118
9	Importing	IO_TRUSTED_ENTITY_OBJ	Call by reference	☑	Object reference (TYPE REF TO)	CL_SAML20_ENTITY		SAML20 Entitätsobjekt	20090326
10	Importing	IT_ASSERTION_ATTRIBUTES	Call by reference	☑	Type reference (TYPE)	SAML2_ASSERTION_ATTRIBUTES_T		Table of SAML2 attribute couples	20100721

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	Oberklasse SAML20 Ausnahmen	20081121

Method CREATE_NEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	CL_SAML20_FEDERATION		SAML20 Federationobjekt	20090203
2	Importing	IF_NAMEID	Call by reference	☐	Type reference (TYPE)	SAML2_NAMEID_IDP		SAML2 Name am IDP	20090309
3	Importing	IF_NAMEID_KEY	Call by reference	☐	Type reference (TYPE)	SAML2_NAMEID_KEY		Schlüssel der SAML2 Entitätskennungs	20090309
4	Importing	IF_NAMEQUALIFIER	Call by reference	☑	Type reference (TYPE)	STRING		NameQualifier	20090326
5	Importing	IF_NO_FORMAT_CHECK	Call by reference	☐	Type reference (TYPE)	SAML2_BOOLEAN	ABAP_FALSE	SAML2 Wahrheitswert	20090424
6	Importing	IF_SPNAMEQUAL_KEY	Call by reference	☐	Type reference (TYPE)	SAML2_ENTITY_KEY		Schlüssel der SAML2 Entitätskennungs	20090309
7	Importing	IF_UNSPECIFIED_MAPPING	Call by reference	☐	Type reference (TYPE)	SAML2_ID_MAPPING_UNSPECIFIED	IF_SAML20_CONSTANTS=>CO_LOGONTYPE_USER	Nicht-definierte Benutzerzuordnung	20090424
8	Importing	IF_USER	Call by reference	☐	Type reference (TYPE)	XUBNAME		Benutzername im Benutzerstamm	20090203
9	Importing	IO_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	CL_SAML20_ENTITY		SAML20 Entitätsobjekt	20090203
10	Importing	IO_TRUSTED_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	CL_SAML20_ENTITY		SAML20 Entitätsobjekt	20090326

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	Oberklasse SAML20 Ausnahmen	20090203

Method CREATE_PERSISTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_NAMEID	Call by reference	☐	Type reference (TYPE)	SAML2_NAMEID_IDP		SAML2 Name am IDP	20090309

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	Oberklasse SAML20 Ausnahmen	20090203

Method CREATE_TRANSIENT Signature

Method CREATE_TRANSIENT on class CL_SAML20_FEDERATION has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	Oberklasse SAML20 Ausnahmen	20090203

Method CREATE_USREXTID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	SAML2_ENTITY_NAME		SAML2 Entitätskennung	20090326
2	Importing	IF_NAMEID	Call by reference	☐	Type reference (TYPE)	SAML2_NAMEID_IDP		SAML2 Name am IDP	20090309
3	Importing	IF_NAMEQUALIFIER	Call by reference	☐	Type reference (TYPE)	STRING		NameQualifier	20090326

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	Oberklasse SAML20 Ausnahmen	20090203

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_COMMIT_WORK	Call by reference	☐	Type reference (TYPE)	SAML2_BOOLEAN	ABAP_FALSE	SAML2 Wahrheitswert	20081119

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	Oberklasse SAML20 Ausnahmen	20081119

Method GET_IDP_USER_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_IDP_ID	Call by reference	☐	Type reference (TYPE)	STRING		IDP Benutzerkennung	20081208
2	Exporting	EF_NAME_FORMAT	Call by reference	☐	Type reference (TYPE)	SAML2_NAMEID_FORMAT		SAML2 NameID Format	20081208
3	Importing	IF_IDP_KEY	Call by reference	☐	Type reference (TYPE)	SAML2_ENTITY_KEY		Schlüssel der SAML2 Entitätskennungs	20081208
4	Importing	IF_NAMEID_KEY	Call by reference	☐	Type reference (TYPE)	SAML2_NAMEID_KEY		SAML2 NameID Schlüssel	20081208
5	Importing	IF_SAP_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT	SY-MANDT	Mandantenkennung des aktuellen Benutzers	20081222
6	Importing	IF_SAP_USER_ID	Call by reference	☐	Type reference (TYPE)	XUBNAME	SY-UNAME	Benutzername	20081208

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	Oberklasse SAML20 Ausnahmen	20090129

Method GET_SAP_USER_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RF_USER_ID	Value transfer	☐	Type reference (TYPE)	XUBNAME		Benutzername im Benutzerstamm	20081118

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	Oberklasse SAML20 Ausnahmen	20081118

Method GET_SAP_USER_ID_FROM_USREXTID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_USER_ID	Call by reference	☐	Type reference (TYPE)	XUBNAME		Benutzername im Benutzerstamm	20090129
2	Exporting	EF_USREXTID_TYPE	Call by reference	☐	Type reference (TYPE)	EXTID_TYPE		Struktur mit einer externen ID	20090203
3	Importing	IF_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT	SY-MANDT	Mandant	20090326
4	Importing	IF_ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	SAML2_ENTITY_NAME		SAML2 Entitätskennung	20090325
5	Importing	IF_NAMEID_IDP	Call by reference	☐	Type reference (TYPE)	SAML2_NAMEID_IDP		SAML2 Name am IDP	20090129
6	Importing	IF_NAMEID_KEY	Call by reference	☐	Type reference (TYPE)	SAML2_NAMEID_KEY		SAML2 NameID Schlüssel	20090129
7	Importing	IF_NAMEQUALIFIER	Call by reference	☐	Type reference (TYPE)	STRING		NameQualifier	20090326

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	Oberklasse SAML20 Ausnahmen	20090129

Method GET_USER_FEDERATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FEDERATION	Call by reference	☐	Type reference (TYPE)	SAML2_FEDERATION_T		SAML2 Federation Tabelle	20090424
2	Importing	IF_USER_ID	Call by reference	☐	Type reference (TYPE)	XUBNAME		Benutzername im Benutzerstamm	20090424

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	Oberklasse SAML20 Ausnahmen	20090424

Method GET_USER_FROM_ASSRT_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ASSERTION_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	SAML2_ASSERTION_ATTRIBUTES_T		Table of SAML2 attribute couples	20130705
2	Importing	IV_ATTR_NAME	Call by reference	☐	Type reference (TYPE)	SAML2_ATTR_NAME		SAML2 attribute name	20130705
3	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	STRING		User Name in User Master Record	20130705

#	Exception	Resumable	Description	Created on
1	CX_SAML20_FEDERATION	☐	User Federation Exceptions	20130705

Method MAP_USERSOURCE_TO_USER_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_FEDERATION	Call by reference	☑	Object reference (TYPE REF TO)	CL_SAML20_FEDERATION		SAML20 Federation Object	20130705
2	Importing	IO_TRACE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SAML20_TRACE		SAML 2.0 Tracing	20130705
3	Importing	IT_ASSERTION_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	SAML2_ASSERTION_ATTRIBUTES_T		Table of SAML2 attribute couples	20130705
4	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Client	20130705
5	Importing	IV_NAMEID	Call by reference	☐	Type reference (TYPE)	SAML2_NAMEID_IDP		SAML2 Name at Identity Provider	20130705
6	Importing	IV_NAMEQUALIFIER	Call by reference	☑	Type reference (TYPE)	STRING			20130705
7	Importing	IV_NAME_ID_KEY	Call by reference	☐	Type reference (TYPE)	SAML2_NAMEID_KEY		SAML2 Logon Format	20130705

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	User Federation Exceptions	20130705

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_COMMIT_WORK	Call by reference	☐	Type reference (TYPE)	SAML2_BOOLEAN	ABAP_FALSE	SAML2 Wahrheitswert	20081119

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	Oberklasse SAML20 Ausnahmen	20081119

History

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