SAP ABAP Class CL_SYSLOG_PARAMETER_HANDLER (Replace parameters with values in syslog message texts)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CCM-MON-SLG (Application Component) SAP System Log
     ⤷ SYSLOG (Package) System log

Properties

Class	CL_SYSLOG_PARAMETER_HANDLER
Short Description	Replace parameters with values in syslog message texts
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SYSLOG	System log
Created	20120504	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_SYSLOG_PARAMETER_HANDLER has no interface implemented.

Friends

Class CL_SYSLOG_PARAMETER_HANDLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_ERRNO_FLAG	Constant	Private	☐	Type reference (TYPE)	I	-1		20120605
2	C_REGEX_TYPE_CAP_LETTER	Constant	Private	☐	Type reference (TYPE)	STRING	'&[A-P]'		20120504
3	C_REGEX_TYPE_DOLLAR_SIGN	Constant	Private	☐	Type reference (TYPE)	STRING	'[$]+'		20120504
4	C_REGEX_TYPE_NUMBER	Constant	Private	☐	Type reference (TYPE)	STRING	'&[1-9]'		20120504
5	C_REGEX_TYPE_SMALL_LETTER	Constant	Private	☐	Type reference (TYPE)	STRING	'&[a-j]'		20120504
6	C_TYPE_CAP_LETTER	Constant	Private	☐	Type reference (TYPE)	I	1		20120504
7	C_TYPE_DOLLAR_SIGN	Constant	Private	☐	Type reference (TYPE)	I	8		20120504
8	C_TYPE_NUMBER	Constant	Private	☐	Type reference (TYPE)	I	4		20120504
9	C_TYPE_SMALL_LETTER	Constant	Private	☐	Type reference (TYPE)	I	2		20120504
10	C_TYPE_T100_MSG	Constant	Private	☐	Type reference (TYPE)	I	64		20120504
11	ERROR_NUMBER	Instance attribute	Private	☐	Type reference (TYPE)	SERRNO		Operating system or C library errno	20120508
12	MODE	Instance attribute	Private	☐	Type reference (TYPE)	RSLGS_			20120504
13	PARAMETER_MODE	Instance attribute	Private	☐	Type reference (TYPE)	SAPMODE			20120504
14	PARAMETER_STORE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SYSLOG_PARAMETER_STORE		Cache values for special syslog parameters	20120504
15	SUBST_TABLE	Instance attribute	Private	☐	Type reference (TYPE)	T_SUBSTITUTION_TABLE			20120504
16	TASK_NO	Instance attribute	Private	☐	Type reference (TYPE)	TEXT5			20120504
17	TERMINAL	Instance attribute	Private	☐	Type reference (TYPE)	RSLG_TERMINAL		Syslog terminal name	20120504
18	TEXT	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20120504
19	VALUES	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20120504

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_PARAMETERS	Instance method	Private	Method	Add parameters to the substitution table	20120504
2	ADD_VALUES	Instance method	Private	Method	Add values from the variable data string	20120504
3	CONSTRUCTOR	Instance method	Public	Constructor		20120504
4	DETERMINE_LENGTH	Instance method	Private	Method		20120504
5	DETERMINE_PARAMETER_POSITIONS	Instance method	Private	Method	Determine parameter position in the syslog text	20120504
6	GET_ERROR_NUMBER	Instance method	Public	Method	Return error number of current message text	20120508
7	GET_MESSAGE_TEXT	Instance method	Public	Method	Built and return the full message text	20120504
8	HANDLE_ERRNO	Instance method	Private	Method	Handle operating system error numbers	20120605

Events

Class CL_SYSLOG_PARAMETER_HANDLER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_PARAMETER_POSITION	Private	See coding			20120504	begin of s_parameter_position, ptype type i, position type match_result_tab, end of s_parameter_position
2	S_SUBSTITUTION_TABLE	Private	See coding			20120504	begin of s_substitution_table, parameter type string, value type string, offset type i, length type i, ptype type i, is_errno type abap_bool, end of s_substitution_table
3	T_PARAMETER_POSITION	Private	See coding			20120504	t_parameter_position type standard table of s_parameter_position with default key
4	T_SUBSTITUTION_TABLE	Private	See coding			20120504	t_substitution_table type standard table of s_substitution_table with default key

