SAP ABAP Class CL_ICM_API (Access to ICM Data)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CST-IC (Application Component) Internet Communication Manager
     ⤷ SICM (Package) Internet Communication Manager

Properties

Class	CL_ICM_API
Short Description	Access to ICM Data
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SICM	Internet Communication Manager
Created	20010726	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)

Interfaces

Class CL_ICM_API has no interface implemented.

Friends

Class CL_ICM_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ICM_HTTP_CONNECTION_BROKEN	Constant	Public	☐	Type reference (TYPE)	I	401	Connection broken errors	20121219
2	ICM_HTTP_CONNECTION_FAILED	Constant	Public	☐	Type reference (TYPE)	I	400		20121219
3	ICM_HTTP_CONNECTION_REFUSED	Constant	Public	☐	Type reference (TYPE)	I	411	Connection rejected	20121219
4	ICM_HTTP_HOST_UNKNOWN	Constant	Public	☐	Type reference (TYPE)	I	417	Host name not known	20121219
5	ICM_HTTP_INTERNAL	Constant	Public	☐	Type reference (TYPE)	I	405	Internal error	20121219
6	ICM_HTTP_NOT_FOUND	Constant	Public	☐	Type reference (TYPE)	I	409	Page not found	20121219
7	ICM_HTTP_NO_MORE_MEMORY	Constant	Public	☐	Type reference (TYPE)	I	404	Not sufficient memory	20121219
8	ICM_HTTP_NO_PERMISSION	Constant	Public	☐	Type reference (TYPE)	I	406	No authorization	20121219
9	ICM_HTTP_PROXY_CONN_REFUSED	Constant	Public	☐	Type reference (TYPE)	I	412	Proxy connection rejected	20121219
10	ICM_HTTP_PROXY_HOST_UNKNOWN	Constant	Public	☐	Type reference (TYPE)	I	413	Proxy host not known	20121219
11	ICM_HTTP_PROXY_UNAUTHORIZED	Constant	Public	☐	Type reference (TYPE)	I	416	No proxy authorization	20121219
12	ICM_HTTP_SERVICE_UNAVAILABLE	Constant	Public	☐	Type reference (TYPE)	I	403	Service Not Available	20121219
13	ICM_HTTP_SSLPROXY_ERROR	Constant	Public	☐	Type reference (TYPE)	I	408	SSL proxy error	20121219
14	ICM_HTTP_SSL_CERT_MISMATCH	Constant	Public	☐	Type reference (TYPE)	I	415	Certificate host name does not match	20121219
15	ICM_HTTP_SSL_CRED_NOT_FOUND	Constant	Public	☐	Type reference (TYPE)	I	414	SSL PSE file not found	20121219
16	ICM_HTTP_SSL_ERROR	Constant	Public	☐	Type reference (TYPE)	I	407	SSL error	20121219
17	ICM_HTTP_TIMEOUT	Static Attribute	Public	☐	Type reference (TYPE)	I	402	Timeout error	20121219
18	ICM_HTTP_UNAUTHORIZED	Constant	Public	☐	Type reference (TYPE)	I	410	No authorization	20121219
19	LOG_SPLIT_CHAR	Constant	Public	☐	Type reference (TYPE)	CHAR1	'$'	Separator Sequence	20010726
20	LOG_SPLIT_CHAR2	Constant	Private	☐	Type reference (TYPE)	CHAR2	'$$'	Separator Sequence	20010726
21	LOG_SPLIT_TRANSLATE	Constant	Private	☐	Type reference (TYPE)	STRING	'[$]${$}$"$ $'	Translate According to Separator Sequence	20010726
22	STATUS_GREEN	Constant	Public	☐	Type reference (TYPE)	I	2		20010803
23	STATUS_RED	Constant	Public	☐	Type reference (TYPE)	I	0		20010803
24	STATUS_YELLOW	Constant	Public	☐	Type reference (TYPE)	I	1		20010803

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_AUTH_FOR_READ_ACCESS	Static method	Public	Method	Check if caller is allowed to access ICM data	20131018
2	CLIENT_ERROR_DETAIL_TO_STRING	Static method	Public	Method	Returns the decoded value for header SAP-ICMERRORDETAIL	20130311
3	GET_CACHE_ENTRIES	Instance method	Public	Method	ICM Cache Entries	20010803
4	GET_CACHE_STATISTICS	Instance method	Public	Method	ICM Cache Stats	20010803
5	GET_CLIENT_ERROR_DETAIL	Static method	Public	Method	Reads details of client-side errors	20130222
6	GET_CLIENT_ERROR_TEXT	Static method	Public	Method	Returns error texts for client-side ICM errors	20121219
7	GET_HOSTNAME_TABLE	Instance method	Public	Method	ICM Host Name Table	20010803
8	GET_MPI_INFO	Instance method	Public	Method	ICM MPI Info	20010803
9	GET_PARAM_INFO	Instance method	Public	Method	ICM Param Info	20010803
10	GET_RELEASE_INFO	Instance method	Public	Method	ICM Release Info	20010802
11	GET_STATISTICS	Instance method	Public	Method	ICM Statistics	20010802
12	GET_STATUS	Instance method	Public	Method	ICM status	20010802
13	MAP_PROTOCOL	Instance method	Public	Method	Map ICM_SINFO-PROTOCOL (ICMPROTO) to String	20010801
14	MAP_REQUEST	Instance method	Public	Method	Map ICM_THRLST-REQ_TYPE (ICMRQTYPE) to String	20010803
15	MAP_THREAD_STATUS	Instance method	Public	Method	Map ICM_THRLST-THR_STAT (ICMTHRSTAT) to String	20010803
16	READ_LOG	Instance method	Public	Method	Import Log	20010802
17	READ_TRACE	Instance method	Public	Method	Read Trace	20010802
18	STATUS_TO_COLOUR	Instance method	Public	Method	Map ICM_STATUS-STATUS to Red/Yellow/Green	20010803
19	TIMESTAMP_TO_STRING	Instance method	Public	Method	ICM ICMINTVAL to ICM_DATES	20010809

