SAP ABAP Class CL_DB2_FAILOVER_CONFIG (Master class for the failover configuration)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DB-DB2 (Application Component) DB2 for z/OS
     ⤷ STU2 (Package) CCMS for DB2 for OS/390
Properties
Class CL_DB2_FAILOVER_CONFIG  
Short Description Master class for the failover configuration    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package STU2   CCMS for DB2 for OS/390 
Created 20111107   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_DB2_FAILOVER_CONFIG has no interface implemented.
Friends
Class CL_DB2_FAILOVER_CONFIG has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CO_CREATE_BACKUP Constant Public Type reference (TYPE) I 1 20131023
2 CO_WRITE_FILE Constant Public Type reference (TYPE) I 0 20131023
3 CURRENT_LOADED_FORMAT Static Attribute Public Type reference (TYPE) I remembers which file format was loaded 20120123
4 CURRENT_SYSDATA Static Attribute Public Type reference (TYPE) DB6NAVSYST System data of the current remote sys 20111215
5 CURRENT_SYSTEM_IS_ABAP Static Attribute Public Type reference (TYPE) ABAP_BOOL tells me if monitored system is abap stack 20120322
6 DATABASES Static Attribute Private Type reference (TYPE) DB2_FAILOVER_T_DB holds database sections in failover configuration 20111117
7 DETECTED_DS_MEMBER Static Attribute Public Type reference (TYPE) DB2DSMEM_TAB table of available ds member 20120323
8 FAILOVER_CONFIG_TABLE Static Attribute Private Type reference (TYPE) DB2_FAILOVER_T_DSN_ELEMENT Table of DSN_Elements, at the moment only one element in it 20111116
9 FILE_SOURCE_DISK_READ Static Attribute Public Type reference (TYPE) I 100 Constant for disk read file 20120131
10 FILE_SOURCE_UPLOAD Static Attribute Public Type reference (TYPE) I 99 Constant for uploaded file 20120131
11 FORMAT_ABAP_INI Static Attribute Public Type reference (TYPE) I 3 Constant for current Parsing format abap_ini 20120119
12 FORMAT_ABAP_XML Static Attribute Public Type reference (TYPE) I 2 Constant for current Parsing format abap_xml 20120119
13 FORMAT_JAVA_XML Static Attribute Public Type reference (TYPE) I 1 Constant for current Parsing format java 20120119
14 IS_DS Static Attribute Public Type reference (TYPE) ABAP_BOOL is monitored system data_sharing 20120323
15 IS_STANDALONE_SYSTEM Static Attribute Public Type reference (TYPE) ABAP_BOOL is current loaded config from a monitored system 20130905
16 MSG_BROKER Static Attribute Public Object reference (TYPE REF TO) CL_DB2_MESSAGE_QUEUE holds a reference to the failover message broker 20120208
17 REGISTERED_PARSER Static Attribute Private See coding Hold references to all registered parsers 20111109
18 RFC_DES Static Attribute Public Type reference (TYPE) RFC_DEST SAPOSCOL destination 20120105
19 RFC_OK Static Attribute Public Type reference (TYPE) ABAP_BOOL is rfc of remote connection working 20120322
20 XML_FILE_PARAMETERS Static Attribute Private Type reference (TYPE) DB2_FAILOVER_T_PARAMETER DB2: Failover Configuration: table that contains parameter 20130905
Methods
# Method Level Visibility Method type Description Created on
1 ADJUST_DB_REFERENCES Static method Public Method enable the references in a copied database 20121026
2 CLASS_CONSTRUCTOR Static method Public Constructor 20120622
3 CLEAR_AT_CONFIG_RELOAD Static method Public Method clears the backend at config reload 20120830
4 CLEAR_AT_SYSTEM_CHANGED Static method Public Method clears the data structure 20120830
5 CONVERT_TAB_DB2CONINI_TO_STR_T Static method Private Method converts a Standard table of db2conini to dba_string_tab 20120124
6 GET_DB2_DS_DETAILS Static method Public Method Returns DDFLOCATION Details to current monitored system 20130905
7 GET_DB_OF_DSN Static method Public Method deliver databases of currently selected dsn to the frontend 20111129
8 GET_FAILOVER_MECHANISM Static method Public Method Returns which failover format is active uses constants 20120314
9 GET_TREE_DATA Static method Public Method deliver ready formatted data to the frontend 20111111
10 GIVE_CHANGED_DATA Static method Public Method receives changed data 20111130
11 PARSE Static method Public Method This method is going to parse a failover config file 20111107
12 PREPARE_XML_FOR_WRITE Static method Private Method prepares the content for writing 20120207
13 READ_ABAP_XML Static method Private Method this method reads a local abap_xml db2dsdriver.cfg file 20120123
14 READ_CONNECT_INI Static method Private Method This method reads a connect.ini file 20120105
15 REGISTER_PARSER Static method Public Method register and instantiate parser object for a specific file 20111109
16 RENDER Static method Public Method This method is going to render a failover config file 20111107
17 WRITE_ABAP_XML Static method Private Method writes an db2dsdriver.cfg 20120123
18 WRITE_CONNECT_INI Static method Private Method 20120123
19 WRITE_TO_DISK Static method Public Method writes the given format to disk and renders it before 20120123
Events
Class CL_DB2_FAILOVER_CONFIG has no event.
Types
Class CL_DB2_FAILOVER_CONFIG has no local type.
Method Signatures