Method Signatures

Method ADD_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_STAB	Call by reference	☐	Type reference (TYPE)	T_SUBSTITUTION_TABLE			20120504
2	Importing	IM_PAR_POS	Call by reference	☐	Type reference (TYPE)	T_PARAMETER_POSITION			20120504
3	Importing	IM_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20120504

Method ADD_PARAMETERS on class CL_SYSLOG_PARAMETER_HANDLER has no exception.

Method ADD_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_STAB	Call by reference	☐	Type reference (TYPE)	T_SUBSTITUTION_TABLE			20120504
2	Importing	IM_PARAMETER_MODE	Call by reference	☐	Type reference (TYPE)	SAPMODE			20120504
3	Importing	IM_STORE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SYSLOG_PARAMETER_STORE		Cache values for special syslog parameters	20120504
4	Importing	IM_TASK_NO	Call by reference	☐	Type reference (TYPE)	TEXT5			20120504
5	Importing	IM_TERMINAL	Call by reference	☐	Type reference (TYPE)	RSLG_TERMINAL		Syslog terminal name	20120504
6	Importing	IM_VALUES	Call by reference	☐	Type reference (TYPE)	STRING			20120504

Method ADD_VALUES on class CL_SYSLOG_PARAMETER_HANDLER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MODE	Call by reference	☐	Type reference (TYPE)	RSLGS_			20120504
2	Importing	IM_PARAMETER_MODE	Call by reference	☐	Type reference (TYPE)	SAPMODE			20120504
3	Importing	IM_PARAMETER_STORE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SYSLOG_PARAMETER_STORE			20120504
4	Importing	IM_TASK_NO	Call by reference	☐	Type reference (TYPE)	TEXT5			20120504
5	Importing	IM_TERMINAL	Call by reference	☐	Type reference (TYPE)	RSLG_TERMINAL		Syslog terminal name	20120504
6	Importing	IM_TEXT	Call by reference	☐	Type reference (TYPE)	RSLGMSGTXT			20120504
7	Importing	IM_VALUES	Call by reference	☐	Type reference (TYPE)	RSLG_DATA			20120504

Method CONSTRUCTOR on class CL_SYSLOG_PARAMETER_HANDLER has no exception.

Method DETERMINE_LENGTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_WA	Call by reference	☐	Type reference (TYPE)	S_SUBSTITUTION_TABLE			20120504
2	Importing	IM_DIGIT	Call by reference	☐	Type reference (TYPE)	STRING			20120504
3	Importing	IM_OL_LEN	Call by reference	☐	Type reference (TYPE)	I			20120504

Method DETERMINE_LENGTH on class CL_SYSLOG_PARAMETER_HANDLER has no exception.

Method DETERMINE_PARAMETER_POSITIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20120601
2	Exporting	EX_PAR_POS	Call by reference	☐	Type reference (TYPE)	T_PARAMETER_POSITION			20120504
3	Importing	IM_MODE	Call by reference	☐	Type reference (TYPE)	RSLGS_			20120504

Method DETERMINE_PARAMETER_POSITIONS on class CL_SYSLOG_PARAMETER_HANDLER has no exception.

Method GET_ERROR_NUMBER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_ERRNO	Value transfer	☐	Type reference (TYPE)	SERRNO		Operating system or C library errno	20120508

Method GET_ERROR_NUMBER on class CL_SYSLOG_PARAMETER_HANDLER has no exception.

Method GET_MESSAGE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20120504

Method GET_MESSAGE_TEXT on class CL_SYSLOG_PARAMETER_HANDLER has no exception.

Method HANDLE_ERRNO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_OL_WA	Call by reference	☐	Type reference (TYPE)	MATCH_RESULT		Match with Regular Expression	20120605
2	Changing	CH_PAR_POS	Call by reference	☐	Type reference (TYPE)	T_PARAMETER_POSITION			20120605
3	Changing	CH_PP_WA	Call by reference	☐	Type reference (TYPE)	S_PARAMETER_POSITION			20120605
4	Changing	CH_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20120605

Method HANDLE_ERRNO on class CL_SYSLOG_PARAMETER_HANDLER has no exception.

History

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