Events

Class CL_ICM_API has no event.

Types

Class CL_ICM_API has no local type.

Method Signatures

Method CHECK_AUTH_FOR_READ_ACCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	IS_ALLOWED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		user has the permissions	20131018

Method CHECK_AUTH_FOR_READ_ACCESS on class CL_ICM_API has no exception.

Method CLIENT_ERROR_DETAIL_TO_STRING Signature

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

Method CLIENT_ERROR_DETAIL_TO_STRING on class CL_ICM_API has no exception.

Method GET_CACHE_ENTRIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ENTRIES	Value transfer	☐	Type reference (TYPE)	ICM_CENTRY_T		Typ fuer einen Cache Eintrag	20010803

Method GET_CACHE_ENTRIES on class CL_ICM_API has no exception.

Method GET_CACHE_STATISTICS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	STATISTICS	Value transfer	☐	Type reference (TYPE)	ICM_CSTAT			20010803

Method GET_CACHE_STATISTICS on class CL_ICM_API has no exception.

Method GET_CLIENT_ERROR_DETAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DETAIL	Value transfer	☐	Type reference (TYPE)	STRING			20130222
2	Importing	HTTP_CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_CLIENT		HTTP Client Abstraction	20130222

Method GET_CLIENT_ERROR_DETAIL on class CL_ICM_API has no exception.

Method GET_CLIENT_ERROR_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ERROR_CODE	Value transfer	☐	Type reference (TYPE)	I			20121219
2	Returning	ERROR_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20121219

Method GET_CLIENT_ERROR_TEXT on class CL_ICM_API has no exception.

Method GET_HOSTNAME_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LINES	Value transfer	☐	Type reference (TYPE)	STRING_TABLE		Tabelle von Strings	20010803

Method GET_HOSTNAME_TABLE on class CL_ICM_API has no exception.

Method GET_MPI_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LINES	Value transfer	☐	Type reference (TYPE)	STRING_TABLE		Tabelle von Strings	20010803

Method GET_MPI_INFO on class CL_ICM_API has no exception.

