SAP ABAP Class CL_SRAL_FRAME_CFG (RAL framework configuration)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SEC-RAL (Application Component) Read Access Logging
     ⤷ SREAD_ACCESS_LOG_CORE (Package) Read Access Logging: Core Framework

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRAL_ELOG	logging for RAL	20120516

Properties

Class	CL_SRAL_FRAME_CFG
Short Description	RAL framework configuration
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SREAD_ACCESS_LOG_CORE	Read Access Logging: Core Framework
Created	20120309	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)
2	CL_SRAL_FRAME_CFG	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_SRAL_ELOG	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SRAL_ELOG	☐	☐	logging for RAL	20120516

Friends

Class CL_SRAL_FRAME_CFG has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_ALL_APPL_SERVER	Constant	Public	☐	Type reference (TYPE)	MSNAME2	'*ALL*'	Application Server Name	20120309
2	CO_CONFIG_DBCON_NAME	Constant	Public	☐	Type reference (TYPE)	SRAL_FW_CFG_NAME	'RAL_DB_CON_NAME'	name of data base connection	20120516
3	CO_CONFIG_ELOG_RETENTION	Constant	Public	☐	Type reference (TYPE)	SRAL_FW_CFG_NAME	'RAL_ELOG_RETEN'	Number of days	20120817
4	CO_CONFIG_ELOG_RETENTION_STD	Constant	Public	☐	Type reference (TYPE)	SRAL_ELOG_RETENTION	10	Natural number	20120817
5	CO_CONFIG_LOG_LEVEL	Constant	Public	☐	Type reference (TYPE)	SRAL_FW_CFG_NAME	'RAL_LOG_LEVEL'	Log level for RAL logging	20120516
6	CO_CONFIG_PERFORMANCE_LEVEL	Constant	Public	☐	Type reference (TYPE)	SRAL_FW_CFG_NAME	'RAL_PERF_LEVEL'	Performance Level	20120401
7	CO_CONFIG_PERF_LEVEL_1	Constant	Public	☐	Type reference (TYPE)	INT4	1	Performance level for tracing	20120321

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	DELETE_CONFIG	Static method	Public	Method	Delete framework configuration	20120309
2	EXISTS_CONFIG	Static method	Public	Method	Check existence of configuration	20120309
3	GET_CONFIG	Static method	Public	Method	Get single configuration by name	20120309
4	GET_CONFIG_INT	Static method	Public	Method	Convinience: Get integer value	20120314
5	GET_CONFIG_STRING	Static method	Public	Method	Convinience: Get integer value	20120314
6	GET_DBCON	Static method	Public	Method		20120516
7	GET_ELOG_RETENTION_DAYS	Static method	Public	Method		20120817
8	GET_INST_NAME	Static method	Public	Method	Get own server instance ID	20120309
9	GET_LOG_LEVEL	Static method	Public	Method		20120516
10	GET_SERVER_LIST	Static method	Private	Method		20120321
11	GET_TYPE_OF_CONFIG	Static method	Public	Method	Get data type of configuration	20120314
12	LIST_CONFIG	Static method	Public	Method	List configurations	20120309
13	SET_CHANGE_INFO	Static method	Private	Method	Set change info	20120309
14	SET_CONFIG	Static method	Public	Method	Set single configuration by name	20120309
15	SET_CONFIG_INT	Static method	Public	Method	Convinience: Set integer value	20120314
16	SET_CONFIG_STRING	Static method	Public	Method	Convinience: Set integer value	20120314
17	SET_CREATE_INFO	Static method	Private	Method	Set create info	20120309
18	SET_DBCON	Static method	Public	Method	Set database connection name	20120516
19	SET_ELOG_RETENTION_DAYS	Static method	Public	Method		20120817
20	SET_LOG_LEVEL	Static method	Public	Method		20120516

Events

Class CL_SRAL_FRAME_CFG has no event.

Types

Class CL_SRAL_FRAME_CFG has no local type.

Method Signatures

Method DELETE_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_NOT_FOUND	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		X=no such config; space=otherwise	20120309
2	Importing	I_CONFIG_NAME	Call by reference	☐	Type reference (TYPE)	SRAL_FW_CFG_NAME		RAL: Framework configuration name	20120309
3	Importing	I_INST_NAME	Call by reference	☑	Type reference (TYPE)	MSNAME2		Application Server Name	20120309
4	Importing	I_SYS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_TRUE	Boolean Variable (X=True, -=False, Space=Unknown)	20120807

Method DELETE_CONFIG on class CL_SRAL_FRAME_CFG has no exception.

Method EXISTS_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CONFIG_NAME	Call by reference	☑	Type reference (TYPE)	SRAL_FW_CFG_NAME		RAL: Framework configuration name	20120309
2	Importing	I_INST_NAME	Call by reference	☐	Type reference (TYPE)	MSNAME2	CO_ALL_APPL_SERVER	Application Server Name	20120309
3	Importing	I_SYS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Boolean Variable (X=True, -=False, Space=Unknown)	20120807
4	Returning	R_EXISTS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		X=exists; space=does not exist	20120309

