SAP ABAP Class CL_CSI_PROFILE (CSI Administration Profile)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-RCC (Application Component) Remote Control and Communication Framework
     ⤷ CSI_ADMIN (Package) Cloud Service Administration

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CSI_INSTANCE_EVENTHANDLER	CSI Instance Eventhandler	20110912

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_CSI_PROFILE_AWS	CSI AWS Administration Profile Implementation	20091104
2	Inheritance (c INHERITING FROM c_ref)	CL_CSI_TEST_PROFILE	CSI Test Profile	20110805

Properties

Class	CL_CSI_PROFILE
Short Description	CSI Administration Profile
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	CSI_ADMIN	Cloud Service Administration
Created	20091103	SAP
Last change	20130531	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_CSI_INSTANCE_EVENTHANDLER	☐	☐	CSI Instance Eventhandler	20110912

Friends

#	Friend	Modeled only	Created on	Description
1	CL_CSI_INSTANCE_LOGGING	☐	20110715	CSI Instance Logging
2	CL_CSI_PROFILE_COMMAND	☐	20100105	CSI Administration Profile Commands

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GS_PROFILE	Instance attribute	Protected	☐	Type reference (TYPE)	CSIS_PROFILE			20100104
2	GV_NAME	Instance attribute	Public	☑	Type reference (TYPE)	CSI_PROFILE_NAME		Profile Name	20091104
3	MO_ACCOUNT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CSI_PROVIDER_ACCOUNT		CSI Cloud Provider Account	20100104
4	MO_INSTANCE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CSI_INSTANCE_HANDLER		CSI Instance	20091113
5	MO_PROVIDER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CSI_PROVIDER		Cloud Service Provider	20091104
6	MT_FOR_DELETION	Instance attribute	Private	☐	Type reference (TYPE)	CSIT_INSTANCE		CSI Cloud Instances	20110912
7	MT_INSTANCES	Instance attribute	Private	☐	Type reference (TYPE)	LTYT_INSTANCE		CSI Cloud Instances	20091113
8	MT_NEW_NODES	Instance attribute	Private	☐	Type reference (TYPE)	CSIT_NODE_OBJ		CSI Cloud Instances	20110912
9	MT_TEMP_UNAVAILABLE	Instance attribute	Private	☐	Type reference (TYPE)	CSIT_INSTANCE		CSI Cloud Instances	20110912
10	SO_DATA	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_CSI_DATASTORE		CSI Datastore Interface	20100104
11	ST_LISTENERS	Static Attribute	Private	☐	Type reference (TYPE)	CSIT_PROFILE_LISTENERS		Administration Profile Listeners Table	20100104
12	ST_PROFILE_OBJ	Static Attribute	Private	☐	Type reference (TYPE)	CSIT_PROFILE_OBJ			20110810

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_CMD_AUTHORITY	Static method	Public	Method	Check the authority for the instance command	20110819
2	CHECK_LISTENERS	Instance method	Public	Method	Check the Profile Name at each Listener	20091104
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20091104
4	CONSTRUCTOR	Instance method	Protected	Constructor	CONSTRUCTOR	20091104
5	CREATE	Static method	Public	Method	Create a new CSI Profile	20091110
6	DELETE	Instance method	Public	Method	Delete the Data (e.g. from all listeners)	20091109
7	DELETE_FROM_LISTENERS	Instance method	Private	Method	Delete Profile from all Listeners	20091104
8	DELETE_PERSIST	Instance method	Private	Method	Delete the profile	20110810
9	GET_ACCOUNT	Instance method	Public	Method	Get the Account bound to this Profile	20100104
10	GET_COMMAND	Instance method	Public	Method	Get the Command Object to Control Instances of the Profile	20100108
11	GET_DATA	Instance method	Public	Method	Get new Data	20091111
12	GET_INSTANCE	Instance method	Public	Method	Get the Instance Object	20100111
13	GET_INSTANCES	Instance method	Public	Method	Get (all) instances started via that profile	20110616
14	GET_INSTANCE_FINAL_STATUS	Instance method	Public	Method	Get the final status for an instance	20110715
15	GET_INSTANCE_ID_COMPONENT	Instance method	Public	Method	Get the instance component relevant for identifying	20110721
16	GET_PROFILE_PARAMETER	Instance method	Public	Method	Get profile data as parameter	20110321
17	GET_PROVIDER	Instance method	Public	Method	Get the Provider bound to this Profile	20091113
18	INSTANCE_REFRESH	Instance method	Private	Method	Refresh Instance(s)	20110715
19	INSTANCE_START	Instance method	Private	Method	Start Instance(s)	20100105
20	INSTANCE_STOP	Instance method	Private	Method	Stop Instance(s)	20100105
21	IS_NAME_ALLOWED	Static method	Public	Method	Check a given Profile Name	20100105
22	IS_REGISTER_ON_DEMAND	Instance method	Public	Method	Can we register Profiles On Demand	20091113
23	LIST	Static method	Public	Method	List all Profiles	20100111
24	OPEN	Static method	Public	Method	Open an existing CSI Profile	20091110
25	REGISTER	Instance method	Public	Method	Register Instances	20091113
26	RELEASE	Instance method	Public	Method	Release Instances	20091113
27	SAVE	Instance method	Public	Method	Save the Data (e.g. to all listeners)	20091109
28	SAVE_PERSIST	Instance method	Private	Method	Save the profile	20110810
29	SAVE_TO_LISTENERS	Instance method	Private	Method	Save the Profile to all Listeners	20091104
30	SET_DATA	Instance method	Public	Method	Set new Data	20091111
31	_GET_INSTANCE_FINAL_STATUS	Instance method	Protected	Method	# Get the final status for an instance	20110715
32	_GET_INSTANCE_ID_COMPONENT	Instance method	Protected	Method	# Get the instance component relevant for identifying	20110721
33	_GET_PROFILE_PARAMETER	Instance method	Protected	Method	# Get Profile Parameter	20110321

