SAP ABAP Class CL_ADM_MESSAGE (Sends an internal system AD message)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CST (Application Component) Client/Server Technology
     ⤷ SADM (Package) Admin Messages for Internal System Communication

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ADM_EXECUTION_TYPES	Location of Execution	20110120
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ADM_MODE_TYPES	Type of execution	20110120

Properties

Class	CL_ADM_MESSAGE
Short Description	Sends an internal system AD message
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SADM	Admin Messages for Internal System Communication
Created	20110119	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ADM_MESSAGE has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ADM_EXECUTION_TYPES	☐	☐	Location of Execution	20110120
2	IF_ADM_MODE_TYPES	☐	☐	Type of execution	20110120

Friends

Class CL_ADM_MESSAGE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	AD_OPCODE	Instance attribute	Private	☐	Type reference (TYPE)	I	-1	AD Opcode	20110119
2	AD_WPKILL_SOFT	Constant	Public	☐	Type reference (TYPE)	AD_WPKILL_T-KILLTYPE	'S'		20111125
3	AD_WPSTAT_STAT_FREE	Constant	Public	☐	Type reference (TYPE)	I	1	Status FREE	20111118
4	AD_WPSTAT_STAT_HOLD	Constant	Public	☐	Type reference (TYPE)	I	8	Status HOLD	20111118
5	AD_WPSTAT_STAT_KILLED	Constant	Public	☐	Type reference (TYPE)	I	16	Status KILLED	20111118
6	AD_WPSTAT_STAT_NEW	Constant	Public	☐	Type reference (TYPE)	I	128	Status NEW	20111118
7	AD_WPSTAT_STAT_RESTRICTED	Constant	Public	☐	Type reference (TYPE)	I	64	Status RESTRICTED	20111118
8	AD_WPSTAT_STAT_RUN	Constant	Public	☐	Type reference (TYPE)	I	4	Status RUN	20111118
9	AD_WPSTAT_STAT_SHUTDOWN	Constant	Public	☐	Type reference (TYPE)	I	32	Status SHUTDOWN	20111118
10	AD_WPSTAT_STAT_WAIT	Constant	Public	☐	Type reference (TYPE)	I	2	Status WAIT	20111118
11	ASYNCHRONOUS	Instance attribute	Private	☐	Type reference (TYPE)	I		Send Asynchronously	20110119
12	CLASS_A_WP_IDENT	Constant	Public	☐	Type reference (TYPE)	CLASS_A_WP_IDENT_T	'BTC_CLASS_A_WP'		20111117
13	CO_AD_ECHO	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	14	Echo Test	20111118
14	CO_AD_EM	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	25	Extended Memory	20111121
15	CO_AD_GENERAL	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	0	Basic Information	20111117
16	CO_AD_GENERAL2	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	17	Get number of work processes	20111117
17	CO_AD_GET_NILIST	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	71	Get local IP addresses	20111118
18	CO_AD_PROFILE	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	1	Read profile parameter	20111117
19	CO_AD_QUEUE	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	3	Dispatcher Queue Fill Level	20111125
20	CO_AD_RESET_BUFFERED_TABLE	Constant	Private	☐	Type reference (TYPE)	INT1	77	Reset Buffered Table	20111110
21	CO_AD_RZL	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	20	Reserviert for Computer Control Center	20111117
22	CO_AD_RZL_STRG	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	21	Access to Local Memory	20111121
23	CO_AD_SOFT_CANCEL	Constant	Private	☐	Type reference (TYPE)	INT1	82	Soft Cancel	20111110
24	CO_AD_STARTSTOP	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	4	Switch Work Processes	20111118
25	CO_AD_TIMEINFO	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	8	STHCMLIST OPCODE	20111125
26	CO_AD_USRLST	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	6	User List, such as SM04	20111117
27	CO_AD_WPCONF2	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	16	Extended WP Configuration (including restricted wps)	20111110
28	CO_AD_WPKILL	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	7	Stop Work Process	20111125
29	CO_AD_WPSTAT	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	2	Work Process Status (SM50)	20111110
30	CO_GET_TRUSTED_INFO	Constant	Public	☐	Type reference (TYPE)	STHCMLIST-OPCODE	86	Get IP List and Ports	20130619
31	ERROR_BAD_SEND_PARAMETER	Constant	Public	☐	Type reference (TYPE)	I	2		20111111
32	ERROR_OTHER	Constant	Public	☐	Type reference (TYPE)	I	4		20111111
33	ERROR_PARAMETER_RANGE	Constant	Public	☐	Type reference (TYPE)	I	5		20111111
34	ERROR_SEND_ERROR	Constant	Public	☐	Type reference (TYPE)	I	3		20111111
35	ERROR_SERVER_NAME_EMPTY	Constant	Public	☐	Type reference (TYPE)	I	1		20111111
36	EXECUTION	Instance attribute	Private	☐	Type reference (TYPE)	SADM_EXECUTION		Where is the execution taking place?	20110119
37	MODE	Instance attribute	Private	☐	Type reference (TYPE)	I		Addressing Type	20110119
38	ONLY_ACTIVE_SERVER	Instance attribute	Private	☐	Type reference (TYPE)	I		Execute Action for Active Servers Only	20120405
39	REQUEST	Instance attribute	Private	☐	Type reference (TYPE)	SADM_MESSAGE_TBL		Table of Request Messages	20110119
40	RESPONSE	Instance attribute	Private	☐	Type reference (TYPE)	SADM_MESSAGE_TBL		Table of Response Messages	20110119
41	SERVER_NAME	Instance attribute	Private	☐	Type reference (TYPE)	SADM_SERVERNAME		Instance Name	20110119
42	SERVER_TYPES	Instance attribute	Private	☐	Type reference (TYPE)	MSXXLIST-MSGTYPES		Instance Types	20110119
43	SERVER_TYPE_MS_BTC	Constant	Public	☐	Type reference (TYPE)	I	8	MSGTYPES.MS_BTC	20111111
44	SERVER_TYPE_MS_DIA	Constant	Public	☐	Type reference (TYPE)	I	1	MSGTYPES.MS_DIA	20111111
45	SERVER_TYPE_MS_ICMAN	Constant	Public	☐	Type reference (TYPE)	I	128	MSGTYPES.MS_ICMAN	20111111
46	SERVER_TYPE_MS_NONE	Constant	Public	☐	Type reference (TYPE)	I	0	MSGTYPES.MS_NONE	20111222
47	SYSTEM_WIDE	Instance attribute	Private	☐	Type reference (TYPE)	I		Send Message System-Wide	20110119
48	TH_ADM_SRVTYPES_NONE	Constant	Public	☐	Type reference (TYPE)	MSXXLIST-MSGTYPES	0	RSADMKEY.TH_ADM_SRVTYPES_NONE	20111222
49	TRACE	Instance attribute	Private	☐	Type reference (TYPE)	I		Trace for ADM Message	20111109

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	AD_GET_TRUST_INFO	Instance method	Public	Method	Gets list of IP addresses and gateway ports	20130619
2	AD_PROFILE	Instance method	Public	Method		20110412
3	AD_PROFILE_LIST	Instance method	Public	Method	Reset Table List	20110428
4	AD_RESET_BUFFERED_TABLE	Instance method	Public	Method	Reset Table	20110120
5	AD_RESET_BUFFERED_TABLES	Instance method	Public	Method	Reset Table List	20110124
6	AD_SOFT_CANCEL	Instance method	Public	Method	Send a soft cancel	20111108
7	AD_WPCONF2	Instance method	Public	Method	Extended WP Configuration (including restricted wps)	20120611
8	AD_WPSTAT	Instance method	Public	Method	Work Process Status (SM50)	20120611
9	APPEND_AD_WPCONF2_REQ_LINE	Static method	Public	Method	Build an ad_wpconf2 request	20120611
10	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20110119
11	GET_RESULT	Instance method	Private	Method	Returns the table of the last execution	20110119
12	SEND	Instance method	Private	Method	Send ADM Message	20110119
13	SET_ACTIVE_SERVER_ONLY	Instance method	Public	Method	Action for Active/All Servers Only	20120405
14	SET_ASYNCHRONOUS	Instance method	Public	Method	Execute Synchronously or Asynchronously	20110119
15	SET_EXECUTION	Instance method	Public	Method	Who executes the ADM message?	20110119
16	SET_SERVER_NAME	Instance method	Public	Method	Specify instance name where the ADM message is executed	20110119
17	SET_SERVER_TYPES	Instance method	Public	Method	Specify instance type where the ADM message is executed	20110119
18	SET_SYSTEM_WIDE	Instance method	Public	Method	System-Wide Execution of ADM Message	20110119
19	SET_TRACE	Instance method	Public	Method	Execute Synchronously or Asynchronously	20111109

