SAP ABAP Class CL_HTTP_SECURITY_SESSION_ICF (HTTP Security Session Management, ICF Usage)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SEC-LGN (Application Component) Authentication and SSO
     ⤷ SHTTP_SECURITY_SESSIONS (Package) HTTP Security Session Management

Properties

Class	CL_HTTP_SECURITY_SESSION_ICF
Short Description	HTTP Security Session Management, ICF Usage
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	SHTTP_SECURITY_SESSIONS	HTTP Security Session Management
Created	20081121	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	CL_HTTP_SECURITY_SESSION	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_HTTP_SECURITY_SESSION_ICF has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_HTTP_EXT_MYSSOCNTL	☐	20110530	HTTP Framework (iHTTP) HTTP Request Handler for PING
2	CL_HTTP_SECURITY_SESSION_SAML	☐	20090716	HTTP Security Session Management for SAML (SP)
3	CL_HTTP_SERVER_NET	☐	20081121	Derived HTTP Server Class for Network Communication
4	CL_ICF_SYSTEM_LOGIN	☐	20090401	ICF System Logon

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_AUTHNMETHOD_ASSERTIONTICKET	Constant	Public	☐	Type reference (TYPE)	SECURITY_SESSION_AUTHN_METHOD	CL_HTTP_SECURITY_SESSION=>CO_AUTHNMETHOD_ASSERTIONTICKET	Logon with Assertion Ticket	20090310
2	CO_AUTHNMETHOD_LOCALHTTPCALL	Constant	Public	☐	Type reference (TYPE)	SECURITY_SESSION_AUTHN_METHOD	CL_HTTP_SECURITY_SESSION=>CO_AUTHNMETHOD_LOCALHTTPCALL	Local HTTP Call (Same System)	20090310
3	CO_AUTHNMETHOD_LOGONTICKET	Constant	Public	☐	Type reference (TYPE)	SECURITY_SESSION_AUTHN_METHOD	CL_HTTP_SECURITY_SESSION=>CO_AUTHNMETHOD_LOGONTICKET	Logon with Logon Ticket	20090310
4	CO_AUTHNMETHOD_PASSWORD	Constant	Public	☐	Type reference (TYPE)	SECURITY_SESSION_AUTHN_METHOD	CL_HTTP_SECURITY_SESSION=>CO_AUTHNMETHOD_PASSWORD	Password Logon	20090310
5	CO_AUTHNMETHOD_SAML	Constant	Public	☐	Type reference (TYPE)	SECURITY_SESSION_AUTHN_METHOD	CL_HTTP_SECURITY_SESSION=>CO_AUTHNMETHOD_SAML	SAML Logon	20090310
6	CO_AUTHNMETHOD_SPNEGO	Constant	Public	☐	Type reference (TYPE)	SECURITY_SESSION_AUTHN_METHOD	CL_HTTP_SECURITY_SESSION=>CO_AUTHNMETHOD_SPNEGO	SPNego Logon	20120709
7	CO_AUTHNMETHOD_TRUSTEDSYSTEM	Constant	Public	☐	Type reference (TYPE)	SECURITY_SESSION_AUTHN_METHOD	CL_HTTP_SECURITY_SESSION=>CO_AUTHNMETHOD_TRUSTEDSYSTEM	Trusted System Logon	20090310
8	CO_AUTHNMETHOD_X509CERT	Constant	Public	☐	Type reference (TYPE)	SECURITY_SESSION_AUTHN_METHOD	CL_HTTP_SECURITY_SESSION=>CO_AUTHNMETHOD_X509CERT	X.509 Certificate Logon	20090310
9	CO_COOKIE_NAME_TEMPLATE	Constant	Private	☐	Type reference (TYPE)	STRING	'SAP_SESSIONID__'	Cookie Name (Before Variable Substitution)	20081127

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_SECURITY_SESSION_AUTHN	Static method	Protected	Method	Check whether requested (local) logon is covered	20081121
2	CHECK_SECURITY_SESSION_AUTHNL	Static method	Protected	Method	Check whether requested (local) logon is covered	20090119
3	CHECK_SECURITY_SESSION_ID	Static method	Protected	Method	Check Session ID, Refresh Time Stamp	20081121
4	CONFIRM_USERSWITCH_FOR_ITS	Static method	Public	Method	See Function Module HTTP_CONFIRM_USERSWITCH	20110525
5	CREATE_SESSION_AFTER_LOCALAUTH	Static method	Protected	Method	Creation of Security Session After Local Logon	20081121
6	SECURITY_SESSIONID_COOKIE_NAME	Static method	Public	Method	Name of Cookie (Transport of Security Session ID)	20081127
7	SESSION_MANAGEMENT_IS_ACTIVE	Static method	Public	Method	Information: Is HTTP Security Session Management active?	20081121
8	TERMINATE_SECURITY_SESSION	Static method	Protected	Method	Exit Security Session and All Application Sessions	20081121
9	UPDATE_SESSION_AFTER_LOCALAUTH	Static method	Protected	Method	Refreshing Security Session After Reauthentication	20081121

