SAP ABAP Class CL_ICF_TREE (ICF: API for ICF Tree)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-MID-ICF (Application Component) Internet Communication Framework
     ⤷ SHTTP (Package) Development Class for HTTP Communication

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ICF_TREE	ICF: Interface for ICF Tree	20030507

Properties

Class	CL_ICF_TREE
Short Description	ICF: API for ICF Tree
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status	S	System Program
Category	0
Package	SHTTP	Development Class for HTTP Communication
Created	20030507	SAP
Last change	20140121	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	IHTTP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ICF_TREE	☐	☐	ICF: Interface for ICF Tree	20030507

Friends

Class CL_ICF_TREE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_AFTERIMP_EVENT	Constant	Public	☐	Type reference (TYPE)	STRING	'TRINT_CALL_AFTER_IMP_METHOD'		20121210
2	CO_CERTIF	Constant	Public	☐	Type reference (TYPE)	C	'C'		20041230
3	CO_LOGFLAG	Constant	Public	☐	Type reference (TYPE)	C	'L'		20041230
4	CO_OBLIG	Constant	Public	☐	Type reference (TYPE)	C	'O'		20041230
5	CO_SECURE_ALIAS	Constant	Public	☐	See coding		'%_PWD'		20040726
6	CO_SECURE_DELETE	Constant	Public	☐	Type reference (TYPE)	I	2		20040726
7	CO_SECURE_INSERT	Constant	Public	☐	Type reference (TYPE)	I	0		20040726
8	CO_SECURE_PREFIX	Constant	Public	☐	See coding		'/ICF/'		20040726
9	CO_SHA1_PREFIX	Constant	Public	☐	Type reference (TYPE)	C	'#'		20051207
10	M_INACTIVE	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Set this to "X" if at least one service is inactive	20131129

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_DOUBLE_ICFNODGUID	Static method	Public	Method	Checks Consistency for Duplicate NODGUIDs	20050114
2	CHECK_ICFAPPLICATION	Static method	Public	Method	Check ICFAPPLICATION	20030612
3	GET_INSTACT_GROUP_LIST	Static method	Public	Method	Gives all groups of ICFINSTACT	20080922
4	GET_INSTACT_GROUP_STATUS	Static method	Public	Method	Gives status of groups in ICFINSTACT	20080922
5	GET_LOGON_DATA	Static method	Public	Method	Returns logon data from service/alias	20080922
6	GET_SUBNODES	Static method	Public	Method	Gets all child nodes	20071213
7	IS_EXTENDED_ALIAS_EXIST	Static method	Public	Method	Does an external alias exist with extend alias name?	20051128
8	IS_SERVICE_ACTIVE	Static method	Public	Method	Is service active?	20080926
9	IS_SERVICE_LAST_NODE	Static method	Public	Method	Is service a leaf node (no child node)?	20091210
10	READ_SERVICES_FROM_STRING	Static method	Public	Method	List Data from String Data Field	20041118
11	REORG_ICF_SERVICES	Static method	Private	Method	Reorganization of ICF Services	20121210
12	SET_ACTLOGIN	Static method	Private	Method	Set Inheritance Information	20041109
13	SET_ALIASTRING_HASHVALUE	Static method	Public	Method	Sets and checks extended external alias name	20051202
14	SET_INSTACT_GROUP_ACTIVE	Static method	Public	Method	Activates all services of a group from ICFINSTACT	20080925
15	SET_INSTACT_GROUP_INACTIVE	Static method	Public	Method	Deactivates all services of a group from ICFINSTACT	20080925
16	SET_LOGIN_PROCESS	Static method	Public	Method	Combines Logon Procedures in One Field	20041110
17	SET_LOGON_DATA	Static method	Public	Method	Sets logon data in service/alias	20080922
18	WRITE_SERVICES_TO_STRING	Static method	Public	Method	Writes Data to String Data Field	20041118

Events

Class CL_ICF_TREE has no event.

Types

Class CL_ICF_TREE has no local type.

Method Signatures

Method CHECK_DOUBLE_ICFNODGUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	IT_MESSAGES	Value transfer	☐	Type reference (TYPE)	SPROT_U_TAB		Schnittstelle zur Protokollerstellung	20050114

Method CHECK_DOUBLE_ICFNODGUID on class CL_ICF_TREE has no exception.

Method CHECK_ICFAPPLICATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ALLOW	Call by reference	☐	Type reference (TYPE)	CHAR1		URL und Application sind erlaubt	20030612
2	Importing	APPLICATION	Call by reference	☑	Type reference (TYPE)	UFPS_POSID		Prüfende Komponente	20030612
3	Importing	DEVCLASS	Call by reference	☑	Type reference (TYPE)	DEVCLASS		Entwicklungsklasse	20030807
4	Importing	URL	Call by reference	☐	Type reference (TYPE)	STRING		Zu prüfende Url	20030612

