SAP ABAP Class CL_SHUTDOWN (Server Shutdown)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CST (Application Component) Client/Server Technology
     ⤷ STSK (Package) Task Handler, Number Range, Update, Gateway and so on

Properties

Class	CL_SHUTDOWN
Short Description	Server Shutdown
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status	S	System Program
Category	0
Package	STSK	Task Handler, Number Range, Update, Gateway and so on
Created	20070907	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_SHUTDOWN has no interface implemented.

Friends

Class CL_SHUTDOWN has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_ACTION_DISABLE_GUI_LOGINS	Constant	Public	☐	Type reference (TYPE)	I	0	Shutdown Action	20070928
2	CO_ACTION_DISABLE_HTTP_LOGINS	Constant	Public	☐	Type reference (TYPE)	I	2	Shutdown Action	20070928
3	CO_ACTION_DISABLE_PER_TASKS	Constant	Public	☐	Type reference (TYPE)	I	4	Shutdown Action	20070928
4	CO_ACTION_DISABLE_RFC_LOGINS	Constant	Public	☐	Type reference (TYPE)	I	1	Shutdown Action	20070928
5	CO_ACTION_DISABLE_RFC_RES	Constant	Private	☐	Type reference (TYPE)	I	8	Shutdown Action	20071112
6	CO_ACTION_DISABLE_SCHEDULING	Constant	Public	☐	Type reference (TYPE)	I	3	Shutdown Action	20070928
7	CO_ACTION_MOVE_SESSIONS	Constant	Public	☐	Type reference (TYPE)	I	11	Shutdown Action	20121107
8	CO_ACTION_SEND_POPUP	Constant	Public	☐	Type reference (TYPE)	I	5	Shutdown Action	20070928
9	CO_ACTION_START_ABAP_ACTIONS	Constant	Public	☐	Type reference (TYPE)	I	6	Shutdown Action	20071025
10	CO_ACTION_START_KERNEL_ACTIONS	Constant	Private	☐	Type reference (TYPE)	I	7	Shutdown Action	20071112
11	CO_ACTION_TEST_FIN_ACTIONS	Constant	Public	☐	Type reference (TYPE)	I	9	Shutdown Action	20080121
12	CO_ACTION_TEST_FIN_K_ACTIONS	Constant	Private	☐	Type reference (TYPE)	I	10	Shutdown Action	20080118
13	CO_KEEP_SESSION_BGRFC	Constant	Public	☐	Type reference (TYPE)	I	1	BGRFC Scheduler Session	20071112
14	CO_KEEP_SESSION_BGRFC_SCHD	Constant	Public	☐	Type reference (TYPE)	I	4	BGRFC Scheduler Session	20121107
15	CO_KEEP_SESSION_BGRFC_UNIT	Constant	Public	☐	Type reference (TYPE)	I	1	BGRFC UNIT Session	20121107
16	CO_KEEP_SESSION_QRFC	Constant	Public	☐	Type reference (TYPE)	I	2	QRFC Scheduler Session	20071112
17	CO_KEEP_SESSION_RUNLEVEL	Constant	Public	☐	Type reference (TYPE)	I	3	Runlevel Framework Session	20121107
18	CO_SHUTDOWN_ACTIVE	Constant	Public	☐	Type reference (TYPE)	I	1	Shutdown Active	20070910
19	CO_SHUTDOWN_NOT_ACTIVE	Constant	Public	☐	Type reference (TYPE)	I	0	Shutdown not Active	20070910
20	CO_SHUTDOWN_REASON_NORMAL	Constant	Public	☐	Type reference (TYPE)	I	0	Normal Shutdown	20121107
21	CO_SHUTDOWN_REASON_OKP	Constant	Public	☐	Type reference (TYPE)	I	1	Shutdown Suring Online Kernel Patch	20121107

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTION	Static method	Public	Method	Checks whether the specified action is to be stopped	20070928
2	CHECK_SYSTEM_MESSAGE	Static method	Public	Method	Deletes system message	20130201
3	CREATE_MSG_ID_FILE_NAME	Static method	Private	Method	Creates the name of the message ID file	20130201
4	GET_INFO	Static method	Public	Method	Read Shutdown State and Info	20070925
5	KEEP_SESSION	Static method	Public	Method	Wait for Session to Close	20071112
6	RELEASE_SESSION	Static method	Public	Method	Do Not Handle Session Separately During Shutdown	20071112
7	REMAINING_TIME_FOR_LONGRUNNER	Static method	Public	Method	Remaining time for long runners (e.g. batch, update)	20130529
8	SET_SYSTEM_MESSAGE	Static method	Public	Method	Creates system message	20130201
9	_ACTION	Static method	Protected	Method	Checks whether the specified action is to be stopped	20071011
10	_GET_INFO	Static method	Protected	Method	Read Shutdown Info from the Kernel	20070925
11	_GET_STATE_AS_INT	Static method	Protected	Method	Read Shutdown State from Kernel (number)	20070919
12	_KEEP_SESSION	Static method	Protected	Method	Wait for Session to Close	20071112
13	_RELEASE_SESSION	Static method	Protected	Method	Do Not Handle Session Separately During Shutdown	20071112
14	_REMAINING_TIME_FOR_LONGRUNNER	Static method	Private	Method	Remaining time for long runners (e.g. batch, update)	20130529

Events

Class CL_SHUTDOWN has no event.

Types

