SAP ABAP Class /IWBEP/CL_IDP_UTIL (Utility for Idempotent (Exactly-Once) behavior)
Hierarchy
☛
SAP_GWFND (Software Component) SAP Gateway Foundation
⤷
OPU-BSE-SDE (Application Component) Gateway SAP Data Enablement
⤷
/IWBEP/COS_IDP (Package) Gateway - Common Services - Idempotent Support
SAP_GWFND (Software Component) SAP Gateway Foundation⤷
OPU-BSE-SDE (Application Component) Gateway SAP Data Enablement⤷
/IWBEP/COS_IDP (Package) Gateway - Common Services - Idempotent SupportProperties
| Class | /IWBEP/CL_IDP_UTIL | |
| Short Description | Utility for Idempotent (Exactly-Once) behavior | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /IWBEP/COS_IDP | Gateway - Common Services - Idempotent Support |
| Created | 20120530 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  /IWBEP/CX_MGW_BUSI_EXCEPTION |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 2 | ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 3 | IF_T100_MESSAGE |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Class /IWBEP/CL_IDP_UTIL has no interface implemented.
Friends
Class /IWBEP/CL_IDP_UTIL has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_LOG_AGENT |
Constant | Private | Type reference (TYPE) | /IWBEP/SUP_IW_AGENT | 'Idempotent Util' | Gateway Agent or Component | 20120531 | |
| 2 | MO_IDP_HELPER |
Instance attribute | Private | Object reference (TYPE REF TO) | IF_WS_IDP_HELPER | API Interface for Idempotent WS Service | 20120530 | ||
| 3 | MO_LOGGER |
Instance attribute | Private | Object reference (TYPE REF TO) | /IWBEP/CL_COS_LOGGER | Logger for local AppsLog and CCMS | 20120531 | ||
| 4 | MV_IS_IDP_REQUESTED |
Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | TRUE if idempotent behavior is requested by client | 20120530 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADJUST_HTTP_HEADER_SUPPORTED |
Static method | Public | Method | Adds the http header field RepeatabilityResult = 'rejected' | 20120604 |
| 2 | CONSTRUCTOR |
Instance method | Public | Constructor | CONSTRUCTOR | 20120530 |
| 3 | HAS_BEEN_PROCESSED |
Instance method | Public | Method | Check if this Request ID has been used for a request before | 20120530 |
| 4 | IS_IDP_REQUESTED |
Instance method | Public | Method | Check if the OData client has requested Idempotent Behavior | 20120530 |
| 5 | RAISE_LOG_EXCEPTION |
Instance method | Private | Method | CONSTRUCTOR | 20120531 |
| 6 | RETRIEVE_RESULT |
Instance method | Public | Method | Retrieve the result for the Request ID | 20120530 |
| 7 | STORE_RESULT |
Instance method | Public | Method | Store the result for the Request ID | 20120530 |
Events
Class /IWBEP/CL_IDP_UTIL has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_LS_RESULT | Private | See coding | Export / Chang fields of CUD ops in /IWBEP/FGR_MGW_CLIENT_IF | 20120530 | BEGIN OF ty_ls_result ,
v_entity_data TYPE xstring,
t_header TYPE tihttpnvp,
t_msg_container TYPE /iwbep/t_message_container,
s_msg_container_h TYPE /iwbep/s_message_container_h,
v_content_format TYPE /iwbep/mgw_content_format,
v_batch_header_size TYPE i,
v_batch_payload TYPE xstring,
END OF ty_ls_result
|
Method Signatures
Method ADJUST_HTTP_HEADER_SUPPORTED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CT_HTTP_PARAMETERS | Call by reference | Type reference (TYPE) | TIHTTPNVP | http header parameter (key / value pair) | 20120604 |
Method ADJUST_HTTP_HEADER_SUPPORTED on class /IWBEP/CL_IDP_UTIL has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IT_HTTP_HEADER_PARAMETERS | Call by reference | Type reference (TYPE) | /IWBEP/T_MGW_NAME_VALUE_PAIR | Http header parameters - checked for the relevant parameters | 20120530 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  /IWBEP/CX_IDP_UTIL |
Idempotent (Exactly-Once) behavior technical exception | 20120531 |
Method HAS_BEEN_PROCESSED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RV_HAS_BEEN_PROCESSED | Value transfer | Type reference (TYPE) | ABAP_BOOL | TRUE if request was processed before and result is available | 20120530 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IWBEP/CX_IDP_UTIL |
Idempotent (Exactly-Once) behavior technical exception | 20120601 |
Method IS_IDP_REQUESTED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_IS_IDP_REQUESTED | Value transfer | Type reference (TYPE) | ABAP_BOOL | TRUE if idempotent behavior is requested by client | 20120530 |
Method IS_IDP_REQUESTED on class /IWBEP/CL_IDP_UTIL has no exception.
Method RAISE_LOG_EXCEPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_HTTP_STATUS_CODE | Call by reference | Type reference (TYPE) | /IWBEP/MGW_HTTP_STATUS_CODE | '412' | http status code, see documentation for constants | 20120618 | |
| 2 | Importing |
IV_TEXT_ID | Call by reference | Type reference (TYPE) | SCX_T100KEY | Http header parameters - checked for the relevant parameters | 20120531 | ||
| 3 | Importing |
IX_PREVIOUS | Call by reference | Object reference (TYPE REF TO) | CX_ROOT | Abstract Superclass for All Global Exceptions | 20120531 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IWBEP/CX_IDP_UTIL |
Idempotent (Exactly-Once) behavior technical exception | 20120531 |
Method RETRIEVE_RESULT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ES_MSG_CONTAINER_H | Call by reference | Type reference (TYPE) | /IWBEP/S_MESSAGE_CONTAINER_H | Header and general information of the Message Container | 20120530 | ||
| 2 | Exporting |
ET_HEADER | Call by reference | Type reference (TYPE) | TIHTTPNVP | HTTP Framework (iHTTP) Table Name/Value Pairs | 20120530 | ||
| 3 | Exporting |
ET_MSG_CONTAINER | Call by reference | Type reference (TYPE) | /IWBEP/T_MESSAGE_CONTAINER | Message Container Data Table | 20120530 | ||
| 4 | Exporting |
EV_BATCH_HEADER_SIZE | Call by reference | Type reference (TYPE) | I | Response Header Size for a CHANGESET | 20120625 | ||
| 5 | Exporting |
EV_BATCH_PAYLOAD | Call by reference | Type reference (TYPE) | XSTRING | Response Payload for a CHANGESET | 20120625 | ||
| 6 | Exporting |
EV_CONTENT_FORMAT | Call by reference | Type reference (TYPE) | /IWBEP/MGW_CONTENT_FORMAT | the format of the response content | 20120530 | ||
| 7 | Exporting |
EV_ENTITY_DATA | Call by reference | Type reference (TYPE) | XSTRING | Data of an entity | 20120530 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IWBEP/CX_IDP_UTIL |
Idempotent (Exactly-Once) behavior technical exception | 20120601 |
Method STORE_RESULT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_MSG_CONTAINER_H | Call by reference | Type reference (TYPE) | /IWBEP/S_MESSAGE_CONTAINER_H | Message Container Header and general information | 20120530 | ||
| 2 | Importing |
IT_HEADER | Call by reference | Type reference (TYPE) | TIHTTPNVP | HTTP Framework (iHTTP) Table Name/Value Pairs | 20120530 | ||
| 3 | Importing |
IT_MSG_CONTAINER | Call by reference | Type reference (TYPE) | /IWBEP/T_MESSAGE_CONTAINER | Message Container Data Table | 20120530 | ||
| 4 | Importing |
IV_BATCH_HEADER_SIZE | Call by reference | Type reference (TYPE) | I | Response Header Size for a CHANGESET | 20120625 | ||
| 5 | Importing |
IV_BATCH_PAYLOAD | Call by reference | Type reference (TYPE) | XSTRING | Response Payload for a CHANGESET | 20120625 | ||
| 6 | Importing |
IV_CONTENT_FORMAT | Call by reference | Type reference (TYPE) | /IWBEP/MGW_CONTENT_FORMAT | the format of the response content | 20120530 | ||
| 7 | Importing |
IV_ENTITY_DATA | Call by reference | Type reference (TYPE) | XSTRING | Data of an entity | 20120530 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IWBEP/CX_IDP_UTIL |
Idempotent (Exactly-Once) behavior technical exception | 20120601 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 200 |
