SAP ABAP Class CL_ICF_PLUGIN_SESSION (Information for Plug-In Server Object)

Hierarchy

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

Properties

Class	CL_ICF_PLUGIN_SESSION
Short Description	Information for Plug-In Server Object
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SHTTP	Development Class for HTTP Communication
Created	20080111	SAP
Last change	20110908	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)

Interfaces

Class CL_ICF_PLUGIN_SESSION has no interface implemented.

Friends

Class CL_ICF_PLUGIN_SESSION has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_GET	Constant	Private	☐	Type reference (TYPE)	STRING	'GET'	Get Method	20080414
2	CO_GUI_ENABLED	Constant	Private	☐	Type reference (TYPE)	STRING	'IS_GUI_ENABLED'	Method "is_gui_enabled"	20080117
3	CO_HOST	Constant	Private	☐	Type reference (TYPE)	STRING	'SERVER_NAME'	Method "get_host"	20080117
4	CO_METHOD	Constant	Private	☐	Type reference (TYPE)	STRING	'HTTP_METHOD'	Method "get_method"	20080117
5	CO_OPTION	Constant	Private	☐	Type reference (TYPE)	STRING	'OPTION'	Option Method	20080414
6	CO_PATH	Constant	Private	☐	Type reference (TYPE)	STRING	'PATH'	Method "get_Path"	20080117
7	CO_PLUGIN_SESSION	Constant	Private	☐	Type reference (TYPE)	STRING	'IS_PLUGIN_SESSION'	Method "is_plugin_session"	20080117
8	CO_PORT	Constant	Private	☐	Type reference (TYPE)	STRING	'PORT'	Method "get_Port"	20080117
9	CO_POST	Constant	Private	☐	Type reference (TYPE)	STRING	'POST'	Post-Method	20080414
10	CO_PROTOCOL	Constant	Private	☐	Type reference (TYPE)	STRING	'PROTOCOL'	Method "get_protocol"	20080117
11	CO_REMOTE_ADDRESS	Constant	Private	☐	Type reference (TYPE)	STRING	'REMOTE_ADDRESS'	Method "get_renote_address"	20080117
12	CO_USER_AGENT_TYPE	Constant	Private	☐	Type reference (TYPE)	STRING	'USERAGENTTYPE'	Method "get_user_agent_type"	20080117
13	CO_USER_AGENT_VERSION	Constant	Private	☐	Type reference (TYPE)	STRING	'USERAGENTVERSION'	Method "get_user_agent_version"	20080117
14	CO_VIRTUAL_HOST_NUMBER	Constant	Private	☐	Type reference (TYPE)	STRING	'VIRTUAL_SERVER'	Method "get_virtual_host_number"	20080117
15	C_RETURNCODE	Static Attribute	Private	☐	Type reference (TYPE)	I		Return Code of Method Calls	20080117

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_HOST	Static method	Public	Method	Gets server name	20080111
2	GET_METHOD	Static method	Public	Method	Gets method ( GET, POST, OPTION )	20080111
3	GET_PATH	Static method	Public	Method	Gets path	20080111
4	GET_PORT	Static method	Public	Method	Gets port	20080111
5	GET_PROTOCOL	Static method	Public	Method	Gets protocol ( HTTP, HTTPS, SMTP)	20080111
6	GET_REMOTE_ADDRESS	Static method	Public	Method	Gets remote address	20080111
7	GET_REQUEST_OBJECT	Static method	Private	Method	Gets request object (internal)	20080121
8	GET_USER_AGENT_TYPE	Static method	Public	Method	Gets user agent type	20080111
9	GET_USER_AGENT_VERSION	Static method	Public	Method	Gets user agent version	20080111
10	GET_VIRTUAL_HOST_NUMBER	Static method	Public	Method	Gets number of virtual host	20080111
11	IS_GUI_ENABLED	Static method	Public	Method	Is GUI allowed?	20080117
12	IS_PLUGIN_SESSION	Static method	Public	Method	Is the plug-in session active?	20080111

Events

Class CL_ICF_PLUGIN_SESSION has no event.

Types

Class CL_ICF_PLUGIN_SESSION has no local type.

Method Signatures

Method GET_HOST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	HOST	Value transfer	☐	Type reference (TYPE)	STRING			20080111

#	Exception	Resumable	Description	Created on
1	CX_ICF_PLUGIN_SESSION	☐	Exception Klasse Http Server Objekt	20080121

Method GET_METHOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	METHOD	Value transfer	☐	Type reference (TYPE)	STRING			20080117

#	Exception	Resumable	Description	Created on
1	CX_ICF_PLUGIN_SESSION	☐	Exception Klasse Http Server Objekt	20080121

Method GET_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PATH	Value transfer	☐	Type reference (TYPE)	STRING			20080111

#	Exception	Resumable	Description	Created on
1	CX_ICF_PLUGIN_SESSION	☐	Exception Klasse Http Server Objekt	20080121

Method GET_PORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PORT	Value transfer	☐	Type reference (TYPE)	I			20080111

#	Exception	Resumable	Description	Created on
1	CX_ICF_PLUGIN_SESSION	☐	Exception Klasse Http Server Objekt	20080121

Method GET_PROTOCOL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PROTOCOL	Value transfer	☐	Type reference (TYPE)	STRING			20080111

#	Exception	Resumable	Description	Created on
1	CX_ICF_PLUGIN_SESSION	☐	Exception Klasse Http Server Objekt	20080121

Method GET_REMOTE_ADDRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	REMOTE_ADRESS	Value transfer	☐	Type reference (TYPE)	STRING		Caller IP address	20080111

#	Exception	Resumable	Description	Created on
1	CX_ICF_PLUGIN_SESSION	☐	Exception Klasse Http Server Objekt	20080121

Method GET_REQUEST_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	REQUEST_OBJECT	Value transfer	☐	Type reference (TYPE)	%_C_POINTER			20080121

#	Exception	Resumable	Description	Created on
1	CX_ICF_PLUGIN_SESSION	☐	Exception Klasse Http Server Objekt	20080121

Method GET_USER_AGENT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	USER_AGENT_TYPE	Value transfer	☐	Type reference (TYPE)	STRING		User Agent	20080118

#	Exception	Resumable	Description	Created on
1	CX_ICF_PLUGIN_SESSION	☐	Exception Klasse Http Server Objekt	20080121

Method GET_USER_AGENT_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	USER_AGENT_VERSION	Value transfer	☐	Type reference (TYPE)	STRING		User Agent Version	20080118

#	Exception	Resumable	Description	Created on
1	CX_ICF_PLUGIN_SESSION	☐	Exception Klasse Http Server Objekt	20080121

Method GET_VIRTUAL_HOST_NUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	VIRT_HOST_NUMBER	Value transfer	☐	Type reference (TYPE)	I			20080111

#	Exception	Resumable	Description	Created on
1	CX_ICF_PLUGIN_SESSION	☐	Exception Klasse Http Server Objekt	20080121

Method IS_GUI_ENABLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	GUI_ENABLED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20080117

#	Exception	Resumable	Description	Created on
1	CX_ICF_PLUGIN_SESSION	☐	Exception Klasse Http Server Objekt	20080121

Method IS_PLUGIN_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PLUGIN	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20080111

#	Exception	Resumable	Description	Created on
1	CX_ICF_PLUGIN_SESSION	☐	Exception Klasse Http Server Objekt	20080121

History

Last changed by/on	SAP	20110908
SAP Release Created in	711