Method EXISTS_CONFIG on class CL_SRAL_FRAME_CFG has no exception.

Method GET_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_APPL_SERVER	Call by reference	☐	Type reference (TYPE)	MSNAME2		Application Server Name	20120309
2	Exporting	E_DECIMALS	Call by reference	☐	Type reference (TYPE)	SRAL_DATA_DECIMALS		Read Access Logging: Decimals	20120309
3	Exporting	E_LENGTH	Call by reference	☐	Type reference (TYPE)	SRAL_DATA_LENGTH		Read Access Logging: Data length	20120309
4	Exporting	E_NOT_FOUND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		X=no such config; space=otherwise	20120309
5	Exporting	E_VALUE	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Configuration value as data reference	20120309
6	Exporting	E_VALUE_RAW	Call by reference	☐	Type reference (TYPE)	SRAL_DATA_VALUE		Read Access Logging: Data Field Value	20120309
7	Exporting	E_VALUE_TYPE	Call by reference	☐	Type reference (TYPE)	SRAL_FIELD_DATA_TYPE		RAL: Field Data Type	20120309
8	Importing	I_CONFIG_NAME	Call by reference	☐	Type reference (TYPE)	SRAL_FW_CFG_NAME		RAL: Framework configuration name	20120309
9	Importing	I_INST_NAME	Call by reference	☐	Type reference (TYPE)	MSNAME2	CO_ALL_APPL_SERVER	Application Server Name	20120309
10	Importing	I_SYS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Boolean Variable (X=True, -=False, Space=Unknown)	20120807

#	Exception	Resumable	Description	Created on
1	CX_SRAL	☐	RAL: Exception	20120309

Method GET_CONFIG_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_APPL_SERVER	Call by reference	☐	Type reference (TYPE)	MSNAME2		Application Server Name	20120314
2	Exporting	E_NOT_FOUND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		X=no such config; space=otherwise	20120314
3	Exporting	E_VALUE	Call by reference	☐	Type reference (TYPE)	INT4		Configuration value as integer	20120314
4	Importing	I_CONFIG_NAME	Call by reference	☐	Type reference (TYPE)	SRAL_FW_CFG_NAME		RAL: Framework configuration name	20120314
5	Importing	I_INST_NAME	Call by reference	☐	Type reference (TYPE)	MSNAME2	CO_ALL_APPL_SERVER	Application Server Name	20120314
6	Importing	I_SYS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Boolean Variable (X=True, -=False, Space=Unknown)	20120807

#	Exception	Resumable	Description	Created on
1	CX_SRAL	☐	RAL: Exception	20120314

Method GET_CONFIG_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_APPL_SERVER	Call by reference	☐	Type reference (TYPE)	MSNAME2		Application Server Name	20120314
2	Exporting	E_NOT_FOUND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		X=no such config; space=otherwise	20120314
3	Exporting	E_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		Configuration value as string	20120314
4	Importing	I_CONFIG_NAME	Call by reference	☐	Type reference (TYPE)	SRAL_FW_CFG_NAME		RAL: Framework configuration name	20120314
5	Importing	I_INST_NAME	Call by reference	☐	Type reference (TYPE)	MSNAME2	CO_ALL_APPL_SERVER	Application Server Name	20120314
6	Importing	I_SYS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Boolean Variable (X=True, -=False, Space=Unknown)	20120807

#	Exception	Resumable	Description	Created on
1	CX_SRAL	☐	RAL: Exception	20120314

Method GET_DBCON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_DBCON	Value transfer	☐	Type reference (TYPE)	DBCON_NAME		Logical name for a database connection	20120516

#	Exception	Resumable	Description	Created on
1	CX_SRAL	☐	RAL: Exception	20120516

Method GET_ELOG_RETENTION_DAYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_DAYS	Value transfer	☐	Type reference (TYPE)	INT4		Natural number	20120817

Method GET_ELOG_RETENTION_DAYS on class CL_SRAL_FRAME_CFG has no exception.

Method GET_INST_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_APPL_SERVER	Value transfer	☐	Type reference (TYPE)	MSNAME2		Application Server Name	20120309

Method GET_INST_NAME on class CL_SRAL_FRAME_CFG has no exception.

Method GET_LOG_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_LOG_LEVEL	Value transfer	☐	Type reference (TYPE)	SRAL_LOG_LEVEL		Natural number	20120516

Method GET_LOG_LEVEL on class CL_SRAL_FRAME_CFG has no exception.

Method GET_SERVER_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_SERVER_LIST	Value transfer	☐	Type reference (TYPE)	SRAL_SERVER_LIST			20120321

Method GET_SERVER_LIST on class CL_SRAL_FRAME_CFG has no exception.