Events

Class CL_CSI_PROFILE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LTYS_INSTANCE	Private	See coding			20091118	BEGIN OF ltys_instance, on_demand TYPE abap_bool, instances TYPE csit_instance, END OF ltys_instance
2	LTYT_INSTANCE	Private	See coding			20091118	ltyt_instance TYPE HASHED TABLE OF ltys_instance WITH UNIQUE KEY on_demand

Method Signatures

Method CHECK_CMD_AUTHORITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLEANUP	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20110819
2	Importing	IV_COMMAND	Call by reference	☐	Type reference (TYPE)	CSI_PROFILE_COMMAND		CSI Profile Command	20110819
3	Importing	IV_FILTER	Call by reference	☑	Type reference (TYPE)	CSI_PROFILE_INSTANCE_FILTER		CSI Profile Instance Filter -> if_csi_profile_c	20110819
4	Importing	IV_MSG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20110819
5	Importing	IV_PROFILE_NAME	Call by reference	☑	Type reference (TYPE)	CSI_PROFILE_NAME		CSI Profile Name	20110819
6	Returning	RV_OK	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20110819

Method CHECK_CMD_AUTHORITY on class CL_CSI_PROFILE has no exception.

Method CHECK_LISTENERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_OK	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20091109

Method CHECK_LISTENERS on class CL_CSI_PROFILE has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_CSI_PROFILE has no parameter.
Method CLASS_CONSTRUCTOR on class CL_CSI_PROFILE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PROFILE_NAME	Call by reference	☐	Type reference (TYPE)	CSI_PROFILE_NAME		Profile Name	20091110

Method CONSTRUCTOR on class CL_CSI_PROFILE has no exception.

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROVIDER	Call by reference	☑	Object reference (TYPE REF TO)	CL_CSI_PROVIDER		Cloud Service Provider	20091110
2	Importing	IV_ACCOUNT_NAME	Call by reference	☑	Type reference (TYPE)	CSI_PROVIDER_ACCOUNT_NAME		Cloud Provider Account Name	20100105
3	Importing	IV_PROFILE_NAME	Call by reference	☐	Type reference (TYPE)	CSI_PROFILE_NAME		Profile Name	20091110
4	Importing	IV_PROVIDER_NAME	Call by reference	☑	Type reference (TYPE)	CSI_PROVIDER_NAME		Cloud Provider Name	20091110
5	Returning	RO_PROFILE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CSI_PROFILE		Administration Profile	20091110

#	Exception	Resumable	Description	Created on
1	CX_CSI_PROFILE	☐	Provider Exception Class	20091110

Method DELETE Signature

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

Method DELETE on class CL_CSI_PROFILE has no exception.

Method DELETE_FROM_LISTENERS Signature

Method DELETE_FROM_LISTENERS on class CL_CSI_PROFILE has no parameter.
Method DELETE_FROM_LISTENERS on class CL_CSI_PROFILE has no exception.

