SAP ABAP Class /IWFND/CL_ICF_ACCESS (Access to ICF Nodes)

Hierarchy

☛ SAP_GWFND (Software Component) SAP Gateway Foundation
   ⤷ OPU-FND-CS (Application Component) IWF Common Services
     ⤷ /IWFND/COS_ICF (Package) GW Framework - ICF

Properties

Class	/IWFND/CL_ICF_ACCESS
Short Description	Access to ICF Nodes
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/IWFND/COS_ICF	GW Framework - ICF
Created	20111028	SAP
Last change	20141120
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	/IWFND/CL_ICF_ACCESS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class /IWFND/CL_ICF_ACCESS has no interface implemented.

Friends

Class /IWFND/CL_ICF_ACCESS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GCS_ICF_HANDLER_CLASSES	Constant	Public	☐	See coding				20111108
2	GCS_ICF_NODE_IDS	Constant	Public	☐	See coding			IDs of the ICF Nodes supported by Gateway	20111028
3	GCS_ICF_NODE_NAMES	Constant	Public	☐	See coding			Names of the ICF Nodes supported by Gateway	20111028
4	GCS_ICF_PATHS	Constant	Public	☐	See coding				20120423
5	GC_DEFAULT_HOST	Constant	Public	☐	Type reference (TYPE)	ICFNAME	'DEFAULT_HOST'	Name of a Service in Internet Communication Framework	20111122
6	GC_ICFDOCU_NAMESPACE	Constant	Private	☐	Type reference (TYPE)	ICFDOCU	'Namespace'	Value 'Namespace' for icfdocu	20111102
7	GO_ICF_ACCESS	Static Attribute	Private	☐	Object reference (TYPE REF TO)	/IWFND/CL_ICF_ACCESS		Access to ICF Nodes	20111031

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHANGE_GW_SERVICE_ICF_NODE	Instance method	Public	Method	Changes ICF Node for a Gateway Service	20121206
2	CL_ICF_TREE_IS_SERVICE_ACTIVE	Instance method	Private	Method	See CL_ICF_TREE->IS_SERVICE_ACTIVE in 7.02	20120308
3	CREATE_GW_SERVICE_ICF_NODE	Instance method	Public	Method	Create ICF Node for a Gateway Service	20111102
4	DELETE_GW_SERVICE_ICF_NODE	Instance method	Public	Method	Delete ICF Node	20111102
5	GET_ICF_ACCESS	Static method	Public	Method	Get object of class	20111031
6	GET_ICF_DOCU_FOR_GW_LIBS	Instance method	Public	Method	Get sub Nodes of Node OPU	20111117
7	GET_ICF_GUIDS_FOR_SERVICE	Instance method	Public	Method	Get Node and Parent GUID for a Service (IV_EXTERNAL_NAME)	20111117
8	GET_ICF_ROOT_NODE	Instance method	Public	Method	Returns the ICF "Root" node defining the OData Lib version	20111103
9	GET_ICF_URL_BY_NODE_ID	Instance method	Public	Method	Get ICF URL for external name/namespace by root node ID	20111107
10	GET_NODE_GUID	Instance method	Public	Method	Get Node GUID of Node Name or Alternative Name	20111118
11	GET_NODE_NAME_FROM_NAMESPACE	Instance method	Private	Method	Determine namespace for ICF Node	20111103
12	IS_SERVICE_ACTIVE	Instance method	Private	Method	Check whether ICF service is active	20111122
13	IS_SERVICE_ACTIVE_BY_NODEGUID	Instance method	Public	Method	Check whether ICF service is active by NODEGUID	20111122
14	IS_SERVICE_ACTIVE_BY_URL	Instance method	Public	Method	Check whether ICF service is active by URL	20111122
15	IS_SUB_NODE	Instance method	Public	Method	Checks if a Gateway service is child of an ICF "Root" node	20111107
16	VALIDATE_ROOT_FOR_ICF_NODE	Instance method	Private	Method	Returns the ICF "Root" node defining the OData Lib version	20111103

