SAP ABAP Class /IWCOR/CL_REST_MESSAGE_BUILDER (REST message builder)
Hierarchy
☛
SAP_GWFND (Software Component) SAP Gateway Foundation
⤷
OPU-FND-CCL (Application Component) IWF Consumer Connectivity Layer
⤷
/IWCOR/SREST_CORE (Package) REST library core
⤷
⤷
Properties
| Class | /IWCOR/CL_REST_MESSAGE_BUILDER | |
| Short Description | REST message builder | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /IWCOR/SREST_CORE | REST library core |
| Created | 20111011 | SAP |
| Last change | 20131127 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class /IWCOR/CL_REST_MESSAGE_BUILDER has no interface implemented.
Friends
Class /IWCOR/CL_REST_MESSAGE_BUILDER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | HTTP_VERSION | '1.0' | 20111014 | |||
| 2 | Constant | Public | Type reference (TYPE) | HTTP_VERSION | '1.1' | 20111014 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Private | Method | Create empty http request | 20120410 | |
| 2 | Static method | Private | Method | Create empty http response | 20120410 | |
| 3 | Static method | Public | Method | Create entity by http entity | 20120410 | |
| 4 | Static method | Public | Method | Create request by http request | 20111014 | |
| 5 | Static method | Public | Method | Create response by http response | 20111014 | |
| 6 | Static method | Public | Method | Create message entity | 20120410 | |
| 7 | Static method | Public | Method | Create request | 20111014 | |
| 8 | Static method | Public | Method | Create response | 20111014 | |
| 9 | Static method | Private | Method | Set http response version | 20111014 |
Events
Class /IWCOR/CL_REST_MESSAGE_BUILDER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | HTTP_VERSION | Public | See coding | 20111014 | http_version TYPE p LENGTH 2 DECIMALS 1
|
Method Signatures
Method CREATE_EMPTY_HTTP_REQUEST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_HTTP_VERSION | Call by reference | Type reference (TYPE) | HTTP_VERSION | GC_HTTP_VERSION_1_1 | Version | 20120410 | ||
| 2 | RO_REQUEST | Value transfer | Object reference (TYPE REF TO) | IF_HTTP_REQUEST | HTTP Request | 20120410 |
Method CREATE_EMPTY_HTTP_REQUEST on class /IWCOR/CL_REST_MESSAGE_BUILDER has no exception.
Method CREATE_EMPTY_HTTP_RESPONSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_HTTP_VERSION | Call by reference | Type reference (TYPE) | HTTP_VERSION | GC_HTTP_VERSION_1_1 | Version | 20120410 | ||
| 2 | RO_RESPONSE | Value transfer | Object reference (TYPE REF TO) | IF_HTTP_RESPONSE | HTTP Response | 20120410 |
Method CREATE_EMPTY_HTTP_RESPONSE on class /IWCOR/CL_REST_MESSAGE_BUILDER has no exception.
Method CREATE_HTTP_MESSAGE_ENTITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_HTTP_ENTITY | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_ENTITY | HTTP entity | 20120410 | |||
| 2 | RO_ENTITY | Value transfer | Object reference (TYPE REF TO) | /IWCOR/IF_REST_ENTITY | REST entity | 20120410 |
Method CREATE_HTTP_MESSAGE_ENTITY on class /IWCOR/CL_REST_MESSAGE_BUILDER has no exception.
Method CREATE_HTTP_REQUEST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_HTTP_REQUEST | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_REQUEST | HTTP Request | 20111014 | |||
| 2 | IV_ALLOW_METHOD_OVERRIDE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_UNDEFINED | Allow method override | 20120410 | ||
| 3 | RO_REQUEST | Value transfer | Object reference (TYPE REF TO) | /IWCOR/IF_REST_REQUEST | REST Request | 20111014 |
Method CREATE_HTTP_REQUEST on class /IWCOR/CL_REST_MESSAGE_BUILDER has no exception.
Method CREATE_HTTP_RESPONSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_HTTP_RESPONSE | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_RESPONSE | HTTP Response | 20111014 | |||
| 2 | RO_RESPONSE | Value transfer | Object reference (TYPE REF TO) | /IWCOR/IF_REST_RESPONSE | REST Response | 20111014 |
Method CREATE_HTTP_RESPONSE on class /IWCOR/CL_REST_MESSAGE_BUILDER has no exception.
Method CREATE_MESSAGE_ENTITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_HEADER_FIELD | Call by reference | Type reference (TYPE) | TIHTTPNVP | Header fields | 20120410 | |||
| 2 | IV_MESSAGE_KIND | Call by reference | Type reference (TYPE) | /IWCOR/IF_REST_MESSAGE=>MESSAGE_KIND | /IWCOR/IF_REST_MESSAGE=>GC_MESSAGE_KIND_NONE | Message Kind | 20120410 | ||
| 3 | RO_ENTITY | Value transfer | Object reference (TYPE REF TO) | /IWCOR/IF_REST_ENTITY | REST Entity | 20120410 |
Method CREATE_MESSAGE_ENTITY on class /IWCOR/CL_REST_MESSAGE_BUILDER has no exception.
Method CREATE_REQUEST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_HEADER_FIELD | Call by reference | Type reference (TYPE) | TIHTTPNVP | Header fields | 20111014 | |||
| 2 | IV_HTTP_VERSION | Call by reference | Type reference (TYPE) | HTTP_VERSION | GC_HTTP_VERSION_1_1 | Version | 20111014 | ||
| 3 | IV_METHOD | Call by reference | Type reference (TYPE) | STRING | Method | 20111014 | |||
| 4 | IV_SCRIPT_NAME | Call by reference | Type reference (TYPE) | STRING | Script name | 20120209 | |||
| 5 | IV_URI | Call by reference | Type reference (TYPE) | STRING | URI | 20111014 | |||
| 6 | RO_REQUEST | Value transfer | Object reference (TYPE REF TO) | /IWCOR/IF_REST_REQUEST | REST Request | 20111014 |
Method CREATE_REQUEST on class /IWCOR/CL_REST_MESSAGE_BUILDER has no exception.
Method CREATE_RESPONSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_HEADER_FIELD | Call by reference | Type reference (TYPE) | TIHTTPNVP | Header fields | 20111014 | |||
| 2 | IV_HTTP_VERSION | Call by reference | Type reference (TYPE) | HTTP_VERSION | GC_HTTP_VERSION_1_1 | Protocol version | 20111014 | ||
| 3 | IV_REASON_PHRASE | Call by reference | Type reference (TYPE) | STRING | Reason phrase | 20111014 | |||
| 4 | IV_STATUS_CODE | Call by reference | Type reference (TYPE) | I | /IWCOR/CL_REST_STATUS_CODE=>GC_SUCCESS_OK | Status code | 20111014 | ||
| 5 | RO_RESPONSE | Value transfer | Object reference (TYPE REF TO) | /IWCOR/IF_REST_RESPONSE | Response | 20111014 |
Method CREATE_RESPONSE on class /IWCOR/CL_REST_MESSAGE_BUILDER has no exception.
Method SET_HTTP_RESPONSE_VERSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_HTTP_RESPONSE | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_RESPONSE | HTTP Response | 20111014 | |||
| 2 | IV_PROTOCOL_VERSION | Call by reference | Type reference (TYPE) | I | HTTP protocol version | 20111014 |
Method SET_HTTP_RESPONSE_VERSION on class /IWCOR/CL_REST_MESSAGE_BUILDER has no exception.
History
| Last changed by/on | SAP | 20131127 |
| SAP Release Created in | 200 |