Events

Class CL_HTTP_SECURITY_SESSION_ICF has no event.

Types

Class CL_HTTP_SECURITY_SESSION_ICF has no local type.

Method Signatures

Method CHECK_SECURITY_SESSION_AUTHN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Mandant	20081121
2	Importing	CONTEXT_ID	Call by reference	☐	Type reference (TYPE)	SECURITY_CONTEXT_ID		Security Kontext-ID (interne Darstellung der Session-ID)	20081121
3	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	XULANGU		Anmeldesprache	20081121
4	Exporting	PWDSTATE	Call by reference	☐	Type reference (TYPE)	XUPWDSTATE		Status des Benutzerkennworts (Werte: -2/-1/0/1/2/3, s. Doku)	20081121
5	Importing	REQUESTED_AUTHMETHOD	Call by reference	☐	Type reference (TYPE)	SECURITY_SESSION_AUTHN_METHOD		HTTP-Anmeldeverfahren (Ablage im Sicherheitskontext)	20081121
6	Exporting	RESULT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Kennzeichen: Session-Session deckt Anmeldeanforderung ab	20081121
7	Importing	SERVER	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20090324

#	Exception	Resumable	Description	Created on
1	CX_HTTP_SECURITY_SESSION	☐	Ausnahme-Klasse zu CL_HTTP_SECURITY_SESSION	20081121

Method CHECK_SECURITY_SESSION_AUTHNL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Mandant	20090119
2	Importing	CONTEXT_ID	Call by reference	☐	Type reference (TYPE)	SECURITY_CONTEXT_ID		Security Kontext-ID (interne Darstellung der Session-ID)	20090119
3	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	XULANGU		Anmeldesprache	20090119
4	Exporting	PWDSTATE	Call by reference	☐	Type reference (TYPE)	XUPWDSTATE		Status des Benutzerkennworts (Werte: -2/-1/0/1/2/3, s. Doku)	20090119
5	Importing	REQUESTED_AUTHMETHODS	Call by reference	☐	Type reference (TYPE)	AUTHENTICATION_METHOD_LIST		Liste: Authentisierungsmethoden (Service-Anforderung)	20090119
6	Exporting	RESULT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Kennzeichen: Session-Session deckt Anmeldeanforderung ab	20090119
7	Importing	SERVER	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20090324

#	Exception	Resumable	Description	Created on
1	CX_HTTP_SECURITY_SESSION	☐	Ausnahme-Klasse zu CL_HTTP_SECURITY_SESSION	20090119

Method CHECK_SECURITY_SESSION_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Mandant	20081121
2	Exporting	CONTEXT_ID	Call by reference	☐	Type reference (TYPE)	SECURITY_CONTEXT_ID		Security Kontext-ID (interne Darstellung der Session-ID)	20081121
3	Importing	SESSION_ID	Call by reference	☐	Type reference (TYPE)	SECURITY_SESSION_ID		Security Session ID (wird per Cookie übertragen)	20081121
4	Exporting	USERID	Call by reference	☐	Type reference (TYPE)	XUBNAME		Benutzername im Benutzerstamm	20081121