Events

Class /IWFND/CL_ICF_ACCESS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_T_ICFDOCU	Public	See coding		Table Type: Documentation of ICFSERVICE Entries	20111117	ty_t_icfdocu TYPE STANDARD TABLE OF icfdocu WITH NON-UNIQUE KEY icf_name

Method Signatures

Method CHANGE_GW_SERVICE_ICF_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ICF_HANDLER_LIST	Call by reference	☑	Type reference (TYPE)	ICFHNDLIST		Table of ICF_HAND Entries	20121206
2	Importing	IV_EXTERNAL_NAME	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_SERVICE_GRP_ID		External Service Document Name	20121206
3	Importing	IV_ICF_NODE_GUID_LIB	Call by reference	☐	Type reference (TYPE)	ICFPARGUID		GUID of Parent Node	20121206
4	Importing	IV_INSERT_DEFAULT_CLIENT	Call by reference	☐	Type reference (TYPE)	BOOLEAN	SPACE	Client	20121206
5	Importing	IV_NAMESPACE	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_NAMESPACE		Namespace	20121206
6	Importing	IV_PACKAGE	Call by reference	☐	Type reference (TYPE)	DEVCLASS		Package	20121206
7	Importing	IV_TRANSPORT	Call by reference	☐	Type reference (TYPE)	TRKORR	SPACE	Request/Task	20121206

#	Exception	Resumable	Description	Created on
1	/IWFND/CX_COS_ICF	☐	Common Services ICF Exception	20121206

Method CL_ICF_TREE_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 is Activated, Otherwise ' '	20120308
2	Importing	HOSTNAME	Call by reference	☐	Type reference (TYPE)	ICFNAME		Name of a Service in Internet Communication Framework	20120308
3	Importing	NODEGUID	Call by reference	☐	Type reference (TYPE)	ICFNODGUID		GUID of ICF Service Node	20120308
4	Importing	URL	Call by reference	☐	Type reference (TYPE)	STRING			20120308

#	Exception	Resumable	Description	Created on
1	EMPTY_URL_AND_NODEGUID	☐	Empty URL and Node GUID	20120308
2	INTERNAL_ERROR	☐	Internal Error	20120308
3	INVALID_URL	☐	Invalid URL	20120308

Method CREATE_GW_SERVICE_ICF_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ICF_HANDLER_LIST	Call by reference	☑	Type reference (TYPE)	ICFHNDLIST		Table of ICF_HAND Entries	20120723
2	Importing	IV_EXTERNAL_NAME	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_SERVICE_GRP_ID		External Service Document Name	20111102
3	Importing	IV_ICF_NODE_GUID_LIB	Call by reference	☐	Type reference (TYPE)	ICFPARGUID		GUID of Parent Node	20111102
4	Importing	IV_INSERT_DEFAULT_CLIENT	Call by reference	☐	Type reference (TYPE)	BOOLEAN	SPACE	Client	20111102
5	Importing	IV_NAMESPACE	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_NAMESPACE		Namespace	20111102
6	Importing	IV_PACKAGE	Call by reference	☐	Type reference (TYPE)	DEVCLASS		Package	20111102
7	Importing	IV_TRANSPORT	Call by reference	☐	Type reference (TYPE)	TRKORR	SPACE	Request/Task	20111102

#	Exception	Resumable	Description	Created on
1	/IWFND/CX_COS_ICF	☐	Common Services ICF Exception	20111102

Method DELETE_GW_SERVICE_ICF_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXTERNAL_NAME	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_SERVICE_GRP_ID		External Service Document Name	20111102
2	Importing	IV_ICF_NODE_GUID_LIB	Call by reference	☐	Type reference (TYPE)	ICFPARGUID		GUID of Parent Node	20111102
3	Importing	IV_NAMESPACE	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_NAMESPACE		Namespace	20111102
4	Importing	IV_TRANSPORT	Call by reference	☐	Type reference (TYPE)	TRKORR	SPACE	Request/Task	20111102