Events

Class CL_ADM_MESSAGE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	AD_GENERAL2_T	Public	See coding			20111117	begin of ad_general2_t, wp_no_dia type c length 3, wp_no_vb type c length 3, wp_no_enq type c length 3, wp_no_btc type c length 3, wp_no_spo type c length 3, instance type c length 13, user_no type c length 3, wp_no_vb2 type c length 3, wp_no_restricted type c length 3, wp_max_no type c length 3, wp_configurable_no type c length 3, end of ad_general2_t
2	AD_QUEUE_T	Public	See coding			20111125	begin of AD_QUEUE_T, RQTYP type c length 4, NOW type c length 11, HIGH type c length 11, MAXI type c length 11, WRITES type c length 11, READS type c length 11, end of AD_QUEUE_T
3	AD_STARTSTOP_T	Public	See coding			20111118	begin of ad_startstop_t, type type c length 3, name type c length 20, sapsysnr type c length 2, hostname type c length 64, end of ad_startstop_t
4	AD_TIMEINFO_T	Public	See coding			20111125	begin of AD_TIMEINFO_T , _unused type c length 11, LOCTIMESTR type c length 14, USEC type c length 6, TIMEZONE type c length 11, end of AD_TIMEINFO_T
5	AD_USRLST_T	Public	See coding			20111117	BEGIN OF AD_USRLST_t, MANDT type c length 3, BNAME type c length 12, TERMINAL type c length 12, TCOD type c length 4, REPORT type c length 8, DIATIME type c length 11, AMODES type c length 3, IMODES type c length 3, type type c length 11, rfc_type type c length 3, END OF AD_USRLST_t
6	AD_WPCONF2_T	Private	See coding			20111115	begin of ad_wpconf2_t , wpnodia type c length 3, wpnovb type c length 3, "unused wpnoenq type c length 3, "unused wpnobtc type c length 3, wpnospo type c length 3, "unused wpnov2 type c length 3, "unused wpnosby type c length 3, end of ad_wpconf2_t
7	AD_WPKILL_T	Public	See coding			20111125	begin of AD_WPKILL_T, WP type c length 11, KILLTYPE type c length 1, MANDT type c length 3, BNAME type c length 12, end of AD_WPKILL_T
8	AD_WPSTAT_T	Public	See coding			20111109	begin of AD_WPSTAT_T, wp type c length 3, rqtyp type c length 4, pid type c length 11, stat type c length 5, wait_for type c length 3, restart type c length 3, no_of_deaths type c length 5, sem type c length 5, runtime type c length 11, report type c length 8, mandt type c length 3, bname type c length 12, action type c length 3, tab_name type c length 10, end of ad_wpstat_t
9	AD_WPSTAT_TABLE_T	Public	See coding			20111109	AD_WPSTAT_TABLE_T type standard table of ad_wpstat_t
10	CLASS_A_WP_IDENT_T	Public	See coding			20111117	CLASS_A_WP_IDENT_T type c length 20

