SAP ABAP Class CL_SKWF_CACHING (INTERNAL: Cache Layer Core Functions)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-KPR-DMF (Application Component) Document Management Framework
⤷
SKWF (Package) SAP Knowledge Warehouse Framework
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-SRV-KPR-DMF (Application Component) Document Management Framework⤷
SKWF (Package) SAP Knowledge Warehouse FrameworkMeta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_SKWF_CONTEXT_CACHE | INTERNAL: Context Cache | 20001017 |
| 2 | Inheritance (c INHERITING FROM c_ref) | CL_SKWF_FOLDER_CACHE | INTERNAL: Folder Cache | 20000927 |
| 3 | Inheritance (c INHERITING FROM c_ref) | CL_SKWF_PROPERTIES_CACHE | INTERNAL: Properties Cache | 20000720 |
Properties
| Class | CL_SKWF_CACHING | |
| Short Description | INTERNAL: Cache Layer Core Functions | |
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SKWF | SAP Knowledge Warehouse Framework |
| Created | 20000720 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  CL_SKWF_CONTEXT_CACHE |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 2 | CL_SKWF_FOLDER_CACHE |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 3 | CL_SKWF_PROPERTIES_CACHE |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_SKWF_CACHING has no interface implemented.
Friends
Class CL_SKWF_CACHING has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_CONTEXT_CACHE_ID |
Constant | Public | Type reference (TYPE) | SKWF_CHID | 'SKWFCC' | Context Cache ID | 20010110 | |
| 2 | C_FOLDER_CACHE_ID |
Constant | Public | Type reference (TYPE) | SKWF_CHID | 'SKWFFC' | Folder Cache ID | 20010110 | |
| 3 | C_PROPERTIES_CACHE_ID |
Constant | Public | Type reference (TYPE) | SKWF_CHID | 'SKWFPC' | Properties Cache ID | 20010110 | |
| 4 | G_CHANGED_FOLDERS |
Static Attribute | Private | Type reference (TYPE) | SKWF_IOS | Sleep Mode: Changed Directories | 20010227 | ||
| 5 | G_CHANGED_OBJECTS |
Static Attribute | Private | Type reference (TYPE) | SKWF_IOS | Sleep Mode: Changed Objects | 20010227 | ||
| 6 | G_DELETED_OBJECTS |
Static Attribute | Private | Type reference (TYPE) | SKWF_IOS | Sleep Mode: Changed Objects | 20010227 | ||
| 7 | G_SLEEP_LEVEL |
Static Attribute | Private | Type reference (TYPE) | I | Sleep Mode: Call Level | 20010227 | ||
| 8 | G_X_SLEEPING |
Static Attribute | Public | Type reference (TYPE) | XFELD | 'X': Cache in Sleep Mode | 20010227 | ||
| 9 | M_CACHE_ID |
Instance attribute | Protected | Type reference (TYPE) | SHBUFPREFIX | Cache Prefix | 20000720 | ||
| 10 | M_HIGH_WATER_MARK |
Instance attribute | Public | Type reference (TYPE) | I | 100000 | Cache Upper Limit | 20010110 | |
| 11 | M_LOGGING_LEVEL |
Instance attribute | Public | Type reference (TYPE) | SYMSGTY | 'E' | Log Level (S, I, W, E) | 20010112 | |
| 12 | M_LOGGING_USER |
Instance attribute | Public | Type reference (TYPE) | SYUNAME | ABAP System, User Logon Name | 20010112 | ||
| 13 | M_LOW_WATER_MARK |
Instance attribute | Public | Type reference (TYPE) | I | 75000 | Cache Lower Limit | 20010110 | |
| 14 | M_MINUTES_TO_HALF_ACCESS_COUNT |
Instance attribute | Public | Type reference (TYPE) | I | 360 | Minutes to Half Access Counter | 20010110 | |
| 15 | M_SYNC_LATENCY |
Instance attribute | Public | Type reference (TYPE) | I | 10 | Update Latency (Seconds) | 20001013 | |
| 16 | M_X_CACHING |
Instance attribute | Public | Type reference (TYPE) | XFELD | ' ' | Cache Switch ('X': on, ' ' off) | 20000926 | |
| 17 | M_X_LOGGING |
Instance attribute | Public | Type reference (TYPE) | XFELD | 'X' | 'X': Logging Switched On | 20010111 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | FLUSH_CACHES |
Static method | Public | Method | Synchronize Internally Buffered Data with DB | 20001020 |
| 2 | GET_CACHE_SINGLETON |
Static method | Private | Method | Get Cache Singleton for ID | 20010110 |
| 3 | GET_PARAMETERS |
Static method | Public | Method | Get Cache Parameters | 20010110 |
| 4 | INVALIDATE_CACHE |
Static method | Public | Method | Invalidate Cache on All Application Servers | 20000720 |
| 5 | INVALIDATE_CACHE_INST |
Instance method | Protected | Method | Invalidate Cache (Instance Function) | 20000720 |
| 6 | LOCK_CACHE |
Instance method | Protected | Method | Exclusively Lock Cache | 20001013 |
| 7 | LOG_MESSAGE |
Instance method | Protected | Method | Write an Application Log Entry | 20010111 |
| 8 | REGISTER_CACHE |
Static method | Protected | Method | Initialize and Register Cache | 20000721 |
| 9 | SET_PARAMETERS |
Static method | Public | Method | Set Cache Parameters | 20010111 |
| 10 | SET_SLEEPMODE |
Static method | Public | Method | Switch Cache Sleep Mode On/Off | 20010227 |
| 11 | SYNC_CACHE |
Instance method | Protected | Method | Synchronize Transient with Persistent Cache | 20001013 |
| 12 | TIMESTAMP_CALC |
Static method | Protected | Method | Change Time Stamp | 20000725 |
| 13 | UNLOCK_CACHE |
Instance method | Protected | Method | Cancel Cache Lock | 20001013 |
Events
Class CL_SKWF_CACHING has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | ADMIN_DATA_T | Protected | See coding | Administrative Data | 20001029 | |
|
| 2 | SHBUFAREA | Protected | Type reference (TYPE) | SKWF_CHSEG | Buffer Sign (Area) | 20001011 | |
| 3 | SHBUFKEY | Protected | Type reference (TYPE) | CHAR22 | Buffer Sign (Prefix + Area) | 20000720 | |
| 4 | SHBUFPREFIX | Protected | Type reference (TYPE) | SKWF_CHID | Buffer Sign (Prefix) | 20001011 | |
Method Signatures
Method FLUSH_CACHES Signature
Method FLUSH_CACHES on class CL_SKWF_CACHING has no parameter.
Method FLUSH_CACHES on class CL_SKWF_CACHING has no exception.
Method GET_CACHE_SINGLETON Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
P_CACHE | Value transfer | Object reference (TYPE REF TO) | CL_SKWF_CACHING | Cache Singleton | 20010110 | ||
| 2 |  Importing |
P_CACHE_ID | Call by reference | Type reference (TYPE) | SKWF_CHID | Cache-ID | 20010110 |
Method GET_CACHE_SINGLETON on class CL_SKWF_CACHING has no exception.
Method GET_PARAMETERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
P_CACHE_ID | Call by reference | Type reference (TYPE) | SKWF_CHID | Cache-ID | 20010110 | ||
| 2 |  Exporting |
P_CACHE_PARAMETER | Call by reference | Type reference (TYPE) | SKWF_CHPAR | Cache-Parameter | 20010110 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  BAD_CACHE_ID |
Ungültige Cache Kennung | 20010110 |
Method INVALIDATE_CACHE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
P_CHANGED_FOLDERS | Call by reference | Type reference (TYPE) | SKWF_IOS | Verzeichnisse mit verändertem Inhalt | 20000928 | ||
| 2 | Importing |
P_CHANGED_OBJECTS | Call by reference | Type reference (TYPE) | SKWF_IOS | Veränderte Objekte | 20000720 | ||
| 3 | Importing |
P_DELETED_OBJECTS | Call by reference | Type reference (TYPE) | SKWF_IOS | Gelöschte Objekte | 20000720 | ||
| 4 | Importing |
P_X_INVALIDATE_LOIOS_OF_PHIOS | Call by reference | Type reference (TYPE) | XFELD | Loios von GEÄNDERTEN Phios mit invalidieren | 20001019 |
Method INVALIDATE_CACHE on class CL_SKWF_CACHING has no exception.
Method INVALIDATE_CACHE_INST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
P_CHANGED_FOLDERS | Call by reference | Type reference (TYPE) | SKWF_IOS | Verzeichnisse mit geändertem Inhalt | 20000928 | ||
| 2 | Importing |
P_CHANGED_OBJECTS | Call by reference | Type reference (TYPE) | SKWF_IOS | Objektliste | 20000720 | ||
| 3 | Importing |
P_DELETED_OBJECTS | Call by reference | Type reference (TYPE) | SKWF_IOS | Objektliste | 20000720 |
Method INVALIDATE_CACHE_INST on class CL_SKWF_CACHING has no exception.
Method LOCK_CACHE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
P_AREA | Call by reference | Type reference (TYPE) | SHBUFAREA | Abgrenzung im Cache | 20001013 | ||
| 2 | Importing |
P_CACHE_ID | Call by reference | Type reference (TYPE) | SHBUFKEY | Komplette Cache ID | 20001126 | ||
| 3 | Importing |
P_X_WAIT | Call by reference | Type reference (TYPE) | XFELD | 'X': Bei bestehender Sperre auf Freigabe warten | 20001013 | ||
| 4 | Importing |
P_X_WRITE | Call by reference | Type reference (TYPE) | XFELD | Zum Schreiben locken | 20001126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | LOCKING_FAILED |
Es konnte keine exklusive Sperre gesetzt werden | 20001013 |
Method LOG_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
P_INFO | Call by reference | Type reference (TYPE) | C | Zusatzinfo | 20010112 | ||
| 2 | Importing |
P_MESSAGE | Call by reference | Type reference (TYPE) | C | Log-Nachricht | 20010111 | ||
| 3 | Importing |
P_MESSAGE_TYPE | Call by reference | Type reference (TYPE) | SYMSGTY | 'S' | Anwendungs-Log: Problemklasse einer Meldung | 20010111 |
Method LOG_MESSAGE on class CL_SKWF_CACHING has no exception.
Method REGISTER_CACHE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
P_CACHE | Call by reference | Object reference (TYPE REF TO) | CL_SKWF_CACHING | Cache-Layer Core Funktionalität | 20000721 | ||
| 2 | Importing |
P_CACHE_ID | Call by reference | Type reference (TYPE) | SHBUFPREFIX | Cachekennung (Prefix) | 20000721 |
Method REGISTER_CACHE on class CL_SKWF_CACHING has no exception.
Method SET_PARAMETERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
P_CACHE_ID | Call by reference | Type reference (TYPE) | SKWF_CHID | Cache-ID | 20010111 | ||
| 2 | Importing |
P_CACHE_PARAMETER | Call by reference | Type reference (TYPE) | SKWF_CHPAR | Cache-Parameter | 20010111 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | BAD_CACHE_ID |
Ungültige Cache Kennung | 20010111 | |
| 2 | BAD_PARAMETERS |
Ungültige Cache Parameter | 20010111 | |
| 3 | UPDATE_FAILED |
Fehler beim Ändern der Parameter | 20010111 |
Method SET_SLEEPMODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
X_SLEEP | Call by reference | Type reference (TYPE) | XFELD | 'X': Einschalten, ' ': Ausschalten | 20010227 |
Method SET_SLEEPMODE on class CL_SKWF_CACHING has no exception.
Method SYNC_CACHE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
P_ADMIN_DATA | Call by reference | Type reference (TYPE) | ADMIN_DATA_T | Administrative Daten | 20001029 | ||
| 2 | Changing |
P_ADMIN_TABLE | Call by reference | Type reference (TYPE) | ANY TABLE | Tabellenreferenz für globale Verwaltungstabelle | 20001017 | ||
| 3 | Importing |
P_AREA | Call by reference | Type reference (TYPE) | SHBUFAREA | Cache-Abgrenzung | 20001029 | ||
| 4 | Changing |
P_TABLE | Call by reference | Type reference (TYPE) | ANY TABLE | Tabellenreferenz für Cache | 20001013 | ||
| 5 | Importing |
P_X_FORCE | Call by reference | Type reference (TYPE) | XFELD | Unabhängig von Latenz synchronisieren | 20001013 | ||
| 6 | Importing |
P_X_NO_LOCK | Call by reference | Type reference (TYPE) | XFELD | Keine Sperre anfordern (wurde bereits gemacht!) | 20001013 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | MISSING_AREA_ID |
Es wurde keine Cache-Abgrenzung übergeben | 20001016 |
Method TIMESTAMP_CALC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
P_HOURS | Call by reference | Type reference (TYPE) | I | Anzahl Stunden (+/-) | 20000725 | ||
| 2 | Importing |
P_MINUTES | Call by reference | Type reference (TYPE) | I | Anzahl Minuten (+/-) | 20000725 | ||
| 3 | Returning |
P_RESULT_TIMESTAMP | Value transfer | Type reference (TYPE) | TIMESTAMP | UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss) | 20000725 | ||
| 4 | Importing |
P_SECONDS | Call by reference | Type reference (TYPE) | I | Anzahl Sekunden (+/-) | 20010118 | ||
| 5 | Importing |
P_TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMP | UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss) | 20000725 |
Method TIMESTAMP_CALC on class CL_SKWF_CACHING has no exception.
Method UNLOCK_CACHE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
P_AREA | Call by reference | Type reference (TYPE) | SHBUFAREA | Cache-Abgrenzung | 20001013 | ||
| 2 | Importing |
P_CACHE_ID | Call by reference | Type reference (TYPE) | SHBUFKEY | Komplette Cache ID | 20001126 | ||
| 3 | Importing |
P_X_WRITE | Call by reference | Type reference (TYPE) | XFELD | Cache war zum Schreiben gesperrt | 20001126 |
Method UNLOCK_CACHE on class CL_SKWF_CACHING has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 50A |