#	Exception	Resumable	Description	Created on
1	DEVCLASS_APPLICATION_NOT_VALID	☐	keine Entwicklungsklasse oder Anwendungskomponente angegeben	20030807
2	NO_APPLICATION_RECORD	☐	Keine Einträge in Applications-Tabelle Vorhanden	20030612
3	NO_COMPONENT	☐	keine Komponnete zu entwicklngsklasse gefunden.	20030813

Method GET_INSTACT_GROUP_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	GROUP_LIST	Value transfer	☐	Type reference (TYPE)	ICFGROUPLIST_T		Tabelle für Werte aus ICFINSTACT	20080922

#	Exception	Resumable	Description	Created on
1	NO_VALIDTITY_GROUPS	☐	keine gültige Gruppen	20080926

Method GET_INSTACT_GROUP_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	GROUP_NAME	Call by reference	☐	Type reference (TYPE)	ICFCHAR30		Gruppennamen	20080925
2	Returning	STATUS	Value transfer	☐	Type reference (TYPE)	ICFACTIVE		'X': Gruppe komplett aktiv, ' ' nicht aktiv	20080925

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	interner Fehler	20080925
2	INVALID_GROUP_NAME	☐	ungültiger Gruppennamen	20080925

Method GET_LOGON_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HOSTNAME	Call by reference	☐	Type reference (TYPE)	ICFNAME	'DEFAULT_HOST'	Name eines Services im Internet Communication Framework	20080923
2	Exporting	ICF_LANGU	Call by reference	☐	Type reference (TYPE)	SPRAS		Sprachenschlüssel	20080923
3	Exporting	ICF_MANDT	Call by reference	☐	Type reference (TYPE)	ICFMANDT		Mandant, unter dem der Service im SAP-System läuft	20080923
4	Exporting	ICF_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME		Benutzername	20080923
5	Importing	NODEGUID	Call by reference	☑	Type reference (TYPE)	ICFNODGUID		GUID eines ICF-Service-Knotens	20080923
6	Importing	URL	Call by reference	☑	Type reference (TYPE)	STRING		URL	20080923

#	Exception	Resumable	Description	Created on
1	EMPTY_NODGUID_OR_URL	☐	leere Url und Nodeguid Angabe	20080923
2	INVALID_URL	☐	ungültige Url	20080923

Method GET_SUBNODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ICFNODGUID	Call by reference	☐	Type reference (TYPE)	ICFNODGUID		GUID eines ICF-Service-Knotens	20071213
2	Changing	IT_SERVTBL	Value transfer	☐	Type reference (TYPE)	ICFSERVTBL		Tabelle von ICF-Services und deren zugehörige Handler	20121120

Method GET_SUBNODES on class CL_ICF_TREE has no exception.

Method IS_EXTENDED_ALIAS_EXIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EXIST	Call by reference	☐	Type reference (TYPE)	CHAR1		Extended Alias existiert	20051128
2	Importing	ICFALIAS_STRG	Call by reference	☐	Type reference (TYPE)	ICFALIAS_STRG		ICF: Verlängerung Externer Aliasnamen (Stringwert)	20051128
3	Importing	ICFPARGUID	Call by reference	☐	Type reference (TYPE)	ICFPARGUID		GUID des Vater-Knotens	20051128
4	Exporting	OUTPUT_ALIAS	Call by reference	☐	Type reference (TYPE)	ICFALIAS		Externe Aliases auf ICF-Services	20051128

#	Exception	Resumable	Description	Created on
1	ERROR_HASHVALUE	☐	Fehlerhafte Hashwert-Ermittlung	20051128

Method IS_SERVICE_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ACTIVE	Value transfer	☐	Type reference (TYPE)	ICFACTIVE		'X': Service ist aktiviert, sonst ' '	20080926
2	Importing	HOSTNAME	Call by reference	☑	Type reference (TYPE)	ICFNAME		Name eines Services im Internet Communication Framework	20080926
3	Importing	NODEGUID	Call by reference	☑	Type reference (TYPE)	ICFNODGUID		GUID eines ICF-Service-Knotens	20080926
4	Importing	URL	Call by reference	☑	Type reference (TYPE)	STRING		url	20080926

#	Exception	Resumable	Description	Created on
1	EMPTY_URL_AND_NODEGUID	☐	leere Url und Nodeguid	20080926
2	INTERNAL_ERROR	☐	interner Fehler	20080926
3	INVALID_URL	☐	ungültige URL	20080926