#	Exception	Resumable	Description	Created on
1	/IWFND/CX_COS_ICF	☐	Common Services ICF Exception	20111102

Method GET_ICF_ACCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_ICF_ACCESS	Value transfer	☐	Object reference (TYPE REF TO)	/IWFND/CL_ICF_ACCESS		Access to ICF Nodes	20111031

Method GET_ICF_ACCESS on class /IWFND/CL_ICF_ACCESS has no exception.

Method GET_ICF_DOCU_FOR_GW_LIBS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_ICFDOCU	Value transfer	☐	Type reference (TYPE)	/IWFND/CL_ICF_ACCESS=>TY_T_ICFDOCU		Table Type: Documentation of ICFSERVICE Entries	20111117

Method GET_ICF_DOCU_FOR_GW_LIBS on class /IWFND/CL_ICF_ACCESS has no exception.

Method GET_ICF_GUIDS_FOR_SERVICE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_NAMESPACE_GUID	Call by reference	☐	Type reference (TYPE)	ICFNODGUID		GUID of ICF Service Node	20111118
2	Exporting	EV_SERVICE_GUID	Call by reference	☐	Type reference (TYPE)	ICFNODGUID		GUID of ICF Service Node	20111118
3	Exporting	EV_SERVICE_TIMEOUT	Call by reference	☐	Type reference (TYPE)	ICFTIME		Session Timeout	20131122
4	Importing	IV_EXTERNAL_NAME	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_SERVICE_GRP_ID		Service Document Identifier	20111117
5	Importing	IV_ICF_ROOT_NODE_GUID	Call by reference	☐	Type reference (TYPE)	ICFPARGUID		GUID of Parent Node	20111117
6	Importing	IV_NAMESPACE	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_NAMESPACE		Namespace	20111117

Method GET_ICF_GUIDS_FOR_SERVICE on class /IWFND/CL_ICF_ACCESS has no exception.

Method GET_ICF_ROOT_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXTERNAL_NAME	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_SERVICE_GRP_ID		External Service Document Name	20111103
2	Importing	IV_NAMESPACE	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_NAMESPACE		Namespace	20111103
3	Returning	RV_ICF_NODE_GUID_LIB	Value transfer	☐	Type reference (TYPE)	ICFPARGUID		GUID of Parent Node	20111103

Method GET_ICF_ROOT_NODE on class /IWFND/CL_ICF_ACCESS has no exception.

Method GET_ICF_URL_BY_NODE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXTERNAL_NAME	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_SERVICE_GRP_ID		External Service Document Name	20111107
2	Importing	IV_ICF_ROOT_NODE_GUID	Call by reference	☐	Type reference (TYPE)	ICFPARGUID		GUID of Parent Node	20111107
3	Importing	IV_NAMESPACE	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_NAMESPACE		Namespace	20111107
4	Returning	RV_ICF_URL	Value transfer	☐	Type reference (TYPE)	STRING		URL	20111107

#	Exception	Resumable	Description	Created on
1	/IWFND/CX_COS_ICF	☐	Common Services ICF Exception	20111107

Method GET_NODE_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ICF_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ICFALTNME		ICF: Alternative Service Name	20111118
2	Importing	IV_ICF_PARENT_GUID	Call by reference	☐	Type reference (TYPE)	ICFPARGUID		GUID of Parent Node	20111118
3	Returning	RV_ICF_NODE_GUID	Value transfer	☐	Type reference (TYPE)	ICFNODGUID		GUID of ICF Service Node	20111118

Method GET_NODE_GUID on class /IWFND/CL_ICF_ACCESS has no exception.

Method GET_NODE_NAME_FROM_NAMESPACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAMESPACE	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_NAMESPACE		Namespace	20111103
2	Returning	RV_ICF_NODE_NAME	Value transfer	☐	Type reference (TYPE)	ICFNAME		ICF Node name	20111103

