SAP ABAP Class CL_RCC_ENGINE_TOOL (Helper methods for the engine class)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-RCC (Application Component) Remote Control and Communication Framework
     ⤷ RCC_ENGINE (Package) RCCF: Engine

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_RCC_ENGINE_C	RCCF Engine Interface	20091023

Properties

Class	CL_RCC_ENGINE_TOOL
Short Description	Helper methods for the engine class
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	RCC_ENGINE	RCCF: Engine
Created	20091023	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_RCC_ENGINE_TOOL has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_RCC_ENGINE_C	☐	☐	RCCF Engine Interface	20091023

Friends

Class CL_RCC_ENGINE_TOOL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_APP_ID	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
2	GC_CUSTOMIZINGID_ID	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
3	GC_DESTID_ID	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
4	GC_ENGINE_MODE_APPLICATION	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
5	GC_ENGINE_MODE_RCCFTEST	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
6	GC_ENGINE_MODE_TOOL	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
7	GC_ENGINE_RESULT_FAILED	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
8	GC_ENGINE_RESULT_INITIAL	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
9	GC_ENGINE_RESULT_NORESULT	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
10	GC_ENGINE_RESULT_SUCCESS	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
11	GC_ENGINE_RESULT_WARNING	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
12	GC_ENGINE_TOOL_CMD_DELETE_FILE	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
13	GC_ENGINE_TOOL_CMD_KILL_PROC	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
14	GC_ENGINE_TOOL_CMD_LIST_DIR	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
15	GC_ENGINE_TOOL_CMD_LIST_PROC	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
16	GC_ENGINE_TOOL_CMD_UPLOAD_ARC	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
17	GC_ENGINE_TOOL_CMD_UPLOAD_BIN	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
18	GC_ENGINE_TOOL_CMD_UPLOAD_FILE	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
19	GC_ENGINE_TOOL_CMD_UPLOAD_GZIP	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
20	GC_ENGINE_TOOL_CMD_UPLOAD_SGW	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
21	GC_ENGINE_TOOL_CMD_UPLOAD_TEXT	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
22	GC_ENGINE_TOOL_CMD_VERSION	Instance attribute	Private	☐	Attribute reference (LIKE)				20110711
23	GC_MODE_SINGLE	Constant	Public	☐	Type reference (TYPE)	I	2		20091023
24	GC_MODE_TIMESTAMP	Constant	Public	☐	Type reference (TYPE)	I	1		20091023
25	GC_PROFILE_ID	Instance attribute	Public	☐	Attribute reference (LIKE)				20110711
26	GC_TIMESTAMP_ID	Instance attribute	Public	☐	Attribute reference (LIKE)				20110711
27	GC_TOOL_COMMAND	Instance attribute	Public	☐	Attribute reference (LIKE)				20110711
28	GC_TOOL_COMMAND_SPLIT	Instance attribute	Public	☐	Attribute reference (LIKE)				20110711
29	GC_TOOL_PREFIX	Instance attribute	Public	☐	Attribute reference (LIKE)				20110711
30	GC_TOOL_SECTION	Instance attribute	Public	☐	Attribute reference (LIKE)				20110711

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_DEFAULT_COMMAND	Static method	Private	Method	Get the default command structure	20091023
2	GET_FULL_TOOL_COMMAND	Static method	Public	Method	Get the full command from a tool command	20091023
3	GET_TOOL_CMDLINE_FROM_PARAM	Static method	Public	Method	Get the current tool mode command line from the parameters	20091023
4	GET_TOOL_CMD_FROM_PARAM	Static method	Public	Method	Get the current tool mode command from the parameters	20091023
5	GET_TOOL_COMMAND	Static method	Public	Method	Get the tool command from a command-string	20091023
6	GET_TOOL_DELETE	Static method	Public	Method	Get the Delete Process command	20091023
7	GET_TOOL_KILLPROC	Static method	Public	Method	Get the Kill Process command	20091023
8	GET_TOOL_LISTDIR	Static method	Public	Method	Get the List Directory command	20100212
9	GET_TOOL_LISTPROC	Static method	Public	Method	Get the List Process command	20091023
10	GET_TOOL_UPLOADFILE	Static method	Public	Method	Get the Upload File command	20091023
11	GET_TOOL_UPLOADSGWTRACE	Static method	Public	Method	Get the Upload Service Gateway Trace command	20110609
12	GET_TOOL_VERSION	Static method	Public	Method	Get the Version command	20091023

Events

Class CL_RCC_ENGINE_TOOL has no event.

Types

Class CL_RCC_ENGINE_TOOL has no local type.

Method Signatures

Method GET_DEFAULT_COMMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMMAND	Call by reference	☐	Type reference (TYPE)	RCC_PARAM_STRING_VALUE		RCCF Parameter: Character String	20091023
2	Returning	RS_PARAMETER	Value transfer	☐	Type reference (TYPE)	RCCS_COMM_PARAMETER		Parameter Structure for Transferring All Parameters in RCCF	20091023

Method GET_DEFAULT_COMMAND on class CL_RCC_ENGINE_TOOL has no exception.

Method GET_FULL_TOOL_COMMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TOOL_MODE_COMMAND	Call by reference	☐	Type reference (TYPE)	RCC_ENGINE_TOOL_MODE_COMMAND		Command for the Engine Tool Mode	20091023
2	Returning	RV_TOOL_COMMAND	Value transfer	☐	Type reference (TYPE)	STRING			20091023

Method GET_FULL_TOOL_COMMAND on class CL_RCC_ENGINE_TOOL has no exception.

