SAP ABAP Interface IF_CLB_HTTP_CONNECTOR (SAIL: Client Facade)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-STW (Application Component) Social Media ABAP Integration Library
⤷
S_CLB_CONNECT (Package) Connectivity Layer of the Collaboration Platform Library
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_CLB_CONNECTOR | SAIL: Client Facade | 20110809 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | TD_CLB_CONNECTOR | Test Double for HTTP Connector | 20110826 |
| 3 | Interface implementation (CLASS c. INTERFACES i_ref) | TD_CLB_GENERAL_ABSTRACT | general abstract testdouble to reduce note dependencies | 20120524 |
| 4 | Interface implementation (CLASS c. INTERFACES i_ref) | TD_CLB_HTTP_CONNECTOR | Collaboration: Test Double of http Connector | 20111013 |
Properties
| Interface | IF_CLB_HTTP_CONNECTOR | |
| Short Description | SAIL: Client Facade |
General Data
| Package | S_CLB_CONNECT | Connectivity Layer of the Collaboration Platform Library |
| Created | 20110809 | SAP |
| Last changed | 20130531 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | IF_CLB_CONFIGURATION | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Interface IF_CLB_HTTP_CONNECTOR has no interface.
Friends
Interface IF_CLB_HTTP_CONNECTOR has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_HTTP_HEADER_FIELD | Constant | Public | See coding | http Header Fields | 20121217 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Add a cookie | 20110809 | |
| 2 | Instance method | Public | Method | Add a form field | 20110809 | |
| 3 | Instance method | Public | Method | Add a header field | 20110809 | |
| 4 | Instance method | Public | Method | Close the channel | 20110822 | |
| 5 | Instance method | Public | Method | Create the URL as HTTP client would with the current data | 20111221 | |
| 6 | Instance method | Public | Method | Execute the call | 20110809 | |
| 7 | Instance method | Public | Method | Receive the result from the HTTP clinet | 20111006 | |
| 8 | Instance method | Public | Method | Send the request to the target | 20111006 | |
| 9 | Instance method | Public | Method | Get the underlying HTTP client (when initialized) | 20110809 | |
| 10 | Instance method | Public | Method | Get the (HTTP) return code of the last call | 20110816 | |
| 11 | Instance method | Public | Method | Get a descriptive error message | 20110816 | |
| 12 | Instance method | Public | Method | Get the result data of the call | 20110816 | |
| 13 | Instance method | Public | Method | Get the target URl | 20110815 | |
| 14 | Instance method | Public | Method | Set the underlying HTTP client | 20111129 | |
| 15 | Instance method | Public | Method | Set information for firewall access | 20110809 | |
| 16 | Instance method | Public | Method | Set data into the client | 20110817 | |
| 17 | Instance method | Public | Method | Set the body for oAuth w/ SAMLResponse | 20111212 | |
| 18 | Instance method | Public | Method | Set the parameters for the oAuth header | 20110809 |
Events
Interface IF_CLB_HTTP_CONNECTOR has no event.
Types
Interface IF_CLB_HTTP_CONNECTOR has no local type.
Method Signatures
Method ADD_COOKIE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_NAME | Call by reference | Type reference (TYPE) | STRING | 20110809 | ||||
| 2 | I_VALUE | Call by reference | Type reference (TYPE) | STRING | 20110809 |
Method ADD_COOKIE on Interface IF_CLB_HTTP_CONNECTOR has no exception.
Method ADD_FORM_FIELD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_NAME | Call by reference | Type reference (TYPE) | STRING | 20110809 | ||||
| 2 | I_VALUE | Call by reference | Type reference (TYPE) | STRING | 20110809 |
Method ADD_FORM_FIELD on Interface IF_CLB_HTTP_CONNECTOR has no exception.
Method ADD_HEADER_FIELD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_NAME | Call by reference | Type reference (TYPE) | STRING | 20110809 | ||||
| 2 | I_VALUE | Call by reference | Type reference (TYPE) | STRING | 20110809 |
Method ADD_HEADER_FIELD on Interface IF_CLB_HTTP_CONNECTOR has no exception.
Method CLOSE Signature
Method CLOSE on Interface IF_CLB_HTTP_CONNECTOR has no parameter.
Method CLOSE on Interface IF_CLB_HTTP_CONNECTOR has no exception.
Method CREATE_ABS_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_VALUE | Value transfer | Type reference (TYPE) | STRING | 20111221 |
Method CREATE_ABS_URL on Interface IF_CLB_HTTP_CONNECTOR has no exception.
Method EXECUTE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_RESPONSE_XDATA | Value transfer | Type reference (TYPE) | XSTRING | 20110809 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | SAIL: Connectivity Layer Exception | 20110810 | ||
| 2 | SAIL: Runtime exception | 20110915 |
Method EXECUTE_RECEIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_RESPONSE_XDATA | Value transfer | Type reference (TYPE) | XSTRING | 20111006 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | SAIL: Connectivity Layer Exception | 20111006 | ||
| 2 | SAIL: Runtime exception | 20111006 |
Method EXECUTE_SEND Signature
Method EXECUTE_SEND on Interface IF_CLB_HTTP_CONNECTOR has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | SAIL: Connectivity Layer Exception | 20111006 | ||
| 2 | SAIL: Runtime exception | 20111006 |
Method GET_CLIENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RO_CLIENT | Value transfer | Object reference (TYPE REF TO) | IF_HTTP_CLIENT | HTTP Client Abstraction | 20110825 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | SAIL: Connectivity Layer Exception | 20110810 | ||
| 2 | SAIL: Runtime exception | 20110914 |
Method GET_LAST_ERROR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_VALUE | Value transfer | Type reference (TYPE) | NUM4 | Natural number | 20110816 |
Method GET_LAST_ERROR on Interface IF_CLB_HTTP_CONNECTOR has no exception.
Method GET_LAST_ERROR_MSG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_VALUE | Value transfer | Type reference (TYPE) | STRING | 20110816 |
Method GET_LAST_ERROR_MSG on Interface IF_CLB_HTTP_CONNECTOR has no exception.
Method GET_RESULT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_VALUE | Value transfer | Type reference (TYPE) | XSTRING | 20110816 |
Method GET_RESULT on Interface IF_CLB_HTTP_CONNECTOR has no exception.
Method GET_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_VALUE | Value transfer | Type reference (TYPE) | STRING | 20110815 |
Method GET_URL on Interface IF_CLB_HTTP_CONNECTOR has no exception.
Method SET_CLIENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_CLIENT | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_CLIENT | HTTP Client Abstraction | 20111129 |
Method SET_CLIENT on Interface IF_CLB_HTTP_CONNECTOR has no exception.
Method SET_CONNECTION_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_CONNECTION_DATA | Call by reference | Type reference (TYPE) | CLB_S_CONNECTION_DATA | 20110826 |
Method SET_CONNECTION_DATA on Interface IF_CLB_HTTP_CONNECTOR has no exception.
Method SET_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_DATA | Call by reference | Type reference (TYPE) | XSTRING | 20110817 |
Method SET_DATA on Interface IF_CLB_HTTP_CONNECTOR has no exception.
Method SET_OAUTH_BODY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_PARAMS | Call by reference | Type reference (TYPE) | TIHTTPNVP | HTTP Framework (iHTTP) Table Name/Value Pairs | 20111212 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | SAIL: Runtime exception | 20111212 |
Method SET_OAUTH_HEADER_PARAMS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_PARAMS | Call by reference | Type reference (TYPE) | TIHTTPNVP | HTTP Framework (iHTTP) Table Name/Value Pairs | 20110809 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | SAIL: Runtime exception | 20110914 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 732 |