SAP ABAP Class CL_SERVER_INFO (Server Related Information)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CST (Application Component) Client/Server Technology
     ⤷ SSI (Package) Server Infrastructure

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_LOGON_TYPES	Possible types of a logon	20100427
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_WORKER_TYPES	Worker agent types	20100429

Properties

Class	CL_SERVER_INFO
Short Description	Server Related Information
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status	S	System Program
Category	0
Package	SSI	Server Infrastructure
Created	20100427	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

#	Interface	Abstract	Final	Description	Created on
1	IF_LOGON_TYPES	☐	☐	Possible types of a logon	20100427
2	IF_WORKER_TYPES	☐	☐	Worker agent types	20100429

Friends

Class CL_SERVER_INFO has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	BATCH_WPS	Instance attribute	Private	☐	Type reference (TYPE)	SSI_COUNTER	0	Counter	20110311
2	CONFIGURABLE_WPS	Instance attribute	Private	☐	Type reference (TYPE)	SSI_COUNTER	0	Counter	20110311
3	DIALOG_WPS	Instance attribute	Private	☐	Type reference (TYPE)	SSI_COUNTER	0	Counter	20110311
4	DP_HIGH_LOAD	Constant	Public	☐	Type reference (TYPE)	I	1	Load Info	20120229
5	DP_NORMAL_LOAD	Constant	Public	☐	Type reference (TYPE)	I	0	Load Info	20120227
6	DP_RESOURCES_EXHAUSTED	Constant	Public	☐	Type reference (TYPE)	I	2	Load Info	20120228
7	IS_THIS_SERVER	Instance attribute	Private	☐	Type reference (TYPE)	SSI_BOOL	'1'	Boolean Value	20100701
8	NO_RESTART_PENDING	Constant	Public	☐	Type reference (TYPE)	SSI_BOOL	'0'	Boolean Value	20130620
9	RELEASE_INFO	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SERVER_RELEASE_INFO		Server release information	20100430
10	RESTART_IS_PENDING	Constant	Public	☐	Type reference (TYPE)	SSI_BOOL	'1'	Boolean Value	20130620
11	SERVER_NAME	Instance attribute	Public	☑	Type reference (TYPE)	SSI_SERVERNAME		Name of the Application Server	20100427
12	STANDBY_WPS	Instance attribute	Private	☐	Type reference (TYPE)	SSI_COUNTER	0	Counter	20110808
13	USE_DEFAULT_CONF	Constant	Public	☐	Type reference (TYPE)	SSI_BOOL	'1'	Boolean Value	20110318

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20100427
2	GET_COMPATIBILITY_LEVEL	Instance method	Public	Method	Get compatibility level	20110527
3	GET_KERNEL_VERSION_INFO	Instance method	Public	Method	Get kernel version info	20110608
4	GET_LOGON_INFO	Instance method	Public	Method	Get reference to logon info	20100504
5	GET_LOGON_LIST	Instance method	Public	Method	Return the current logon table	20100427
6	GET_PATCH_LEVEL	Instance method	Public	Method	Get patch level	20110523
7	GET_PATCH_NUMBER	Instance method	Public	Method	Get patch number	20110523
8	GET_RELEASE_INFO	Instance method	Public	Method	Get the executables release information	20100430
9	GET_SESSION_INFO	Instance method	Public	Method	Get reference to session info	20100701
10	GET_SESSION_LIST	Instance method	Public	Method	Return the current session table	20100625
11	GET_STATE	Instance method	Public	Method	Get server state	20110510
12	GET_SYSTEM_PKI_INFO	Instance method	Public	Method	Get system PKI info	20121206
13	GET_WORKER_CONF	Instance method	Public	Method	Query the number of workers	20110314
14	GET_WORKER_COUNT	Instance method	Public	Method	Query the number of workers	20100428
15	GET_WORKER_INFO	Instance method	Public	Method	Return reference to worker info	20100428
16	GET_WORKER_LIST	Instance method	Public	Method	Return the current worker list	20111103
17	IS_A_BATCH_SERVER	Instance method	Public	Method	Is this server a batch server	20110708
18	RESTART_PENDING	Instance method	Public	Method	Server restart pending (because of RKS)	20130507
19	SET_WORKER_CONF	Instance method	Public	Method	Set number of workers	20110314
20	_GET_BATCH_SERVER	Instance method	Private	Method	Get batch server info from kernel	20110708
21	_GET_KERNEL_VERSION_INFO	Static method	Private	Method	Get kernel version info	20110608
22	_GET_SESSION_LIST	Static method	Private	Method	Get Session List from kernel	20100625
23	_GET_STATE	Instance method	Private	Method	Get server state from kernel	20110510
24	_GET_SYSTEM_PKI_INFO	Instance method	Private	Method	Get system PKI info from kernel	20121206
25	_GET_WORKER_LIST	Instance method	Private	Method	Get current worker list from kernel	20111103
26	_RESTART_PENDING	Instance method	Private	Method	Get restart pending from kernel	20130507