Method ADJUST_DB_REFERENCES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DATABASE_NEW Call by reference Object reference (TYPE REF TO) DB2_FAILOVER_DB DB2: Failover Configuration: Structure for different DBs 20121026

Method ADJUST_DB_REFERENCES on class CL_DB2_FAILOVER_CONFIG has no exception.

Method CLASS_CONSTRUCTOR Signature

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

Method CLEAR_AT_CONFIG_RELOAD Signature

Method CLEAR_AT_CONFIG_RELOAD on class CL_DB2_FAILOVER_CONFIG has no parameter.
Method CLEAR_AT_CONFIG_RELOAD on class CL_DB2_FAILOVER_CONFIG has no exception.

Method CLEAR_AT_SYSTEM_CHANGED Signature

Method CLEAR_AT_SYSTEM_CHANGED on class CL_DB2_FAILOVER_CONFIG has no parameter.
Method CLEAR_AT_SYSTEM_CHANGED on class CL_DB2_FAILOVER_CONFIG has no exception.

Method CONVERT_TAB_DB2CONINI_TO_STR_T Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONINI_TAB Call by reference Type reference (TYPE) STANDARD TABLE 20120124
2 Returning STRING_TAB Value transfer Type reference (TYPE) DBA_STRING_TAB DBA Cockpit: Table of DBA_STRING_STRUC 20120124

Method CONVERT_TAB_DB2CONINI_TO_STR_T on class CL_DB2_FAILOVER_CONFIG has no exception.

Method GET_DB2_DS_DETAILS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting LOCATION Call by reference Type reference (TYPE) STRING DDFLocation of connection String to DB 20130905
2 Exporting SYSTEM_NAME Call by reference Type reference (TYPE) STRING Name of this SAP System 20130905
# Exception Resumable Description Created on
1 CX_DB2_ROOT DB2: root class regarding exceptions 20130905

Method GET_DB_OF_DSN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting DATABASE Value transfer Type reference (TYPE) DB2_FAILOVER_DB Database of given dsn_alias 20121025
2 Importing DSN_ALIAS Call by reference Type reference (TYPE) STRING Selected DSN in Frontend 20111129
3 Changing OLD_DB_REF Call by reference Type reference (TYPE) DB2_FAILOVER_DB DB2: Failover Configuration: Structure for different DBs 20121102
# Exception Resumable Description Created on
1 CX_DB2_ROOT DB2: root class regarding exceptions 20121218

