SAP ABAP Class CL_DB2_SYSLOG (Backend Class for parsing and retrieving z/OS syslog)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-DB-DB2 (Application Component) DB2 for z/OS
⤷
STU3 (Package) Development Class for Database Monitor
⤷
⤷
Properties
| Class | CL_DB2_SYSLOG | |
| Short Description | Backend Class for parsing and retrieving z/OS syslog | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | STU3 | Development Class for Database Monitor |
| Created | 20120713 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_DB2_SYSLOG has no interface implemented.
Friends
Class CL_DB2_SYSLOG has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Private | Type reference (TYPE) | DB2_SYSLOG_MULTILINE_MSG_T | temporary storage for multiline msgs not finished | 20120713 | |||
| 2 | Static Attribute | Private | Type reference (TYPE) | DB2_SYSLOG_T_ENTRIES | contains the syslog getting parsed cleared by get_syslog | 20120713 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Private | Method | convert db2date to iso_date for stored procedure | 20120713 | |
| 2 | Static method | Public | Method | get sylog | 20120713 | |
| 3 | Static method | Private | Method | this method is called for every syslog line to parse it | 20120723 | |
| 4 | Static method | Private | Method | splits a retrieved syslog line (line parser) | 20120713 | |
| 5 | Static method | Private | Method | this method splits a Multiline Message | 20120719 | |
| 6 | Static method | Private | Method | treats a complete read line | 20120809 |
Events
Class CL_DB2_SYSLOG has no event.
Types
Class CL_DB2_SYSLOG has no local type.
Method Signatures
Method DATE_TO_ISO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ISO_DATE | Value transfer | Type reference (TYPE) | DB2CCHAR12 | formated date yyyy-mm-dd | 20120713 | |||
| 2 | NOT_ISO_DATE | Call by reference | Type reference (TYPE) | DB2DATE | input db2date not in abap format | 20120713 |
Method DATE_TO_ISO on class CL_DB2_SYSLOG has no exception.
Method GET_SYSLOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | FILTER_STRING | Call by reference | Type reference (TYPE) | DB2CCMTXT | filter value from frontend | 20120713 | |||
| 2 | FORMATTED_SYSLOG | Call by reference | Type reference (TYPE) | DB2_SYSLOG_T_ENTRIES | DB2:CCMS: Z/OS Syslog entry table | 20120713 | |||
| 3 | FROM_DATE | Call by reference | Type reference (TYPE) | DB2DATE | Field type date, YYYYMMDD | 20120713 | |||
| 4 | FROM_TIME | Call by reference | Type reference (TYPE) | DB2TIME | Field type time, HHMMSS | 20120713 | |||
| 5 | MAX_ENTRIES | Call by reference | Type reference (TYPE) | INT4 | Natural number | 20120713 | |||
| 6 | MEMBER_NAME | Call by reference | Type reference (TYPE) | DB2_LPAR_NAME | DB2 member name in data sharing environment | 20120713 | |||
| 7 | RAW_SYSLOG | Call by reference | Type reference (TYPE) | DB2_T_RAW_SYSLOG | DB2:CCMS: Contains the raw Z/OS Syslog entries | 20120713 | |||
| 8 | RAW_VALUES_ONLY | Call by reference | Type reference (TYPE) | DB2BOOLEAN | ' ' | bool type | 20120817 | ||
| 9 | REMOTE_DBCON | Call by reference | Type reference (TYPE) | DBCON-CON_NAME | Logical name for a database connection | 20120713 | |||
| 10 | TO_DATE | Call by reference | Type reference (TYPE) | DB2DATE | Field type date, YYYYMMDD | 20120713 | |||
| 11 | TO_TIME | Call by reference | Type reference (TYPE) | DB2TIME | Field type time, HHMMSS | 20120713 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | DB2: root class regarding exceptions | 20120713 | ||
| 2 | Native SQL Error | 20120713 |
Method PARSE_SYSLOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RAW_SYSLOG | Call by reference | Type reference (TYPE) | DB2_T_RAW_SYSLOG | DB2:CCMS: Contains the raw Z/OS Syslog entries | 20120723 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | DB2: root class regarding exceptions | 20120723 |
Method SPLIT_LINE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | LAST_LINE | Call by reference | Type reference (TYPE) | DB2_SYSLOG_ENTRY | DB2:CCMS: Z/OS Syslog entry | 20120713 | |||
| 2 | RAW_LINE | Call by reference | Type reference (TYPE) | STRING | Z/OS syslog raw line | 20120713 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | DB2: root class regarding exceptions | 20120713 |
Method SPLIT_MULTILINE_MSG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RAW_LINE | Call by reference | Type reference (TYPE) | STRING | Z/OS syslog raw line | 20120719 | |||
| 2 | WA_MULTI_LINE_ENTRY | Value transfer | Type reference (TYPE) | DB2_SYSLOG_MULTILINE_MSG | DB2: CCMS: Contains a parsed Multiline Message | 20120719 |
Method SPLIT_MULTILINE_MSG on class CL_DB2_SYSLOG has no exception.
Method TREAT_LINE_BUFFER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | LINE_BUFFER | Call by reference | Type reference (TYPE) | STRING | the line to parse | 20120809 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | DB2: root class regarding exceptions | 20120809 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 740 |