Method Signatures

Method AD_GET_TRUST_INFO Signature

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

Method AD_GET_TRUST_INFO on class CL_ADM_MESSAGE has no exception.

Method AD_PROFILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20110412
2	Exporting	RC	Call by reference	☐	Type reference (TYPE)	I			20110414
3	Exporting	VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20110412

Method AD_PROFILE on class CL_ADM_MESSAGE has no exception.

Method AD_PROFILE_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	LIST	Call by reference	☐	Type reference (TYPE)	SADM_PARAMETER_LIST		Liste mit Tabellenname	20110428

Method AD_PROFILE_LIST on class CL_ADM_MESSAGE has no exception.

Method AD_RESET_BUFFERED_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAME	Call by reference	☐	Type reference (TYPE)	SADM_TABLE		Tabellenname	20110120
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	SY-SUBRC		Rückgabewert von ABAP-Anweisungen	20110120

Method AD_RESET_BUFFERED_TABLE on class CL_ADM_MESSAGE has no exception.

Method AD_RESET_BUFFERED_TABLES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LIST	Call by reference	☐	Type reference (TYPE)	SADM_TABLE_LIST		Liste mit Tabellenname	20110124
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	SY-SUBRC		Rückgabewert von ABAP-Anweisungen	20110124

Method AD_RESET_BUFFERED_TABLES on class CL_ADM_MESSAGE has no exception.