Events

Class CL_SERVER_INFO has no event.

Types

Class CL_SERVER_INFO has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SERVER_NAME	Call by reference	☑	Type reference (TYPE)	SSI_SERVERNAME		Name des Applikations-Servers	20100427

#	Exception	Resumable	Description	Created on
1	CX_SSI_NO_AUTH	☐	no authority for this action	20120112

Method GET_COMPATIBILITY_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	COMPATIBILITY_LEVEL	Value transfer	☐	Type reference (TYPE)	SSI_COMPATIBILITY_LEVEL		Compatibility Level	20110607

#	Exception	Resumable	Description	Created on
1	CX_SSI_EXCEPTION	☐	Internal error of the ssi package	20110622

Method GET_KERNEL_VERSION_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	KERNEL_VERSION_INFO	Value transfer	☐	Type reference (TYPE)	SSI_KERNEL_VERSION_INFO		Kernel Versions Info	20110608

Method GET_KERNEL_VERSION_INFO on class CL_SERVER_INFO has no exception.

Method GET_LOGON_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LOGON_HDL	Value transfer	☐	Type reference (TYPE)	SSI_LOGON_HDL		Logon Handle	20100504
2	Importing	LOGON_ID	Value transfer	☐	Type reference (TYPE)	SSI_LOGON_ID		Logon Identifikation	20100504
3	Returning	LOGON_INFO	Value transfer	☐	Object reference (TYPE REF TO)	CL_LOGON_INFO		Informationen über eine Anmeldung	20100504

#	Exception	Resumable	Description	Created on
1	CX_SSI_BAD_PARAMETER	☐	no resources	20120112
2	CX_SSI_NO_AUTH	☐	no authority for this action	20120112

Method GET_LOGON_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LOGON_LIST	Value transfer	☐	Type reference (TYPE)	SSI_LOGON_LIST		Liste aller Anmeldungen	20100427

#	Exception	Resumable	Description	Created on
1	CX_SSI_NO_AUTH	☐	no authority for this action	20120112

Method GET_PATCH_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PATCH_LEVEL	Value transfer	☐	Type reference (TYPE)	SSI_PATCHLEVEL		Patchlevel	20110523

#	Exception	Resumable	Description	Created on
1	CX_SSI_EXCEPTION	☐	basic class for ssi exceptions	20110609

Method GET_PATCH_NUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PATCH_NUMBER	Value transfer	☐	Type reference (TYPE)	SSI_PATCHNUMBER		Patch number	20110523

#	Exception	Resumable	Description	Created on
1	CX_SSI_EXCEPTION	☐	basic class for ssi exceptions	20110609

Method GET_RELEASE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RELEASE_INFO	Value transfer	☐	Object reference (TYPE REF TO)	CL_SERVER_RELEASE_INFO		Release information of an executable	20100430

#	Exception	Resumable	Description	Created on
1	CX_SSI_EXCEPTION	☐	basic class for ssi exceptions	20110609

Method GET_SESSION_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LOGON_HDL	Call by reference	☐	Type reference (TYPE)	SSI_LOGON_HDL		Logon Handle	20100701
2	Importing	LOGON_ID	Call by reference	☐	Type reference (TYPE)	SSI_LOGON_ID		Logon Identifikation	20100701
3	Importing	SESSION_HDL	Call by reference	☐	Type reference (TYPE)	SSI_SESSION_HDL		Session Handle	20100701
4	Returning	SESSION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	CL_SESSION_INFO		Get information about a session	20100701