Method DELETE_PERSIST Signature

Method DELETE_PERSIST on class CL_CSI_PROFILE has no parameter.
Method DELETE_PERSIST on class CL_CSI_PROFILE has no exception.

Method GET_ACCOUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_ACCOUNT	Value transfer	☐	Object reference (TYPE REF TO)	CL_CSI_PROVIDER_ACCOUNT		CSI Cloud Provider Account	20100104

Method GET_ACCOUNT on class CL_CSI_PROFILE has no exception.

Method GET_COMMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_COMMAND	Value transfer	☐	Object reference (TYPE REF TO)	CL_CSI_PROFILE_COMMAND		CSI Administration Profile Commands	20100108

Method GET_COMMAND on class CL_CSI_PROFILE has no exception.

Method GET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_PROFILE	Value transfer	☐	Type reference (TYPE)	CSIS_PROFILE		Administration Profile for Cloud Providers	20100105

Method GET_DATA on class CL_CSI_PROFILE has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INSTANCE_ID	Call by reference	☐	Type reference (TYPE)	CSI_INSTANCE_ID		CSI Name of an Instance	20110713
2	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CSI_INSTANCE		CSI Cloud Instance	20100111

Method GET_INSTANCE on class CL_CSI_PROFILE has no exception.

Method GET_INSTANCES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CHECK_AVAILABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Check the instances for availability	20110818
2	Importing	IV_FREE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20110616
3	Returning	RT_INSTANCES	Value transfer	☐	Type reference (TYPE)	CSIT_INSTANCE		CSI Cloud Instances	20110616

#	Exception	Resumable	Description	Created on
1	CX_CSI_INSTANCE	☐	CSI instance Exception	20110818

Method GET_INSTANCE_FINAL_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	CSI_INSTANCE_STATE		CSI Instance Status	20110715

Method GET_INSTANCE_FINAL_STATUS on class CL_CSI_PROFILE has no exception.

Method GET_INSTANCE_ID_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ID_COMPONENT	Value transfer	☐	Type reference (TYPE)	NAME_KOMP		Component name	20110721

Method GET_INSTANCE_ID_COMPONENT on class CL_CSI_PROFILE has no exception.

Method GET_PROFILE_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_PARAMETER	Value transfer	☐	Type reference (TYPE)	CSIT_PROVIDER_PARAMETER		Cloud Service Parameter	20110321

Method GET_PROFILE_PARAMETER on class CL_CSI_PROFILE has no exception.

Method GET_PROVIDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_PROVIDER	Value transfer	☐	Object reference (TYPE REF TO)	CL_CSI_PROVIDER		CSI Cloud Service Provider	20091113

Method GET_PROVIDER on class CL_CSI_PROFILE has no exception.

Method INSTANCE_REFRESH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_INSTANCES	Call by reference	☐	Type reference (TYPE)	CSIT_INSTANCE		CSI Cloud Instances	20110715
2	Returning	RT_RESULT	Value transfer	☐	Type reference (TYPE)	CSIT_PROFILE_COMMAND_RESULT		CSI Profile Command Result	20110715

Method INSTANCE_REFRESH on class CL_CSI_PROFILE has no exception.

Method INSTANCE_START Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_INSTANCES	Call by reference	☑	Type reference (TYPE)	CSIT_INSTANCE		CSI Cloud Instances	20100105
2	Exporting	ET_NODES	Call by reference	☐	Type reference (TYPE)	CSIT_NODE_OBJ		CSI Node Object Table	20110723
3	Importing	IV_CALLER	Call by reference	☑	Type reference (TYPE)	CSI_SESSION		The caller for reserving slots	20110723
4	Importing	IV_INSTANCE_COUNT	Call by reference	☐	Type reference (TYPE)	CSI_INSTANCE_COUNT	0	# of instance to start	20110723
5	Importing	IV_SLOT_PER_INSTANCE	Call by reference	☐	Type reference (TYPE)	CSI_SLOT_RESERVED	0	Reserved slots per instance	20110723

#	Exception	Resumable	Description	Created on
1	CX_CSI_NODE	☐	CSI Node Exceptions	20100107

Method INSTANCE_STOP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_INSTANCES	Call by reference	☐	Type reference (TYPE)	CSIT_INSTANCE		CSI Cloud Node Identifier	20100105
2	Returning	RT_RESULT	Value transfer	☐	Type reference (TYPE)	CSIT_PROFILE_COMMAND_RESULT		CSI Profile Command Result	20100111