Class CL_SHUTDOWN has no local type.

Method Signatures

Method ACTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACTION	Call by reference	☐	Type reference (TYPE)	SHUTDOWN_ACTION		Aktion, die während des Shutdowns beendet werden soll	20070928
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20070928

#	Exception	Resumable	Description	Created on
1	CX_SHUTDOWN_ERROR	☐	Ausnahme im Shutdown	20070928

Method CHECK_SYSTEM_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FORCE_CHECK	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20130201

Method CHECK_SYSTEM_MESSAGE on class CL_SHUTDOWN has no exception.

Method CREATE_MSG_ID_FILE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	FILE_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Absoluter Name der Message ID Datei	20130201

Method CREATE_MSG_ID_FILE_NAME on class CL_SHUTDOWN has no exception.

Method GET_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)	ABAP_BOOL		Shutdown gestartet	20070926
2	Exporting	ERROR	Call by reference	☐	Type reference (TYPE)	STRING		Shutdown Errors	20080117
3	Exporting	INFO	Call by reference	☐	Type reference (TYPE)	STRING		Shutdown Zusatzinfo	20070925
4	Exporting	REASON	Call by reference	☐	Type reference (TYPE)	I		Shutdown Reason	20121123
5	Importing	SERVER	Call by reference	☑	Type reference (TYPE)	MSNAME2		Name des Applikationsservers	20070925
6	Exporting	STATE	Call by reference	☐	Type reference (TYPE)	STRING		Shutdown Zustand (String)	20070925

#	Exception	Resumable	Description	Created on
1	CX_SHUTDOWN_ERROR	☐	Ausnahme im Shutdown	20070925

Method KEEP_SESSION Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SHUTDOWN_ERROR	☐	Ausnahmen im Shutdown	20071112

Method RELEASE_SESSION Signature

Method RELEASE_SESSION on class CL_SHUTDOWN has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SHUTDOWN_ERROR	☐	Ausnahmen im Shutdown	20071112

Method REMAINING_TIME_FOR_LONGRUNNER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	REMAINING_TIME	Value transfer	☐	Type reference (TYPE)	I		Restzeit für Langläufer	20130529

#	Exception	Resumable	Description	Created on
1	CX_SHUTDOWN_ERROR	☐	Ausnahmen im Shutdown	20130529

Method SET_SYSTEM_MESSAGE Signature

Method SET_SYSTEM_MESSAGE on class CL_SHUTDOWN has no parameter.
Method SET_SYSTEM_MESSAGE on class CL_SHUTDOWN has no exception.

Method _ACTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACTION	Call by reference	☐	Type reference (TYPE)	SHUTDOWN_ACTION		Aktion, die während des Shutdowns beendet werden soll	20071011
2	Exporting	RESULT	Value transfer	☐	Type reference (TYPE)	I		Ergebnis	20071011
3	Exporting	RETURNCODE	Call by reference	☐	Type reference (TYPE)	I		Returncode des Kernels	20071011

Method _ACTION on class CL_SHUTDOWN has no exception.

Method _GET_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR	Call by reference	☐	Type reference (TYPE)	STRING		Shutdown Errors	20080117
2	Exporting	INFO	Call by reference	☐	Type reference (TYPE)	STRING		Shutdown Zusatzinfo	20070925
3	Exporting	REASON	Call by reference	☐	Type reference (TYPE)	I		Reason of shutdown	20121123
4	Exporting	RETURNCODE	Call by reference	☐	Type reference (TYPE)	I		Returncode	20070925
5	Importing	SERVER	Call by reference	☑	Type reference (TYPE)	MSNAME2		Name des Applikationsservers	20070925
6	Exporting	STATE	Call by reference	☐	Type reference (TYPE)	STRING		Shutdown Zustand (String)	20070925
7	Exporting	STATE_INT	Call by reference	☐	Type reference (TYPE)	I		Shutdown Zustand (int)	20070926

Method _GET_INFO on class CL_SHUTDOWN has no exception.

Method _GET_STATE_AS_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RETURNCODE	Call by reference	☐	Type reference (TYPE)	I		Returncode des Kernels	20070926
2	Importing	SERVER	Call by reference	☐	Type reference (TYPE)	MSNAME2		Name des Applikationsservers	20070926
3	Exporting	STATE	Value transfer	☐	Type reference (TYPE)	I		Shutdown-Zustand	20070919

Method _GET_STATE_AS_INT on class CL_SHUTDOWN has no exception.

Method _KEEP_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REASON	Call by reference	☐	Type reference (TYPE)	I		Grund	20071112
2	Exporting	RETURNCODE	Call by reference	☐	Type reference (TYPE)	I		Returncode des Kernels	20071112

Method _KEEP_SESSION on class CL_SHUTDOWN has no exception.

Method _RELEASE_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RETURNCODE	Call by reference	☐	Type reference (TYPE)	I		Returncode des Kernels	20071112

Method _RELEASE_SESSION on class CL_SHUTDOWN has no exception.

Method _REMAINING_TIME_FOR_LONGRUNNER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	REMAINING_TIME	Value transfer	☐	Type reference (TYPE)	I		Restzeit für Langläufer	20130529
2	Exporting	RETURNCODE	Value transfer	☐	Type reference (TYPE)	I		Returncode	20130529

Method _REMAINING_TIME_FOR_LONGRUNNER on class CL_SHUTDOWN has no exception.

History

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