SAP ABAP Class CL_SAML20_UTILITY (utility class)

Hierarchy

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

Properties

Class	CL_SAML20_UTILITY
Short Description	utility class
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SAML2_CORE	SAML2 Core Functionality
Created	20100202	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...
3	IF_T100_MESSAGE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_SAML20_UTILITY has no interface implemented.

Friends

Class CL_SAML20_UTILITY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_COLON	Constant	Public	☐	Type reference (TYPE)	STRING	':'		20120326
2	GC_COLON_DOUBLE_SLASH	Constant	Public	☐	Type reference (TYPE)	STRING	'://'	The URL schema separator	20120326
3	GC_HTTPS_PORT	Constant	Public	☐	Type reference (TYPE)	STRING	'443'		20120327
4	GC_HTTPS_PROTOCOL	Constant	Public	☐	Type reference (TYPE)	STRING	'https'		20120327
5	GC_HTTP_PORT	Constant	Public	☐	Type reference (TYPE)	STRING	'80'		20120327
6	GC_HTTP_PROTOCOL	Constant	Public	☐	Type reference (TYPE)	STRING	'http'		20120327
7	GC_NUMBER_SIGN	Constant	Public	☐	Type reference (TYPE)	STRING	'#'		20120326
8	GC_QUESTION_MARK	Constant	Public	☐	Type reference (TYPE)	STRING	'?'		20120326
9	GC_SLASH	Constant	Public	☐	Type reference (TYPE)	STRING	'/'		20120326

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_ACTIVE_TRUSTED_ENTITY	Static method	Public	Method	Checks existence of active trusted entity	20121005
2	CHECK_BAPI_RESULT	Static method	Public	Method	Checks the result of a BAPI call	20130618
3	CHECK_SSF_APPLICATION	Static method	Private	Method	Check if SSF application exists and creates one	20100202
4	COMPARE_URIS	Static method	Public	Method	Compare 2 URIs as per RFC 2396	20120327
5	COPY_PSE	Static method	Public	Method	Copies PSE from source SSF application to target one	20100202
6	GET_APPLICATION_URI	Static method	Public	Method	Returns path or URL without SAMLart	20120113
7	GET_BASE_URL	Static method	Public	Method	Return the base URL (protocol + host + port)	20110203
8	GET_COMPARISON_METHOD	Static method	Public	Method	Get the comparison method corresponding to the input string	20101206
9	GET_COMPARISON_METHOD_STRING	Static method	Public	Method	Get the comparison method as string	20101202
10	GET_ORIGINAL_PROTOCOL	Static method	Public	Method	Returns the HTTP protocol (also in case of reverse proxy)	20110517
11	GET_PSE_NAME	Static method	Public	Method	Get PSE file name by SSF application	20110419
12	GET_TEXT_WITH_PARAMS	Static method	Public	Method	Returns the text with replaced real params	20100305
13	GET_URL_FIELD	Static method	Public	Method	Return the value for the specified field in specified URL	20110203
14	IS_SSL_ACTIVE	Static method	Public	Method	Checks if HTTPS is used (also in case of reverse proxy)	20110513
15	IS_URL_VALID	Static method	Public	Method	Check URL if it is valid	20110214
16	LOCK_PSE	Static method	Public	Method	Lock PSE by provided SSF application	20110411
17	NORMALIZE_URL	Static method	Public	Method	Adds default port to the URL if it does not contain it	20110513
18	PARSE_SA_USREXTID_ENTRY	Static method	Public	Method		20100304
19	SET_SSF_APPL_HASH_ALGORITHM	Static method	Public	Method	Sets the hash algorithm for the specified SSF application	20110415
20	SPLIT_URI	Static method	Public	Method	Splits an URI to its parts	20120326
21	UNLOCK_PSE	Static method	Public	Method	Unlock PSE by provided SSF application	20110411
22	URLS_EQUAL	Static method	Public	Method	Checks if two URLs are equal	20110515

Events

Class CL_SAML20_UTILITY has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_BAPIRET_TABLE	Public	See coding			20130618	ty_bapiret_table type table of bapiret2

Method Signatures