Method GET_NODE_NAME_FROM_NAMESPACE on class /IWFND/CL_ICF_ACCESS has no exception.

Method IS_SERVICE_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HOSTNAME	Call by reference	☐	Type reference (TYPE)	ICFNAME	GC_DEFAULT_HOST	Name of a Service in Internet Communication Framework	20111122
2	Importing	IV_NODEGUID	Call by reference	☑	Type reference (TYPE)	ICFNODGUID		GUID of ICF Service Node	20111122
3	Importing	IV_URL	Call by reference	☑	Type reference (TYPE)	STRING			20111122
4	Returning	RV_ACTIVE	Value transfer	☐	Type reference (TYPE)	ICFACTIVE		'X': Service is Activated, Otherwise ' '	20111122

#	Exception	Resumable	Description	Created on
1	/IWFND/CX_COS_ICF	☐	Common Services ICF Exception	20111122

Method IS_SERVICE_ACTIVE_BY_NODEGUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HOSTNAME	Call by reference	☐	Type reference (TYPE)	ICFNAME	GC_DEFAULT_HOST	Name of a Service in Internet Communication Framework	20111122
2	Importing	IV_NODEGUID	Call by reference	☑	Type reference (TYPE)	ICFNODGUID		GUID of ICF Service Node	20111122
3	Returning	RV_ACTIVE	Value transfer	☐	Type reference (TYPE)	ICFACTIVE		'X': Service is Activated, Otherwise ' '	20111122

#	Exception	Resumable	Description	Created on
1	/IWFND/CX_COS_ICF	☐	Common Services ICF Exception	20111122

Method IS_SERVICE_ACTIVE_BY_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HOSTNAME	Call by reference	☐	Type reference (TYPE)	ICFNAME	GC_DEFAULT_HOST	Name of a Service in Internet Communication Framework	20111122
2	Importing	IV_URL	Call by reference	☑	Type reference (TYPE)	STRING			20111122
3	Returning	RV_ACTIVE	Value transfer	☐	Type reference (TYPE)	ICFACTIVE		'X': Service is Activated, Otherwise ' '	20111122

#	Exception	Resumable	Description	Created on
1	/IWFND/CX_COS_ICF	☐	Common Services ICF Exception	20111122

Method IS_SUB_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXTERNAL_NAME	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_SERVICE_GRP_ID		External Service Document Name	20111107
2	Importing	IV_ICF_ROOT_NODE_GUID	Value transfer	☐	Type reference (TYPE)	ICFPARGUID		GUID of ICF Node, see /IWFND/CL_ICF_ACCESS=>GCS_ICF_NODE_IDS	20111107
3	Importing	IV_NAMESPACE	Call by reference	☐	Type reference (TYPE)	/IWFND/MED_MDL_NAMESPACE		Namespace	20111107
4	Returning	RV_IS_SUB_NODE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		TRUE is the service is a sub-node to the root node	20111107

Method IS_SUB_NODE on class /IWFND/CL_ICF_ACCESS has no exception.

Method VALIDATE_ROOT_FOR_ICF_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ICF_NODE_ALT_NAME	Call by reference	☐	Type reference (TYPE)	ICFALTNME		Alternative ICF Node Name	20111103
2	Importing	IV_ICF_PARENT_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ICFNAME		Name of the ICF Parent Node	20111103
3	Importing	IV_ICF_ROOT_NODE_GUID	Call by reference	☐	Type reference (TYPE)	ICFPARGUID		Guid of the ICF Root Node	20111103
4	Returning	RV_IS_VALID	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Is IV_ICF_NODE_ALT_NAME sub node of IV_ICF_ROOT_NODE_GUID?	20111103

Method VALIDATE_ROOT_FOR_ICF_NODE on class /IWFND/CL_ICF_ACCESS has no exception.

History

Last changed by/on	SAP	20141120
SAP Release Created in	250