Method GET_TOOL_CMDLINE_FROM_PARAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ENGINE	Call by reference	☐	Object reference (TYPE REF TO)	IF_RCC_ENGINE		RCCF Engine Interface	20091023
2	Returning	RV_CURRENT_TOOLCOMMANDLINE	Value transfer	☐	Type reference (TYPE)	RCC_PARAM_STRING_VALUE		RCCF Parameter: Character String	20091023

Method GET_TOOL_CMDLINE_FROM_PARAM on class CL_RCC_ENGINE_TOOL has no exception.

Method GET_TOOL_CMD_FROM_PARAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ENGINE	Call by reference	☐	Object reference (TYPE REF TO)	IF_RCC_ENGINE		RCCF Engine Interface	20091023
2	Returning	RV_CURRENT_TOOLCOMMAND	Value transfer	☐	Type reference (TYPE)	RCC_ENGINE_TOOL_MODE_COMMAND		Command for the Engine Tool Mode	20091023

Method GET_TOOL_CMD_FROM_PARAM on class CL_RCC_ENGINE_TOOL has no exception.

Method GET_TOOL_COMMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TOOL_COMMAND	Call by reference	☐	Type reference (TYPE)	STRING			20091023
2	Returning	RV_TOOL_MODE_COMMAND	Value transfer	☐	Type reference (TYPE)	RCC_ENGINE_TOOL_MODE_COMMAND		Command for the Engine Tool Mode	20091023

Method GET_TOOL_COMMAND on class CL_RCC_ENGINE_TOOL has no exception.

Method GET_TOOL_DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DATE	Call by reference	☑	Type reference (TYPE)	DATS		Field of type DATS	20091023
2	Importing	IV_DELETION_MODE	Call by reference	☑	Type reference (TYPE)	I		Type of deletion (single file or multiples)	20091023
3	Importing	IV_DIRECTORY	Call by reference	☐	Type reference (TYPE)	RCC_FILE_PATH	`.`	File Path of a File on the Engine Server	20091023
4	Importing	IV_FILEPATH	Call by reference	☑	Type reference (TYPE)	RCC_FILE_PATH		File Path of a File on the Engine Server	20091023
5	Returning	RS_PARAMETER	Value transfer	☐	Type reference (TYPE)	RCCS_COMM_PARAMETER		Parameter Structure for Transferring All Parameters in RCCF	20091023

Method GET_TOOL_DELETE on class CL_RCC_ENGINE_TOOL has no exception.

Method GET_TOOL_KILLPROC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PROCID	Call by reference	☐	Type reference (TYPE)	RCC_ENG_PROCID		Process ID of External Engine in RCCF	20091023
2	Importing	IV_PROCNAME	Call by reference	☐	Type reference (TYPE)	RCC_ENG_PROCNAME		Process Name of External Engine in RCCF	20091023
3	Returning	RS_PARAMETER	Value transfer	☐	Type reference (TYPE)	RCCS_COMM_PARAMETER		Parameter Structure for Transferring All Parameters in RCCF	20091023

Method GET_TOOL_KILLPROC on class CL_RCC_ENGINE_TOOL has no exception.

Method GET_TOOL_LISTDIR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DIRECTORY	Call by reference	☐	Type reference (TYPE)	RCC_FILE_PATH	`.`	File Path of a File on the Engine Server	20100212
2	Returning	RS_PARAMETER	Value transfer	☐	Type reference (TYPE)	RCCS_COMM_PARAMETER		Parameter Structure for Transferring All Parameters in RCCF	20100212

Method GET_TOOL_LISTDIR on class CL_RCC_ENGINE_TOOL has no exception.

Method GET_TOOL_LISTPROC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_PARAMETER	Value transfer	☐	Type reference (TYPE)	RCCS_COMM_PARAMETER		Parameter Structure for Transferring All Parameters in RCCF	20091023

Method GET_TOOL_LISTPROC on class CL_RCC_ENGINE_TOOL has no exception.

Method GET_TOOL_UPLOADFILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FILEPATHS	Call by reference	☐	Type reference (TYPE)	RCCT_FILE_PATH_STORE		Table of Multiple File Paths	20091023
2	Importing	IV_TRANSFERMODE	Call by reference	☐	Type reference (TYPE)	RCC_FILE_TRANSFERMODE		File Transfer Mode in RCCF	20091023
3	Returning	RT_PARAMETER	Value transfer	☐	Type reference (TYPE)	RCCT_COMM_PARAMETER		Parameter Structure for Transferring All Parameters in RCCF	20091023

Method GET_TOOL_UPLOADFILE on class CL_RCC_ENGINE_TOOL has no exception.

Method GET_TOOL_UPLOADSGWTRACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SLOT_NAME	Call by reference	☑	Type reference (TYPE)	RCC_SERVICE_SLOT_NAME		RCCF Service Slot Name	20110609
2	Returning	RS_PARAMETER	Value transfer	☐	Type reference (TYPE)	RCCS_COMM_PARAMETER		Parameter Structure for Transferring All Parameters in RCCF	20110609

Method GET_TOOL_UPLOADSGWTRACE on class CL_RCC_ENGINE_TOOL has no exception.

Method GET_TOOL_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_APP	Call by reference	☑	Type reference (TYPE)	RCCT_APP		CSV List of Engines	20110711
2	Returning	RS_PARAMETER	Value transfer	☐	Type reference (TYPE)	RCCS_COMM_PARAMETER		Parameter Structure for Transferring All Parameters in RCCF	20091023

Method GET_TOOL_VERSION on class CL_RCC_ENGINE_TOOL has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	702