Method GET_PARAM_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LINES	Value transfer	☐	Type reference (TYPE)	STRING_TABLE		Tabelle von Strings	20010803

Method GET_PARAM_INFO on class CL_ICM_API has no exception.

Method GET_RELEASE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LINES	Value transfer	☐	Type reference (TYPE)	STRING_TABLE		Tabelle von Strings	20010802

Method GET_RELEASE_INFO on class CL_ICM_API has no exception.

Method GET_STATISTICS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	STATISTICS	Value transfer	☐	Type reference (TYPE)	ICM_STATIS		Statistikinformationen ueber ICM	20010802

Method GET_STATISTICS on class CL_ICM_API has no exception.

Method GET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	INFO_DATA	Call by reference	☐	Type reference (TYPE)	ICM_INFO		ICMAN Statusinformation	20010802
2	Exporting	SERVICES_LIST	Call by reference	☐	Type reference (TYPE)	ICM_SINFO_T		Tabelle der Serverliste des ICM	20010802
3	Exporting	THREAD_LIST	Call by reference	☐	Type reference (TYPE)	ICM_THRLST_T		Struktur der Threadliste	20010802

Method GET_STATUS on class CL_ICM_API has no exception.

Method MAP_PROTOCOL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROTOCOL	Call by reference	☐	Type reference (TYPE)	ICMPROTO		ICM Protokollkennung	20010801
2	Returning	PROTOCOL_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20010801

Method MAP_PROTOCOL on class CL_ICM_API has no exception.

Method MAP_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REQUEST	Call by reference	☐	Type reference (TYPE)	ICMRQTYPE		ICM Protokollkennung	20010803
2	Returning	REQUEST_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20010803

Method MAP_REQUEST on class CL_ICM_API has no exception.

Method MAP_THREAD_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	THREAD_STATUS	Call by reference	☐	Type reference (TYPE)	ICMTHRSTAT		ICM Protokollkennung	20010803
2	Returning	THREAD_STATUS_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20010803

Method MAP_THREAD_STATUS on class CL_ICM_API has no exception.

Method READ_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	COLUMN_COUNT	Call by reference	☐	Type reference (TYPE)	I		Number of Parsed Columns Per Line	20010802
2	Exporting	FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		Name Des Log File	20010802
3	Importing	FILTER_STRING	Call by reference	☐	Type reference (TYPE)	STRING	''	Filter Lines nach diesem String	20010802
4	Exporting	HEADER_LINE	Call by reference	☐	Type reference (TYPE)	STRING		Parsed Header Line	20010802
5	Importing	LAST_N_LINES	Call by reference	☐	Type reference (TYPE)	I	0	Nur letzte N Zeilen	20010802
6	Exporting	LINES	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Tabelle von Strings	20010802
7	Importing	PARSE_LINES	Call by reference	☐	Type reference (TYPE)	BOOLEAN	'X'	boolsche Variable (X=true, -=false, space=unknown)	20010802

Method READ_LOG on class CL_ICM_API has no exception.

Method READ_TRACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	FILENAME	Call by reference	☐	Type reference (TYPE)	STRING			20010802
2	Importing	LAST_N_LINES	Call by reference	☐	Type reference (TYPE)	I	0	Nur letzte N Zeilen	20010802
3	Exporting	LINES	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Tabelle von Strings	20010802

Method READ_TRACE on class CL_ICM_API has no exception.

Method STATUS_TO_COLOUR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	COLOUR	Value transfer	☐	Type reference (TYPE)	I		INFO_STATUS_GREEN/YELLOW/RED	20010803
2	Importing	STATUS	Call by reference	☐	Type reference (TYPE)	ICM_STAT		Status des ICMAN	20010803

Method STATUS_TO_COLOUR on class CL_ICM_API has no exception.

Method TIMESTAMP_TO_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INTERVAL	Call by reference	☐	Type reference (TYPE)	ICMINTVAL		Zahlenwert	20010809
2	Returning	VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20010809

Method TIMESTAMP_TO_STRING on class CL_ICM_API has no exception.

History

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