Method AD_SOFT_CANCEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MODE	Call by reference	☐	Type reference (TYPE)	I			20111108
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	I			20111108
3	Importing	TID	Call by reference	☐	Type reference (TYPE)	I			20111108
4	Importing	UID	Call by reference	☐	Type reference (TYPE)	I			20111108

Method AD_SOFT_CANCEL on class CL_ADM_MESSAGE has no exception.

Method AD_WPCONF2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BATCH	Call by reference	☐	Type reference (TYPE)	I			20120611
2	Importing	DIALOG	Call by reference	☐	Type reference (TYPE)	I			20120611
3	Returning	RC	Value transfer	☐	Type reference (TYPE)	I			20120801
4	Exporting	RECEIVED_BATCH_COUNT	Call by reference	☐	Type reference (TYPE)	I			20120611
5	Exporting	RECEIVED_DIALOG_COUNT	Call by reference	☐	Type reference (TYPE)	I			20120611
6	Exporting	RECEIVED_STAND_BY_COUNT	Call by reference	☐	Type reference (TYPE)	I			20120611

Method AD_WPCONF2 on class CL_ADM_MESSAGE has no exception.

Method AD_WPSTAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RC	Value transfer	☐	Type reference (TYPE)	I			20120801
2	Exporting	WPSTATUS_TABLE	Call by reference	☐	Type reference (TYPE)	AD_WPSTAT_TABLE_T			20120611

Method AD_WPSTAT on class CL_ADM_MESSAGE has no exception.

Method APPEND_AD_WPCONF2_REQ_LINE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BATCH	Call by reference	☐	Type reference (TYPE)	I			20120611
2	Importing	DIALOG	Call by reference	☐	Type reference (TYPE)	I			20120611
3	Returning	RC	Value transfer	☐	Type reference (TYPE)	I			20120801
4	Changing	REQ_TBL	Call by reference	☐	Type reference (TYPE)	SADM_MESSAGE_TBL		Tabelle für Request/Response Nachrichten	20120611

Method APPEND_AD_WPCONF2_REQ_LINE on class CL_ADM_MESSAGE has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_ADM_MESSAGE has no parameter.
Method CONSTRUCTOR on class CL_ADM_MESSAGE has no exception.

Method GET_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SADM_MESSAGE_TBL		Tabelle für Request/Response Nachrichten	20110119

Method GET_RESULT on class CL_ADM_MESSAGE has no exception.

Method SEND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXECUTION_LEVEL	Call by reference	☐	Type reference (TYPE)	SADM_EXECUTION		Ort wo die ADM-Nachricht ausgeführt werden sioll	20111110
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	SY-SUBRC		Rückgabewert von ABAP-Anweisungen	20110120

Method SEND on class CL_ADM_MESSAGE has no exception.

Method SET_ACTIVE_SERVER_ONLY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACTIVE_SERVER_ONLY	Call by reference	☐	Type reference (TYPE)	I		1 = nur aktive Server, 0 = alle	20120405

Method SET_ACTIVE_SERVER_ONLY on class CL_ADM_MESSAGE has no exception.

Method SET_ASYNCHRONOUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ASYNC	Call by reference	☐	Type reference (TYPE)	I			20110119

Method SET_ASYNCHRONOUS on class CL_ADM_MESSAGE has no exception.

Method SET_EXECUTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DEST	Call by reference	☐	Type reference (TYPE)	SADM_EXECUTION		Ort wo die ADM-Nachricht ausgeführt werden sioll	20110119

Method SET_EXECUTION on class CL_ADM_MESSAGE has no exception.

Method SET_SERVER_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAME	Call by reference	☐	Type reference (TYPE)	SADM_SERVERNAME		Name des Applikationsservers	20110119

Method SET_SERVER_NAME on class CL_ADM_MESSAGE has no exception.

Method SET_SERVER_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TYPES	Call by reference	☐	Type reference (TYPE)	I			20110119

Method SET_SERVER_TYPES on class CL_ADM_MESSAGE has no exception.

Method SET_SYSTEM_WIDE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	GLOBAL	Call by reference	☐	Type reference (TYPE)	I		1 = systemweit	20110119

Method SET_SYSTEM_WIDE on class CL_ADM_MESSAGE has no exception.

Method SET_TRACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TRACE	Call by reference	☐	Type reference (TYPE)	I			20111109

Method SET_TRACE on class CL_ADM_MESSAGE has no exception.

History

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