Method IS_SERVICE_LAST_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EXT_ALIAS	Call by reference	☐	Type reference (TYPE)	ICFALIAS		Kein Service sondern externer Alias	20091210
2	Exporting	EXT_ALIAS_TARGET	Call by reference	☐	Type reference (TYPE)	STRING		URl des Verweises ( nur bei Aliase )	20091211
3	Importing	HOSTNUMBER	Call by reference	☐	Type reference (TYPE)	ICFHOSTNUM		ICF-Hostnummer	20091210
4	Exporting	ICFACTIVE	Call by reference	☐	Type reference (TYPE)	ICFACTIVE		Service ist aktiv	20091210
5	Exporting	ICFALTNME	Call by reference	☐	Type reference (TYPE)	ICFALTNME		Alternative Namensgebung	20091210
6	Exporting	ICFNODGUID	Call by reference	☐	Type reference (TYPE)	ICFNODGUID		Nodguid des letzen service im Pfad	20091210
7	Exporting	ICF_NAME	Call by reference	☐	Type reference (TYPE)	ICFNAME		Name des letzen Service im ICF-Baum	20091210
8	Exporting	INT_ALIAS	Call by reference	☐	Type reference (TYPE)	ICFALIAS		Kein Service sondern interner Alias	20091210
9	Exporting	LAST_NODE_IN_TREE	Call by reference	☐	Type reference (TYPE)	ICFCHAR1		ist Service ein Blattknoten ( keine Kinder )	20091210
10	Importing	URL	Call by reference	☐	Type reference (TYPE)	STRING	'/'	URL	20091210
11	Exporting	URLSUFFIX	Call by reference	☐	Type reference (TYPE)	ICFREDURL		Rest einer Url nach ICF-Service	20091210

#	Exception	Resumable	Description	Created on
1	INVALID_SERVICE	☐	Ungültiger Servicenamen	20091210
2	INVALID_URL	☐	Ungültige URL	20091210

Method READ_SERVICES_FROM_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROPERTY_STRING	Value transfer	☐	Type reference (TYPE)	STRING		String-Datenfeld	20041118
2	Returning	SERVICE_DATEN	Value transfer	☐	Type reference (TYPE)	ICFLOGIN		Service-Daten	20041118

#	Exception	Resumable	Description	Created on
1	ERROR_BY_CONVERTION	☐	Fehler bei Konvertierung	20041118

Method REORG_ICF_SERVICES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ICFPARGUID	Call by reference	☐	Type reference (TYPE)	ICFPARGUID		GUID des Vater-Knotens	20121210
2	Importing	ICF_NAME	Call by reference	☐	Type reference (TYPE)	ICFNAME		Name eines Services im Internet Communication Framework	20121210
3	Exporting	REORG_STATE	Call by reference	☐	Type reference (TYPE)	TT_REORG_STATUS		Return Code der Reorganisation	20121210

#	Exception	Resumable	Description	Created on
1	CX_ICF_STATIC_CHECK	☐	Ausnahmeklasse für ICF (statische Überprüfung)	20130206

Method SET_ACTLOGIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	ACTLOGIN	Call by reference	☑	Type reference (TYPE)	ICFLOGIN		Verdichtete Anmelde-Daten eines HTTP-Requests	20041109
2	Changing	EXPAND_ALIGUID	Call by reference	☑	Type reference (TYPE)	C			20041109
3	Changing	EXP_SERVICE	Call by reference	☑	Type reference (TYPE)	ICFSERVICE		Baum der ICF-Services im Internet-Kommunikations-Framework	20041109
4	Changing	FIRSTALIAS	Call by reference	☑	Type reference (TYPE)	ICFALIAS		Externe Aliases auf ICF-Services	20041109
5	Changing	GLOBAL_EXTENSIONS	Call by reference	☑	Type reference (TYPE)	IHTTP_ICFSERVICE_EXTENSIONS			20041109
6	Changing	INSERT_SERVTBL_FLAG	Call by reference	☑	Type reference (TYPE)	C			20041109
7	Changing	L_SERVTBL	Call by reference	☐	Type reference (TYPE)	ICFHANDLST		Tabelle von ICF-Services und deren zugehörige Handler	20041109
8	Changing	SET_EXPAND_ALIAS_LOGIN	Call by reference	☑	Type reference (TYPE)	C			20041109

Method SET_ACTLOGIN on class CL_ICF_TREE has no exception.