Method CHECK_ACTIVE_TRUSTED_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Client	20121005
2	Importing	IV_ENTITY_MODE	Call by reference	☐	Type reference (TYPE)	SAML2_ENTITY_MODE	IF_SAML20_CONSTANTS=>CO_ENTITY_MODE_IDP	Operation Mode of SAML2 Entity	20121005
3	Importing	IV_TRUSTED_ENTITY_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name of the trusted entity	20121005
4	Returning	RV_EXISTS_ACTIVE	Value transfer	☐	Type reference (TYPE)	SAML2_BOOLEAN		True if trusted entity exists and is active	20121005

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	Exceptions Within SAML2 Core Function	20121005

Method CHECK_BAPI_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_BAPI_RES	Call by reference	☐	Type reference (TYPE)	TY_BAPIRET_TABLE			20130618
2	Importing	IV_BAPI_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20130618
3	Importing	IV_TEXTID	Call by reference	☐	Attribute reference (LIKE)	IF_T100_MESSAGE=>T100KEY		T100 Key with Parameters Mapped to Attribute Names	20130618
4	Importing	IV_TRACE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SAML20_TRACE		SAML 2.0 Tracing	20130618

#	Exception	Resumable	Description	Created on
1	CX_SAML20_CORE	☐	Exceptions Within SAML2 Core Function	20130618

Method CHECK_SSF_APPLICATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_SSFAPPL	Call by reference	☐	Type reference (TYPE)	SSFAPPL		SSF Application	20100202

Method CHECK_SSF_APPLICATION on class CL_SAML20_UTILITY has no exception.

Method COMPARE_URIS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_URI_1	Call by reference	☐	Type reference (TYPE)	STRING			20120327
2	Importing	IV_URI_2	Call by reference	☐	Type reference (TYPE)	STRING			20120327
3	Returning	RV_EQUAL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Returns TRUE if the URIs are equal	20120327

Method COMPARE_URIS on class CL_SAML20_UTILITY has no exception.

Method COPY_PSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_SOURCE_SSFA	Call by reference	☐	Type reference (TYPE)	SSFAPPL		SSF Application	20100202
2	Importing	IF_TARGET_SSFA	Call by reference	☐	Type reference (TYPE)	SSFAPPL		SSF Application	20100202

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	SAML20 Superclass Exceptions	20100202

Method GET_APPLICATION_URI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20120113
2	Exporting	EF_URL	Call by reference	☐	Type reference (TYPE)	STRING			20120113
3	Importing	IO_HTTP_SERVER	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20120113
4	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Client	20120113

Method GET_APPLICATION_URI on class CL_SAML20_UTILITY has no exception.

Method GET_BASE_URL Signature

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

Method GET_BASE_URL on class CL_SAML20_UTILITY has no exception.

Method GET_COMPARISON_METHOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMPARISON_METHOD	Call by reference	☐	Type reference (TYPE)	STRING		Comparison method as string	20101206
2	Returning	RV_COMPARISON_METHOD	Value transfer	☐	Type reference (TYPE)	SAML2_COMPARISON_METHOD		Comparison method	20101206

Method GET_COMPARISON_METHOD on class CL_SAML20_UTILITY has no exception.

Method GET_COMPARISON_METHOD_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMPARISON_METHOD	Call by reference	☐	Type reference (TYPE)	SAML2_COMPARISON_METHOD		Comparison method	20101202
2	Returning	RV_COMPARISON_METHOD	Value transfer	☐	Type reference (TYPE)	STRING		Comparison method as string	20101202

Method GET_COMPARISON_METHOD_STRING on class CL_SAML20_UTILITY has no exception.

Method GET_ORIGINAL_PROTOCOL 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	20110517
2	Returning	RV_PROTOCOL	Value transfer	☐	Type reference (TYPE)	STRING			20110517

Method GET_ORIGINAL_PROTOCOL on class CL_SAML20_UTILITY has no exception.

Method GET_PSE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_PSE_NAME	Call by reference	☐	Type reference (TYPE)	SSFPSENAME		PSE file name	20110419
2	Exporting	EV_RCODE	Call by reference	☐	Type reference (TYPE)	SY-SUBRC		Return Value of ABAP Statements	20110419
3	Importing	IV_SSFAPPL	Call by reference	☐	Type reference (TYPE)	SSFAPPL		SSF Application	20110419

Method GET_PSE_NAME on class CL_SAML20_UTILITY has no exception.