Method GET_TYPE_OF_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NOT_FOUND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		X=no such configuration; space=otherwise	20120314
2	Exporting	E_VALUE_TYPE	Call by reference	☐	Type reference (TYPE)	SRAL_FIELD_DATA_TYPE		RAL: Field Data Type	20120314
3	Importing	I_CONFIG_NAME	Call by reference	☐	Type reference (TYPE)	SRAL_FW_CFG_NAME		RAL: Framework configuration name	20120314
4	Importing	I_INST_NAME	Call by reference	☐	Type reference (TYPE)	MSNAME2	CO_ALL_APPL_SERVER	Application Server Name	20120314
5	Importing	I_SYS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Boolean Variable (X=True, -=False, Space=Unknown)	20120807

Method GET_TYPE_OF_CONFIG on class CL_SRAL_FRAME_CFG has no exception.

Method LIST_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_CONFIG_LIST	Value transfer	☐	Type reference (TYPE)	SRAL_FRAME_CFG_LIST		RAL: Framework Configuration	20120309
2	Importing	I_INST_NAME	Call by reference	☑	Type reference (TYPE)	MSNAME2		Application Server Name	20120309

Method LIST_CONFIG on class CL_SRAL_FRAME_CFG has no exception.

Method SET_CHANGE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_CHANGE_INFO	Call by reference	☐	Type reference (TYPE)	SRAL_FRAME_CFG		RAL: Framework configuration	20120309

Method SET_CHANGE_INFO on class CL_SRAL_FRAME_CFG has no exception.

Method SET_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CONFIG_NAME	Call by reference	☐	Type reference (TYPE)	SRAL_FW_CFG_NAME		RAL: Framework configuration name	20120309
2	Importing	I_INST_NAME	Call by reference	☐	Type reference (TYPE)	MSNAME2	CO_ALL_APPL_SERVER	Application server name; if not specified -> all server	20120309
3	Importing	I_SYS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Boolean Variable (X=True, -=False, Space=Unknown)	20120807
4	Importing	I_VALUE	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Framework data	20120309

#	Exception	Resumable	Description	Created on
1	CX_SRAL	☐	RAL: Exception	20120309

Method SET_CONFIG_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CONFIG_NAME	Call by reference	☐	Type reference (TYPE)	SRAL_FW_CFG_NAME		RAL: Framework configuration name	20120314
2	Importing	I_INST_NAME	Call by reference	☐	Type reference (TYPE)	MSNAME2	CO_ALL_APPL_SERVER	Application server name; if not specified -> all server	20120314
3	Importing	I_SYS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	system parameter	20120807
4	Importing	I_VALUE	Call by reference	☐	Type reference (TYPE)	INT4		Integer value	20120314

#	Exception	Resumable	Description	Created on
1	CX_SRAL	☐	RAL: Exception	20120314

Method SET_CONFIG_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CONFIG_NAME	Call by reference	☐	Type reference (TYPE)	SRAL_FW_CFG_NAME		RAL: Framework configuration name	20120314
2	Importing	I_INST_NAME	Call by reference	☐	Type reference (TYPE)	MSNAME2	CO_ALL_APPL_SERVER	Application server name; if not specified -> all server	20120314
3	Importing	I_SYS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Boolean Variable (X=True, -=False, Space=Unknown)	20120807
4	Importing	I_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		String value	20120314

#	Exception	Resumable	Description	Created on
1	CX_SRAL	☐	RAL: Exception	20120314

Method SET_CREATE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_CREATE_INFO	Call by reference	☐	Type reference (TYPE)	SRAL_FRAME_CFG		RAL: Framework configuration	20120309

Method SET_CREATE_INFO on class CL_SRAL_FRAME_CFG has no exception.

Method SET_DBCON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RETURN	Value transfer	☐	Type reference (TYPE)	INT4		Natural number	20120516
2	Importing	I_DBCON	Value transfer	☐	Type reference (TYPE)	DBCON_NAME	'r/3*ral'	Logical name for a database connection	20120516

Method SET_DBCON on class CL_SRAL_FRAME_CFG has no exception.

Method SET_ELOG_RETENTION_DAYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RETURN	Value transfer	☐	Type reference (TYPE)	INT4		Natural number	20120817
2	Importing	I_RET_DAYS	Call by reference	☐	Type reference (TYPE)	INT4	CL_SRAL_FRAME_CFG=>CO_CONFIG_ELOG_RETENTION_STD	Natural number	20120817

Method SET_ELOG_RETENTION_DAYS on class CL_SRAL_FRAME_CFG has no exception.

Method SET_LOG_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RETURN	Value transfer	☐	Type reference (TYPE)	INT4		Natural number	20120516
2	Importing	I_LOG_LEVEL	Call by reference	☐	Type reference (TYPE)	SRAL_LOG_LEVEL		Log level for RAL log	20120516

Method SET_LOG_LEVEL on class CL_SRAL_FRAME_CFG has no exception.

History

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