Method SET_ALIASTRING_HASHVALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	ICFALIAS	Call by reference	☐	Type reference (TYPE)	ICFALISTR		String der auf Service im ICFSERVICE-Baum zeigt	20051202
2	Importing	ICFALIAS_STRG	Call by reference	☐	Type reference (TYPE)	ICFALIAS_STRG		ICF: Verlängerung Externer Aliasnamen (Stringwert)	20051202
3	Importing	ICFPARGUID	Call by reference	☐	Type reference (TYPE)	ICFPARGUID		GUID des Vater-Knotens	20051202
4	Exporting	SUCCESFUL_NO_RECORD	Call by reference	☐	Type reference (TYPE)	CHAR1		Es Existiert noch kein Externer Alias	20051202

#	Exception	Resumable	Description	Created on
1	ALIAS_ALREADY_EXISTING	☐	Alias exisitert bereits	20051202
2	EMPTY_ALIAS	☐	Leerer Aliasnamen	20051202
3	ERROR_HASHVALUE	☐	Fehler beim Ermitteln des Hashwertes	20051208

Method SET_INSTACT_GROUP_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	GROUP_ACTIVE	Value transfer	☐	Type reference (TYPE)	ICFACTIVE		'X' Gruppe komplett aktiviert, ' ' = Gruppe nicht aktiv	20080925
2	Importing	GROUP_NAME	Call by reference	☐	Type reference (TYPE)	ICFCHAR30		Name der Gruppe	20080925

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	interner Fehler	20080925
2	INVALID_GROUP_NAME	☐	ungültiger Gruppennamen	20080925

Method SET_INSTACT_GROUP_INACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	GROUP_NAME	Call by reference	☐	Type reference (TYPE)	ICFCHAR30		Name der Gruppe	20080925
2	Returning	INACTIVE	Value transfer	☐	Type reference (TYPE)	ICFACTIVE		'X': Gruppe ist inaktivet, sonst ' '	20080926

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	interner Fehler	20080925
2	INVALID_GROUP_NAME	☐	ungültiger Gruppennamen	20080925

Method SET_LOGIN_PROCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	LOGIN_PROCESS	Call by reference	☐	Type reference (TYPE)	ICFLOGIN_PROCESS		ICF: Anmelde-Verfahren	20041110
2	Importing	LOG_FLAG	Call by reference	☑	Type reference (TYPE)	ICFLOGFLAG		ICF: Kz. das alternative Anmeldereihenfolge ausgewählt	20041110
3	Importing	OBLUSRFLAG	Call by reference	☑	Type reference (TYPE)	ICFOBLUSER		'X' => anonymer ICF-Benutzer obligatorisch	20041110
4	Importing	PROTSEC	Call by reference	☑	Type reference (TYPE)	ICFPROTSEC		Sicherheitsanforderung des ICF-Service	20041110
5	Importing	SYSLOG401	Call by reference	☑	Type reference (TYPE)	ICFSYSLOG		ICF: Redirekt über Systemanmeldung	20041110

Method SET_LOGIN_PROCESS on class CL_ICF_TREE has no exception.

Method SET_LOGON_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HOSTNAME	Call by reference	☐	Type reference (TYPE)	ICFNAME	'DEFAULT_HOST'	Name eines Services im Internet Communication Framework	20080922
2	Importing	ICF_LANGU	Call by reference	☑	Type reference (TYPE)	SPRAS		Sprachenschlüssel	20080922
3	Importing	ICF_MANDT	Call by reference	☑	Type reference (TYPE)	ICFMANDT		Mandant, unter dem der Service im SAP-System läuft	20080922
4	Importing	ICF_OBLIGATE_USER	Call by reference	☑	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20080922
5	Importing	ICF_PASSWD	Call by reference	☑	Type reference (TYPE)	ICFPASSWD		Verschlüsseltes Passwort des Benutzers	20080922
6	Importing	ICF_USER	Call by reference	☑	Type reference (TYPE)	SYUNAME		Benutzername	20080922
7	Importing	NODEGUID	Call by reference	☑	Type reference (TYPE)	ICFNODGUID		GUID eines ICF-Service-Knotens	20080922
8	Importing	URL	Call by reference	☑	Type reference (TYPE)	STRING		URL	20080922

#	Exception	Resumable	Description	Created on
1	EMPTY_NODGUID_OR_URL	☐	Leere Url und Nodeguid Angabe	20080923
2	ERROR_CHANGE_NODE	☐	Fehler beim Ändern des Services	20080922
3	INVALID_URL	☐	ungültige Url	20080922

Method WRITE_SERVICES_TO_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PROPERTY_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20041118
2	Importing	SERVICE_DATEN	Value transfer	☐	Type reference (TYPE)	ICFLOGIN		Verdichtete Anmelde-Daten eines HTTP-Requests	20041118

Method WRITE_SERVICES_TO_STRING on class CL_ICF_TREE has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	640