#	Exception	Resumable	Description	Created on
1	CX_SSI_BAD_PARAMETER	☐	no resources	20120112
2	CX_SSI_NO_AUTH	☐	no authority for this action	20120112

Method GET_SESSION_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SESSION_LIST	Value transfer	☐	Type reference (TYPE)	SSI_SESSION_LIST		Liste aller Sessions	20100625
2	Importing	TENANT	Call by reference	☐	Type reference (TYPE)	SSI_TENANT_ID	''	Name des Tenants	20100629
3	Importing	WITH_APPLICATION_INFO	Call by reference	☐	Type reference (TYPE)	SSI_BOOL	1	Boolscher Wert	20100629

#	Exception	Resumable	Description	Created on
1	CX_SSI_NO_AUTH	☐	no authority for this action	20120112

Method GET_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	STATE	Value transfer	☐	Type reference (TYPE)	SSI_SERVER_STATE		Possible runtime states of an application server	20110510

Method GET_STATE on class CL_SERVER_INFO has no exception.

Method GET_SYSTEM_PKI_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ACTIVE	Call by reference	☐	Type reference (TYPE)	I			20121206
2	Exporting	CONFIG_VALID	Call by reference	☐	Type reference (TYPE)	I			20121206

Method GET_SYSTEM_PKI_INFO on class CL_SERVER_INFO has no exception.

Method GET_WORKER_CONF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	BATCH	Value transfer	☐	Type reference (TYPE)	SSI_COUNTER		Zähler	20110314
2	Exporting	CONFIGURABLE	Value transfer	☐	Type reference (TYPE)	SSI_COUNTER		Zähler	20110314
3	Exporting	DIALOG	Value transfer	☐	Type reference (TYPE)	SSI_COUNTER		Zähler	20110314
4	Exporting	STANDBY	Value transfer	☐	Type reference (TYPE)	SSI_COUNTER		Zähler	20110808

#	Exception	Resumable	Description	Created on
1	CX_SSI_INTERNAL	☐	Internal error of the ssi package	20110317

Method GET_WORKER_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	COUNT	Value transfer	☐	Type reference (TYPE)	SSI_COUNTER		Zähler	20100428
2	Importing	TYPE	Call by reference	☑	Type reference (TYPE)	SSI_WORKER_TYPE		List of worker agent counts	20100428

Method GET_WORKER_COUNT on class CL_SERVER_INFO has no exception.

Method GET_WORKER_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INDEX	Call by reference	☐	Type reference (TYPE)	SSI_WORKER_INDEX		Nr des Work Prozess	20100428
2	Returning	WORKER_INFO	Value transfer	☐	Object reference (TYPE REF TO)	CL_WORKER_INFO		Worker agent information	20100428

#	Exception	Resumable	Description	Created on
1	CX_SSI_NO_AUTH	☐	no authority for this action	20120112

Method GET_WORKER_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ONLY_ACTIVE_WORKER	Call by reference	☐	Type reference (TYPE)	SSI_BOOL	0	Boolscher Wert	20111115
2	Importing	WITH_APPLICATION_INFO	Call by reference	☐	Type reference (TYPE)	SSI_BOOL	1	Boolscher Wert	20111104
3	Importing	WITH_CPU	Call by reference	☐	Type reference (TYPE)	SSI_BOOL	0	Boolscher Wert	20111103
4	Importing	WORKER_INDEX	Call by reference	☐	Type reference (TYPE)	SSI_WORKER_INDEX	-1	Info für bestimmten Worker anzeigen	20111208
5	Returning	WORKER_LIST	Value transfer	☐	Type reference (TYPE)	SSI_WORKER_LIST		Liste aller Worker	20111103

#	Exception	Resumable	Description	Created on
1	CX_SSI_NO_AUTH	☐	no authority for this action	20120110

Method IS_A_BATCH_SERVER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	BATCH_SERVER	Value transfer	☐	Type reference (TYPE)	SSI_BOOL		Boolscher Wert	20110708