#	Exception	Resumable	Description	Created on
1	CX_HTTP_SECURITY_SESSION	☐	Ausnahme-Klasse zu CL_HTTP_SECURITY_SESSION	20081121

Method CONFIRM_USERSWITCH_FOR_ITS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SESSION_ID	Value transfer	☐	Type reference (TYPE)	SECURITY_SESSION_ID		Security Session ID (wird per Cookie übertragen)	20110525

#	Exception	Resumable	Description	Created on
1	CX_HTTP_SECURITY_SESSION	☐	Ausnahme-Klasse zu CL_HTTP_SECURITY_SESSION	20110525

Method CREATE_SESSION_AFTER_LOCALAUTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AUTHENTICATION_METHOD	Call by reference	☐	Type reference (TYPE)	SECURITY_SESSION_AUTHN_METHOD		HTTP-Anmeldeverfahren (Ablage im Sicherheitskontext)	20081121
2	Returning	SESSION_ID	Value transfer	☐	Type reference (TYPE)	SECURITY_SESSION_ID		Security Session ID (wird per Cookie übertragen)	20081121

#	Exception	Resumable	Description	Created on
1	CX_HTTP_SECURITY_SESSION	☐	Ausnahme-Klasse zu CL_HTTP_SECURITY_SESSION	20081121

Method SECURITY_SESSIONID_COOKIE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT	SY-MANDT	Mandant	20081127
2	Returning	COOKIE_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20081127

Method SECURITY_SESSIONID_COOKIE_NAME on class CL_HTTP_SECURITY_SESSION_ICF has no exception.

Method SESSION_MANAGEMENT_IS_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT	SY-MANDT	Mandant	20081121
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Schalter: HTTP Security Session Management aktiv / inaktiv	20081121

Method SESSION_MANAGEMENT_IS_ACTIVE on class CL_HTTP_SECURITY_SESSION_ICF has no exception.

Method TERMINATE_SECURITY_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Mandant	20081121
2	Importing	PROPAGATE_LOGOFF	Call by reference	☐	Type reference (TYPE)	SAP_BOOL	ABAP_TRUE	Abmeldung weiterleiten	20090716
3	Importing	REDIRECT_URL	Call by reference	☑	Type reference (TYPE)	STRING		nach der Abmeldung gerufene URL	20130906
4	Exporting	RESULT	Call by reference	☐	Type reference (TYPE)	SESSION_TERMINATION_RESULT		textuelle Rückmeldung über den Erfolg eines Abmeldevorgangs	20090323
5	Importing	SERVER	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20081202
6	Importing	SESSION_ID	Call by reference	☐	Type reference (TYPE)	SECURITY_SESSION_ID		Security Session ID (wird per Cookie übertragen)	20081121

#	Exception	Resumable	Description	Created on
1	CX_HTTP_SECURITY_SESSION	☐	Ausnahme-Klasse zu CL_HTTP_SECURITY_SESSION	20081121

Method UPDATE_SESSION_AFTER_LOCALAUTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AUTHENTICATION_METHOD	Call by reference	☐	Type reference (TYPE)	SECURITY_SESSION_AUTHN_METHOD		HTTP-Anmeldeverfahren (Ablage im Sicherheitskontext)	20081121
2	Importing	CURRENT_CONTEXT_ID	Call by reference	☐	Type reference (TYPE)	SECURITY_CONTEXT_ID		Security Kontext-ID (interne Darstellung der Session-ID)	20081121
3	Returning	NEW_SESSION_ID	Value transfer	☐	Type reference (TYPE)	SECURITY_SESSION_ID		Security Session ID (wird per Cookie übertragen)	20081121

#	Exception	Resumable	Description	Created on
1	CX_HTTP_SECURITY_SESSION	☐	Ausnahme-Klasse zu CL_HTTP_SECURITY_SESSION	20081121

History

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