SAP ABAP Class CL_TREX_USER_MANAGER (User management for TREX BasisClient.)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-TRX-API (Application Component) TREX ABAP + JAVA API
⤷
STREX (Package) TREX ABAP client
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-TRX-API (Application Component) TREX ABAP + JAVA API⤷
STREX (Package) TREX ABAP clientProperties
| Class | CL_TREX_USER_MANAGER | |
| Short Description | User management for TREX BasisClient. | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | STREX | TREX ABAP client |
| Created | 20050808 | 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_TREX_USER_MANAGER |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_TREX_USER_MANAGER has no interface implemented.
Friends
Class CL_TREX_USER_MANAGER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ABAP_PYTHON |
Static Attribute | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | HDB: X: write Python trace only for ABAP statements | 20111014 | |
| 2 | COMM_METHOD_FOR_AGGR |
Static Attribute | Public | Type reference (TYPE) | NUM1 | 0 | 1: ICM, 2: DBSL, 3: RFC-Bxml, 4: RFC | 20080418 | |
| 3 | C_ABAP_PYTHON |
Constant | Public | Type reference (TYPE) | CHAR20 | 'HDB_ABAP_PYTHON' | User parameter id for writing Pythontrace | 20111014 | |
| 4 | C_AGGR_DBSL |
Constant | Public | Type reference (TYPE) | NUM1 | 2 | Communication method DBSL for aggregation | 20080418 | |
| 5 | C_AGGR_ICM |
Constant | Public | Type reference (TYPE) | NUM1 | 1 | Communication method ICM for aggregation | 20080418 | |
| 6 | C_AGGR_RFC_BXML |
Constant | Public | Type reference (TYPE) | NUM1 | 3 | Communication method RFC with Bxml format for aggregation | 20080418 | |
| 7 | C_ALL_USERS |
Constant | Public | Type reference (TYPE) | SYUNAME | '(^O^)<(_ _)>' | User Names | 20050808 | |
| 8 | C_DBSL |
Constant | Public | Type reference (TYPE) | CHAR20 | 'TREX_DBSL' | User parameter id for DBSL communication. | 20061213 | |
| 9 | C_DB_CACHE |
Constant | Public | Type reference (TYPE) | NUM1 | 0 | Database cache. | 20070622 | |
| 10 | C_DEFAULT_DBSL |
Constant | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Default communication method | 20090731 | |
| 11 | C_DEFAULT_HTTP_TIME_OUT |
Constant | Public | Type reference (TYPE) | I | 1800 | Default http time out (seconds) | 20050825 | |
| 12 | C_DEFAULT_IDX_SERVER_CACHE |
Constant | Public | Type reference (TYPE) | NUM1 | 0 | Default index server cache | 20070409 | |
| 13 | C_DEFAULT_IGNORE_CP_CONV_ERR |
Constant | Public | Type reference (TYPE) | NUM1 | 0 | Default value for user parameter C_IGNORE_CP_CONV_ERR | 20090107 | |
| 14 | C_DEFAULT_LAST_USER |
Constant | Public | Type reference (TYPE) | SYUNAME | 'TREX' | User Name | 20080502 | |
| 15 | C_DEFAULT_RETRY_COUNT |
Constant | Public | Type reference (TYPE) | I | 2 | Default retry count | 20060725 | |
| 16 | C_DEFAULT_SHM_CACHE |
Constant | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Default value for shared memory switch | 20101209 | |
| 17 | C_DEFAULT_WAIT_TIME |
Constant | Public | Type reference (TYPE) | I | 10 | Default waiting time (seconds) | 20060725 | |
| 18 | C_HDB_BULKINSERT_ADBC |
Constant | Public | Type reference (TYPE) | CHAR20 | 'HDB_BULKINSERT_ADBC' | User parameter id for indexcelltable via SQL | 20130606 | |
| 19 | C_HDB_DBSL_CON |
Constant | Public | Type reference (TYPE) | CHAR20 | 'HDB_DBSL_CON' | User parameter id for HDB DBSL connection | 20100111 | |
| 20 | C_HDB_SCHEMA_NAME |
Constant | Public | Type reference (TYPE) | CHAR20 | 'HDB_SCHEMA_NAME' | User parameter id for schema name | 20110919 | |
| 21 | C_HDB_TREXVIADBSLPARAM |
Constant | Public | Type reference (TYPE) | CHAR20 | 'HDB_TREXVIADBSLPARAM' | User parameter id for using TrexViaDbslParameter always | 20121011 | |
| 22 | C_HOST_NAME |
Constant | Public | Type reference (TYPE) | TREX_RFC-BOOLEAN | 0 | Handle index server location as host name. | 20070718 | |
| 23 | C_IGNORE_CP_CONV_ERR |
Constant | Public | Type reference (TYPE) | CHAR20 | 'TREX_CP_CONV_ERR' | User parameter id for ignoring codepage conversion errors | 20090107 | |
| 24 | C_IGNORE_CP_CONV_ERR_ACTIVE |
Constant | Public | Type reference (TYPE) | NUM1 | 1 | IGNORE_CP_CONV_ERR activated by user | 20090107 | |
| 25 | C_IGNORE_CP_CONV_ERR_INACTIVE |
Constant | Public | Type reference (TYPE) | NUM1 | 2 | IGNORE_CP_CONV_ERR deactivated by user | 20090107 | |
| 26 | C_IGNORE_CP_CONV_ERR_NOT_SET |
Constant | Public | Type reference (TYPE) | NUM1 | 0 | IGNORE_CP_CONV_ERR not set by user | 20090107 | |
| 27 | C_IP_ADDRESS |
Constant | Public | Type reference (TYPE) | TREX_RFC-BOOLEAN | 1 | Handle index server location as ip address. | 20070718 | |
| 28 | C_KERNEL_TIME_IN_US |
Constant | Public | Type reference (TYPE) | CHAR20 | 'TREX_KRN_TIME_IN_US' | User parameter id for TREX kernel time in microsecond. | 20071119 | |
| 29 | C_NO_CACHE |
Constant | Public | Type reference (TYPE) | NUM1 | 1 | No cache. | 20070622 | |
| 30 | C_NO_COMPRESS |
Constant | Public | Type reference (TYPE) | CHAR20 | 'TREX_NO_COMPRESS' | User parameter id for disabling data compression. | 20061214 | |
| 31 | C_SHM_CACHE |
Constant | Public | Type reference (TYPE) | NUM1 | 2 | Shared memory cache. | 20070622 | |
| 32 | C_TEST_RFCDEST |
Constant | Public | Type reference (TYPE) | MEMORYID | 'TREX_TEST_RFCDEST' | User parameter id for RFC destination | 20071120 | |
| 33 | C_TRACE |
Constant | Public | Type reference (TYPE) | CHAR20 | 'TREX_TRACE' | User parameter id for tracing ABAP programs. | 20051118 | |
| 34 | C_TREXVIADBSL |
Constant | Public | Type reference (TYPE) | NUM1 | 1 | Numeric 1-character | 20121011 | |
| 35 | C_TREXVIADBSLPARAMETER |
Constant | Public | Type reference (TYPE) | NUM1 | 2 | Numeric 1-character | 20121011 | |
| 36 | DBSL |
Static Attribute | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | X: DBSL communication active. | 20061213 | |
| 37 | DBSL_USER |
Static Attribute | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | (Internal use) X: DBSL is always used. | 20071004 | |
| 38 | DBSL_USER_PARAM_EXIST |
Static Attribute | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | (Internal use) X: Comm. method can be changed by user. | 20071004 | |
| 39 | HDB_BULKINSERT_ADBC |
Static Attribute | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | HDB: X: indexCellTable via ADBC | 20130606 | |
| 40 | HDB_CON_USER_PARAM_EXIST |
Static Attribute | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | HDB: User parameter for DB connection exists. | 20110630 | |
| 41 | HDB_DBSL_CON |
Static Attribute | Public | Type reference (TYPE) | DBCON_NAME | '' | Logical name for a database connection | 20100111 | |
| 42 | HDB_SCHEMA_NAME |
Static Attribute | Public | Type reference (TYPE) | CHAR20 | '' | HDB: (internal use) take the schema name, if being set. | 20110919 | |
| 43 | HDB_TRACE_GLOBAL |
Static Attribute | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | HDB: global trace flag | 20121220 | |
| 44 | HDB_TREXVIADBSLPARAM |
Static Attribute | Public | Type reference (TYPE) | NUM1 | 0 | HDB: (internal use) 1: TrexViaDbsl, 2: TrexViaDbslParameter | 20121011 | |
| 45 | HTTP_TIME_OUT |
Static Attribute | Public | Type reference (TYPE) | I | 1800 | Http time out (second) | 20050825 | |
| 46 | IDX_SERVER_CACHE |
Static Attribute | Public | Type reference (TYPE) | NUM1 | 0 | 0: DB cache, 1: No cache | 20070409 | |
| 47 | IGNORE_CP_CONV_ERR_USER |
Static Attribute | Public | Type reference (TYPE) | NUM1 | 0 | 0: User parameter not set, 1: activate, 2: inactive | 20090107 | |
| 48 | KERNEL_TIME_IN_US |
Static Attribute | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | X: Return TREX kernel time in microsecond | 20071119 | |
| 49 | LAST_DATE |
Static Attribute | Public | Type reference (TYPE) | SYDATUM | Last date when global flags were changed. | 20080502 | ||
| 50 | LAST_DATE_HDB |
Static Attribute | Public | Type reference (TYPE) | SYDATUM | HANA: Last date when global flags were changed. | 20121218 | ||
| 51 | LAST_USER |
Static Attribute | Public | Type reference (TYPE) | SYUNAME | Last user name who changed global flags. | 20080502 | ||
| 52 | LAST_USER_HDB |
Static Attribute | Public | Type reference (TYPE) | SYUNAME | HANA: Last user name who changed global flags. | 20121218 | ||
| 53 | NO_COMPRESS |
Static Attribute | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | (Internal use) X: Force to disable data compression. | 20061214 | |
| 54 | RETRY_COUNT |
Static Attribute | Public | Type reference (TYPE) | I | 2 | Retry times for the same request | 20060718 | |
| 55 | SERVER_LOC_AS |
Static Attribute | Public | Type reference (TYPE) | TREX_RFC-BOOLEAN | 0 | 1: IP address will be returned. | 20070323 | |
| 56 | TRACE |
Static Attribute | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Trace flag | 20050808 | |
| 57 | TREX_ON_HDB |
Static Attribute | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | HDB: X: TREX on HANA | 20120806 | |
| 58 | WAIT_TIME |
Static Attribute | Public | Type reference (TYPE) | I | 10 | Waiting time for the next (same) request | 20060718 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CLASS_CONSTRUCTOR |
Static method | Public | Constructor | 20050808 | |
| 2 | DELETE_USER_SETTING_DB |
Static method | Public | Method | TREX: delete and persist user dependent parameter. | 20100706 |
| 3 | GET_CORRECT_HTTP_TIME_OUT |
Static method | Private | Method | TREX: logical check of http timeout values | 20060725 |
| 4 | INITIALIZE |
Static method | Public | Method | For testing, same as in class_constructor. | 20100706 |
| 5 | RESET_GLOBAL_PARAMETERS |
Static method | Public | Method | HANA: reset global parameters | 20121217 |
| 6 | RESET_GLOBAL_SETTING |
Static method | Public | Method | TREX: reset global parameters. | 20050913 |
| 7 | RESET_USER_PARAMETERS |
Static method | Public | Method | HANA: reset user dependent parameters. | 20130131 |
| 8 | RESET_USER_SETTING |
Static method | Public | Method | TREX: reset user dependent parameters. | 20050913 |
| 9 | SET_GLOBAL_PARAMETERS |
Static method | Public | Method | HANA: set global parameters | 20121217 |
| 10 | SET_GLOBAL_SETTING |
Static method | Public | Method | TREX: set global parameters. | 20050913 |
| 11 | SET_NEWDB_CONNECTION |
Static method | Public | Method | HANA: set a HANA connection | 20100715 |
| 12 | SET_TREX_ON_HDB |
Static method | Public | Method | TREX/HANA: activate TREX_ON_HANA parameter | 20120806 |
| 13 | SET_USER_PARAMETERS |
Static method | Public | Method | HANA: set user dependent parameters. | 20130131 |
| 14 | SET_USER_SETTING |
Static method | Public | Method | TREX: set user dependent parameters. | 20050913 |
| 15 | SET_USER_SETTING_DB |
Static method | Public | Method | TREX: set and persist user dependent parameter. | 20071120 |
| 16 | SWITCH_OFF_NO_COMPRESS_FLAG |
Static method | Private | Method | TREX: (Internal use) swtich off NO_COMPRESS flag. | 20061214 |
| 17 | SWITCH_ON_NO_COMPRESS_FLAG |
Static method | Private | Method | TREX: (Internal use) switch on NO_COMPRESS flag. | 20061214 |
| 18 | UNSET_TREX_ON_HDB |
Static method | Public | Method | TREX/HANA: reset TREX_ON_HANA parameter | 20120806 |
| 19 | UPDATE_FLAG_STATUS |
Static method | Private | Method | TREX/HANA: update the current status. | 20051118 |
Events
Class CL_TREX_USER_MANAGER has no event.
Types
Class CL_TREX_USER_MANAGER has no local type.
Method Signatures
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_TREX_USER_MANAGER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_TREX_USER_MANAGER has no exception.
Method DELETE_USER_SETTING_DB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
ID | Call by reference | Type reference (TYPE) | MEMORYID | Set/Get parameter ID | 20100706 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_TREX_DATABASE_TABLE |
Database table handle (insert/update) failure. | 20100706 |
Method GET_CORRECT_HTTP_TIME_OUT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
CORRECTED_VALUE | Value transfer | Type reference (TYPE) | I | 20060725 | |||
| 2 | Importing |
VALUE | Call by reference | Type reference (TYPE) | I | 20060725 |
Method GET_CORRECT_HTTP_TIME_OUT on class CL_TREX_USER_MANAGER has no exception.
Method INITIALIZE Signature
Method INITIALIZE on class CL_TREX_USER_MANAGER has no parameter.
Method INITIALIZE on class CL_TREX_USER_MANAGER has no exception.
Method RESET_GLOBAL_PARAMETERS Signature
Method RESET_GLOBAL_PARAMETERS on class CL_TREX_USER_MANAGER has no parameter.
Method RESET_GLOBAL_PARAMETERS on class CL_TREX_USER_MANAGER has no exception.
Method RESET_GLOBAL_SETTING Signature
Method RESET_GLOBAL_SETTING on class CL_TREX_USER_MANAGER has no parameter.
Method RESET_GLOBAL_SETTING on class CL_TREX_USER_MANAGER has no exception.
Method RESET_USER_PARAMETERS Signature
Method RESET_USER_PARAMETERS on class CL_TREX_USER_MANAGER has no parameter.
Method RESET_USER_PARAMETERS on class CL_TREX_USER_MANAGER has no exception.
Method RESET_USER_SETTING Signature
Method RESET_USER_SETTING on class CL_TREX_USER_MANAGER has no parameter.
Method RESET_USER_SETTING on class CL_TREX_USER_MANAGER has no exception.
Method SET_GLOBAL_PARAMETERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
TRACE | Call by reference | Type reference (TYPE) | FLAG | General Flag | 20121217 |
Method SET_GLOBAL_PARAMETERS on class CL_TREX_USER_MANAGER has no exception.
Method SET_GLOBAL_SETTING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
AGGR_COMM_METHOD | Call by reference | Type reference (TYPE) | NUM1 | 0 | 1: ICM, 2: DBSL, 3: RFC-Bxml | 20080421 | |
| 2 | Importing |
AGGR_VIA_RFC | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | X: Use RFC for aggregation call. | 20060718 | |
| 3 | Importing |
COMPRESS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | X: Set compress flag on globally. | 20060718 | |
| 4 | Importing |
DBSL | Call by reference | Type reference (TYPE) | ABAP_BOOL | C_DEFAULT_DBSL | X: Use DBSL communication method instead of ICM. | 20061225 | |
| 5 | Importing |
HTTP_TIME_OUT | Call by reference | Type reference (TYPE) | I | C_DEFAULT_HTTP_TIME_OUT | Http time out | 20060718 | |
| 6 | Importing |
IDX_SERVER_CACHE | Call by reference | Type reference (TYPE) | NUM1 | C_DEFAULT_IDX_SERVER_CACHE | See the attribute IDX_SERVER_CACHE. | 20070409 | |
| 7 | Importing |
IP_ADDRESS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | X: IP address is taken for Index Server. | 20070323 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_TREX_DATABASE_TABLE |
Database table handle (insert/update) failure. | 20070531 |
Method SET_NEWDB_CONNECTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CON_NAME | Call by reference | Type reference (TYPE) | CLIKE | 20100715 |
Method SET_NEWDB_CONNECTION on class CL_TREX_USER_MANAGER has no exception.
Method SET_TREX_ON_HDB Signature
Method SET_TREX_ON_HDB on class CL_TREX_USER_MANAGER has no parameter.
Method SET_TREX_ON_HDB on class CL_TREX_USER_MANAGER has no exception.
Method SET_USER_PARAMETERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ABAP_PYTHON | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | X: Write Python trace for ABAP statements | 20130131 | |
| 2 | Importing |
BULKINSERT_SQL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | X: Bulkinsert via SQL (ADBC) | 20130610 | |
| 3 | Importing |
TRACE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | X: Write log. | 20130131 |
Method SET_USER_PARAMETERS on class CL_TREX_USER_MANAGER has no exception.
Method SET_USER_SETTING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_COMMIT_WORK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | X: Commit work is allowed in TREX function modules. | 20050922 | |
| 2 | Importing |
IM_KERNEL_TIME_IN_US | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | X: Return TREX kernel time in microsecond. | 20071119 | |
| 3 | Importing |
IM_TRACE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | X: Trace-Kennzeichen setzen | 20050913 |
Method SET_USER_SETTING on class CL_TREX_USER_MANAGER has no exception.
Method SET_USER_SETTING_DB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ID | Call by reference | Type reference (TYPE) | MEMORYID | Set/Get parameter ID | 20071120 | ||
| 2 | Importing |
VALUE | Call by reference | Type reference (TYPE) | CLIKE | Parameter value | 20071120 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_TREX_DATABASE_TABLE |
Database table handle (insert/update) failure. | 20080131 |
Method SWITCH_OFF_NO_COMPRESS_FLAG Signature
Method SWITCH_OFF_NO_COMPRESS_FLAG on class CL_TREX_USER_MANAGER has no parameter.
Method SWITCH_OFF_NO_COMPRESS_FLAG on class CL_TREX_USER_MANAGER has no exception.
Method SWITCH_ON_NO_COMPRESS_FLAG Signature
Method SWITCH_ON_NO_COMPRESS_FLAG on class CL_TREX_USER_MANAGER has no parameter.
Method SWITCH_ON_NO_COMPRESS_FLAG on class CL_TREX_USER_MANAGER has no exception.
Method UNSET_TREX_ON_HDB Signature
Method UNSET_TREX_ON_HDB on class CL_TREX_USER_MANAGER has no parameter.
Method UNSET_TREX_ON_HDB on class CL_TREX_USER_MANAGER has no exception.
Method UPDATE_FLAG_STATUS Signature
Method UPDATE_FLAG_STATUS on class CL_TREX_USER_MANAGER has no parameter.
Method UPDATE_FLAG_STATUS on class CL_TREX_USER_MANAGER has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 710 |