Method IS_A_BATCH_SERVER on class CL_SERVER_INFO has no exception.

Method RESTART_PENDING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESTART_PENDING	Value transfer	☐	Type reference (TYPE)	SSI_BOOL		Boolscher Wert	20130507

Method RESTART_PENDING on class CL_SERVER_INFO has no exception.

Method SET_WORKER_CONF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BATCH	Value transfer	☐	Type reference (TYPE)	SSI_COUNTER	-1	Zähler	20110314
2	Importing	DIALOG	Value transfer	☐	Type reference (TYPE)	SSI_COUNTER	-1	Zähler	20110314
3	Importing	USE_DEFAULT_CONF	Value transfer	☐	Type reference (TYPE)	SSI_BOOL	'0'	Use default configuration	20110314

#	Exception	Resumable	Description	Created on
1	CX_SSI_BAD_WORKER_CONF	☐	bad worker configuration	20120112
2	CX_SSI_INTERNAL	☐	Internal error of the ssi package	20120112
3	CX_SSI_NO_AUTH	☐	no authority for this action	20110317

Method _GET_BATCH_SERVER Signature

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

Method _GET_BATCH_SERVER on class CL_SERVER_INFO has no exception.

Method _GET_KERNEL_VERSION_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	KERNEL_VERSION_INFO	Value transfer	☐	Type reference (TYPE)	SSI_KERNEL_VERSION_INFO		Kernel Versions Info	20110608

Method _GET_KERNEL_VERSION_INFO on class CL_SERVER_INFO has no exception.

Method _GET_SESSION_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SESSION_LIST	Value transfer	☐	Type reference (TYPE)	SSI_SESSION_LIST		Liste aller Sessions	20100625
2	Importing	TENANT	Call by reference	☐	Type reference (TYPE)	SSI_TENANT_ID	''	Name des Tenants	20100629
3	Importing	WITH_APPLICATION_INFO	Call by reference	☐	Type reference (TYPE)	SSI_BOOL	1	Boolscher Wert	20100629

Method _GET_SESSION_LIST on class CL_SERVER_INFO has no exception.

Method _GET_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RETURN_CODE	Call by reference	☐	Type reference (TYPE)	I			20110510
2	Exporting	STATE	Call by reference	☐	Type reference (TYPE)	SSI_SERVER_STATE		Aktueller Zustand des Applikations-Servers	20110510

Method _GET_STATE on class CL_SERVER_INFO has no exception.

Method _GET_SYSTEM_PKI_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ACTIVE	Call by reference	☐	Type reference (TYPE)	I			20121206
2	Exporting	CONFIG_VALID	Call by reference	☐	Type reference (TYPE)	I			20121206

Method _GET_SYSTEM_PKI_INFO on class CL_SERVER_INFO has no exception.

Method _GET_WORKER_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ONLY_ACTIVE_WORKER	Call by reference	☐	Type reference (TYPE)	SSI_BOOL	0	Boolscher Wert	20111115
2	Importing	WITH_APPLICATION_INFO	Call by reference	☐	Type reference (TYPE)	SSI_BOOL	1	Boolscher Wert	20111104
3	Importing	WITH_CPU	Call by reference	☐	Type reference (TYPE)	SSI_BOOL	'0'	Boolscher Wert	20111103
4	Importing	WORKER_INDEX	Call by reference	☐	Type reference (TYPE)	SSI_WORKER_INDEX	-1	Info für bestimmten Wp anzeigen	20111208
5	Returning	WORKER_LIST	Value transfer	☐	Type reference (TYPE)	SSI_WORKER_LIST		Liste aller Worker	20111103

Method _GET_WORKER_LIST on class CL_SERVER_INFO has no exception.

Method _RESTART_PENDING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RESTART_PENDING	Call by reference	☐	Type reference (TYPE)	SSI_BOOL		Restart pending	20130507
2	Exporting	RETURN_CODE	Call by reference	☐	Type reference (TYPE)	I			20130507

Method _RESTART_PENDING on class CL_SERVER_INFO has no exception.

History

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