Method GET_FAILOVER_MECHANISM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning FAILOVER_CONFIG_FORMAT Value transfer Type reference (TYPE) I Contains either format_abap_xml or format_abap_ini 20120314

Method GET_FAILOVER_MECHANISM on class CL_DB2_FAILOVER_CONFIG has no exception.

Method GET_TREE_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning FORMATTED_TREE_DATA Value transfer Type reference (TYPE) DB2_FAILOVER_T_TRANSFER Table for transfering tree data 20111111

Method GET_TREE_DATA on class CL_DB2_FAILOVER_CONFIG has no exception.

Method GIVE_CHANGED_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DATABASE Call by reference Type reference (TYPE) DB2_FAILOVER_DB DB2: Failover Configuration: Structure for different DBs 20121025
2 Importing DSN_ELEMENT Call by reference Type reference (TYPE) STRING 20111130
3 Returning SUCCESSFULL Value transfer Type reference (TYPE) ABAP_BOOL save successfull 20120323

Method GIVE_CHANGED_DATA on class CL_DB2_FAILOVER_CONFIG has no exception.

Method PARSE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PARSE_FORMAT Call by reference Type reference (TYPE) INT4 -1 triggers parsing of specified format from disk 20121206
2 Importing RAW_DATA Call by reference Type reference (TYPE) DB2_FAILOVER_UNPARSED_DATA DB2: Failover Configuration: Imported, unparsed config file 20120823
# Exception Resumable Description Created on
1 CX_DB2_ROOT DB2: root class regarding exceptions 20120214

Method PREPARE_XML_FOR_WRITE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTENT Call by reference Type reference (TYPE) STRING 20120207
2 Returning DB2DSDRIVER_TAB Value transfer Type reference (TYPE) DB2_T_CHAR255 Table Type for CHAR255 20120207

Method PREPARE_XML_FOR_WRITE on class CL_DB2_FAILOVER_CONFIG has no exception.

Method READ_ABAP_XML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CONTENT Value transfer Type reference (TYPE) DBA_STRING_TAB DBA Cockpit: Table of DBA_STRING_STRUC 20120123
# Exception Resumable Description Created on
1 CX_DB2_ROOT DB2: root class regarding exceptions 20120124

Method READ_CONNECT_INI Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning CONTENT Value transfer Type reference (TYPE) DBA_STRING_TAB DBA Cockpit: Table of DBA_STRING_STRUC 20120105
# Exception Resumable Description Created on
1 CX_DB2_ROOT DB2: root class regarding exceptions 20120105

Method REGISTER_PARSER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FORMAT Call by reference Type reference (TYPE) I format to parse, rely on defined constants. 20120123

Method REGISTER_PARSER on class CL_DB2_FAILOVER_CONFIG has no exception.

Method RENDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RENDERED_DATA Value transfer Type reference (TYPE) STRING DBA Cockpit: Simple String Structure 20111124
# Exception Resumable Description Created on
1 CX_DB2_ROOT DB2: root class regarding exceptions 20130905

Method WRITE_ABAP_XML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTENT Call by reference Type reference (TYPE) STRING 20120123
# Exception Resumable Description Created on
1 CX_DB2_ROOT DB2: root class regarding exceptions 20120131

Method WRITE_CONNECT_INI Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTENT Call by reference Type reference (TYPE) STRING 20120123
# Exception Resumable Description Created on
1 CX_DB2_ROOT DB2: root class regarding exceptions 20120131

Method WRITE_TO_DISK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FORMAT Call by reference Type reference (TYPE) I 20120123
# Exception Resumable Description Created on
1 CX_DB2_ROOT DBA Cockpit: Root exception class 20120330
History
Last changed by/on SAP  20140121 
SAP Release Created in 740