SAP ABAP Class CL_DB2_LOGGER (DB2 logging facility)
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
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-DB-DB2 (Application Component) DB2 for z/OS⤷
STU2 (Package) CCMS for DB2 for OS/390Properties
| Class | CL_DB2_LOGGER | |
| Short Description | DB2 logging facility | |
| 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 | 20060710 | SAP |
| Last change | 20090618 | 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_LOGGER has no interface implemented.
Friends
Class CL_DB2_LOGGER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DBA_NAVIGATOR |
Static Attribute | Private | Object reference (TYPE REF TO) | CL_DB6_TREE_NAVIGATOR | Reference to DBACockpit | 20070419 | ||
| 2 | ENABLED |
Instance attribute | Private | Type reference (TYPE) | I | 1 if logging is enabled, 0 otherwise | 20060710 | ||
| 3 | LOGFILE |
Instance attribute | Private | Type reference (TYPE) | STRING | NAME OF FILE MESSAGES ARE LOGGED INTO | 20060710 | ||
| 4 | MSG_TYPE_ERROR |
Constant | Public | Type reference (TYPE) | I | -1 | 20070419 | ||
| 5 | MSG_TYPE_SUCCESS |
Constant | Public | Type reference (TYPE) | I | 1 | 20070419 | ||
| 6 | MSG_TYPE_WARN |
Constant | Public | Type reference (TYPE) | I | 0 | 20070419 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CLEANUP |
Instance method | Public | Method | Class "destructor" | 20060710 |
| 2 | CLOSE_FILE |
Instance method | Private | Method | Close logfile | 20070314 |
| 3 | CONSTRUCTOR |
Instance method | Public | Constructor | Class constructor | 20060710 |
| 4 | DISABLE_FILE_LOGGING |
Instance method | Public | Method | Disable logging | 20060710 |
| 5 | ENABLE_FILE_LOGGING |
Instance method | Public | Method | Enable logging | 20060710 |
| 6 | HANDLE_SQL_EXCEPTION |
Instance method | Public | Method | 20060710 | |
| 7 | LOG_MSG |
Static method | Public | Method | Logs the message to different media | 20070614 |
| 8 | LOG_MSG_TO_FILE |
Instance method | Public | Method | Log a message to the logfile | 20060710 |
| 9 | OPEN_FILE |
Instance method | Private | Method | Open logfile | 20070314 |
Events
Class CL_DB2_LOGGER has no event.
Types
Class CL_DB2_LOGGER has no local type.
Method Signatures
Method CLEANUP Signature
Method CLEANUP on class CL_DB2_LOGGER has no parameter.
Method CLEANUP on class CL_DB2_LOGGER has no exception.
Method CLOSE_FILE Signature
Method CLOSE_FILE on class CL_DB2_LOGGER has no parameter.
Method CLOSE_FILE on class CL_DB2_LOGGER has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
INIT_ENABLED | Call by reference | Type reference (TYPE) | I | 0 | Start with logging enabled (1) or not (0) | 20060710 | |
| 2 | Importing |
INIT_LOGFILE | Call by reference | Type reference (TYPE) | STRING | '/tmp/db2_logfile' | Name of the file messages are logged into. | 20060710 |
Method CONSTRUCTOR on class CL_DB2_LOGGER has no exception.
Method DISABLE_FILE_LOGGING Signature
Method DISABLE_FILE_LOGGING on class CL_DB2_LOGGER has no parameter.
Method DISABLE_FILE_LOGGING on class CL_DB2_LOGGER has no exception.
Method ENABLE_FILE_LOGGING Signature
Method ENABLE_FILE_LOGGING on class CL_DB2_LOGGER has no parameter.
Method ENABLE_FILE_LOGGING on class CL_DB2_LOGGER has no exception.
Method HANDLE_SQL_EXCEPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
L_CON_REF | Call by reference | Object reference (TYPE REF TO) | CL_SQL_CONNECTION | Database Connection | 20060710 | ||
| 2 | Importing |
L_SQLERR_REF | Call by reference | Object reference (TYPE REF TO) | CX_SQL_EXCEPTION | Exception Class for SQL Error | 20060710 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  ADBC_SQL_ERROR |
20060710 |
Method LOG_MSG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
LONG_MESSAGE | Call by reference | Type reference (TYPE) | STRING | 20070614 | |||
| 2 | Importing |
MESSAGE | Call by reference | Type reference (TYPE) | STRING | 20070614 | |||
| 3 | Importing |
MSG_TYPE | Call by reference | Type reference (TYPE) | I | 20070614 | |||
| 4 | Importing |
SYSTEMLOG | Call by reference | Type reference (TYPE) | ABAP_BOOL | SPACE | 20081216 |
Method LOG_MSG on class CL_DB2_LOGGER has no exception.
Method LOG_MSG_TO_FILE Signature
Method LOG_MSG_TO_FILE on class CL_DB2_LOGGER has no exception.
Method OPEN_FILE Signature
Method OPEN_FILE on class CL_DB2_LOGGER has no parameter.
Method OPEN_FILE on class CL_DB2_LOGGER has no exception.
History
| Last changed by/on | SAP | 20090618 |
| SAP Release Created in | 710 |