#	Exception	Resumable	Description	Created on
1	CX_CSI_NODE	☐	CSI Node Exceptions	20100107

Method IS_NAME_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PROFILE_NAME	Call by reference	☐	Type reference (TYPE)	CSI_PROFILE_NAME		Profile Name	20100105
2	Returning	RV_OK	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100105

Method IS_NAME_ALLOWED on class CL_CSI_PROFILE has no exception.

Method IS_REGISTER_ON_DEMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ONDEMAND	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20091113

Method IS_REGISTER_ON_DEMAND on class CL_CSI_PROFILE has no exception.

Method LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_PROFILE_OBJ	Value transfer	☐	Type reference (TYPE)	CSIT_PROFILE_OBJ		CSI Profile Object Table	20100111

Method LIST on class CL_CSI_PROFILE has no exception.

Method OPEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PROFILE_NAME	Call by reference	☐	Type reference (TYPE)	CSI_PROFILE_NAME		Profile Name	20091110
2	Returning	RO_PROFILE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CSI_PROFILE		Administration Profile	20091110

#	Exception	Resumable	Description	Created on
1	CX_CSI_PROFILE	☐	Provider Exception Class	20091110

Method REGISTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ALLOW_ON_DEMAND	Call by reference	☐	Type reference (TYPE)	CSI_BOOL	ABAP_TRUE	CSI Bool Field	20100114
2	Importing	IV_INSTANCE_COUNT	Call by reference	☐	Type reference (TYPE)	CSI_INSTANCE_COUNT	1	CSI Number of Instances	20091113
3	Importing	IV_SESSION	Call by reference	☐	Type reference (TYPE)	CSI_SESSION		CSI Session GUID	20091113
4	Importing	IV_SLOT_PER_INSTANCE	Call by reference	☐	Type reference (TYPE)	CSI_SLOT_RESERVED	1	Number of slots per instance	20110723
5	Returning	RT_INSTANCES	Value transfer	☐	Type reference (TYPE)	CSIT_INSTANCE		CSI Instance Name Table	20110722

#	Exception	Resumable	Description	Created on
1	CX_CSI_INSTANCE	☐	CSI instance Exception	20091113

Method RELEASE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_INSTANCE_IDS	Call by reference	☐	Type reference (TYPE)	CSIT_INSTANCE_IDS		CSI Instance Name Table	20110722
2	Importing	IV_SESSION	Call by reference	☑	Type reference (TYPE)	CSI_SESSION		CSI Session GUID	20110722
3	Importing	IV_SLOT_PER_INSTANCE	Call by reference	☐	Type reference (TYPE)	CSI_SLOT_RESERVED	1	Reserved slots per instance	20110723

#	Exception	Resumable	Description	Created on
1	CX_CSI_INSTANCE	☐	CSI instance Exception	20091113

Method SAVE Signature

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

Method SAVE on class CL_CSI_PROFILE has no exception.

Method SAVE_PERSIST Signature

Method SAVE_PERSIST on class CL_CSI_PROFILE has no parameter.
Method SAVE_PERSIST on class CL_CSI_PROFILE has no exception.

Method SAVE_TO_LISTENERS Signature

Method SAVE_TO_LISTENERS on class CL_CSI_PROFILE has no parameter.
Method SAVE_TO_LISTENERS on class CL_CSI_PROFILE has no exception.

Method SET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_PROFILE	Call by reference	☐	Type reference (TYPE)	CSIS_PROFILE		Administration Profile for Cloud Providers	20091111

#	Exception	Resumable	Description	Created on
1	CX_CSI_PROFILE	☐	Administration Profile Exceptions	20091111

Method _GET_INSTANCE_FINAL_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	CSI_INSTANCE_STATE		CSI Instance Status	20110715

Method _GET_INSTANCE_FINAL_STATUS on class CL_CSI_PROFILE has no exception.

Method _GET_INSTANCE_ID_COMPONENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ID_COMPONENT	Value transfer	☐	Type reference (TYPE)	NAME_KOMP		Component name	20110721

Method _GET_INSTANCE_ID_COMPONENT on class CL_CSI_PROFILE has no exception.

Method _GET_PROFILE_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_PARAMETER	Value transfer	☐	Type reference (TYPE)	CSIT_PROVIDER_PARAMETER		Cloud Service Parameter	20110321

Method _GET_PROFILE_PARAMETER on class CL_CSI_PROFILE has no exception.

History

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