Method GET_TEXT_WITH_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PARAM1	Call by reference	☑	Type reference (TYPE)	STRING			20100305
2	Importing	IV_PARAM2	Call by reference	☑	Type reference (TYPE)	STRING			20100305
3	Importing	IV_PARAM3	Call by reference	☑	Type reference (TYPE)	STRING			20100305
4	Importing	IV_PARAM4	Call by reference	☑	Type reference (TYPE)	STRING			20100305
5	Importing	IV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20100305
6	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20100305

Method GET_TEXT_WITH_PARAMS on class CL_SAML20_UTILITY has no exception.

Method GET_URL_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Field name	20110203
2	Importing	IV_URL	Call by reference	☐	Type reference (TYPE)	STRING		The URL	20110203
3	Returning	RV_FIELD_VALUE	Value transfer	☐	Type reference (TYPE)	STRING		Filed value (empty if field not found)	20110203

Method GET_URL_FIELD on class CL_SAML20_UTILITY has no exception.

Method IS_SSL_ACTIVE 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	20110513
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20110513

Method IS_SSL_ACTIVE on class CL_SAML20_UTILITY has no exception.

Method IS_URL_VALID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_URL	Call by reference	☐	Type reference (TYPE)	STRING			20110214
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20110214

Method IS_URL_VALID on class CL_SAML20_UTILITY has no exception.

Method LOCK_PSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PSE_NAME	Call by reference	☐	Type reference (TYPE)	SSFPSENAME		SSF Application	20110427
2	Returning	RV_RCODE	Value transfer	☐	Type reference (TYPE)	SY-SUBRC			20110411

Method LOCK_PSE on class CL_SAML20_UTILITY has no exception.

Method NORMALIZE_URL Signature

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

Method NORMALIZE_URL on class CL_SAML20_UTILITY has no exception.

Method PARSE_SA_USREXTID_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_NAMEID_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20100304
2	Exporting	EV_NAME_QUALIFIER	Call by reference	☐	Type reference (TYPE)	STRING			20100304
3	Exporting	EV_TRUSTED_PROVIDER_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100304
4	Importing	IV_USREXTID_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20100304

#	Exception	Resumable	Description	Created on
1	CX_SAML20	☐	SAML20 Superclass Exceptions	20100304

Method SET_SSF_APPL_HASH_ALGORITHM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT	SY-MANDT	Client	20110415
2	Importing	IV_HASHALG	Call by reference	☐	Type reference (TYPE)	SSFHASH		SSF Hash Algorithm	20110415
3	Importing	IV_SIGNALG	Call by reference	☐	Type reference (TYPE)	SSFFORM		SSF format (DSA...)	20110415
4	Importing	IV_SSFAPPL	Call by reference	☐	Type reference (TYPE)	SSFAPPL		SSF Application	20110415

Method SET_SSF_APPL_HASH_ALGORITHM on class CL_SAML20_UTILITY has no exception.

Method SPLIT_URI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_FRAGMENT	Call by reference	☐	Type reference (TYPE)	STRING			20120326
2	Exporting	EV_HOST	Call by reference	☐	Type reference (TYPE)	STRING			20120326
3	Exporting	EV_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20120326
4	Exporting	EV_PORT	Call by reference	☐	Type reference (TYPE)	STRING			20120326
5	Exporting	EV_PROTOCOL	Call by reference	☐	Type reference (TYPE)	STRING			20120326
6	Exporting	EV_QUERY	Call by reference	☐	Type reference (TYPE)	STRING			20120326
7	Importing	IV_URI	Call by reference	☐	Type reference (TYPE)	STRING			20120326

Method SPLIT_URI on class CL_SAML20_UTILITY has no exception.

Method UNLOCK_PSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PSE_NAME	Call by reference	☐	Type reference (TYPE)	SSFPSENAME		SSF Application	20110419

#	Exception	Resumable	Description	Created on
1	CX_SAML20_CORE	☐	Exceptions Within SAML2 Core Function	20110428

Method URLS_EQUAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_URL1	Call by reference	☐	Type reference (TYPE)	STRING			20110515
2	Importing	IV_URL2	Call by reference	☐	Type reference (TYPE)	STRING			20110515
3	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20110515

Method URLS_EQUAL on class CL_SAML20_UTILITY has no exception.

History

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