SAP ABAP Interface IF_OAUTH2_CLIENT (OAuth 2.0 Client)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SEC (Application Component) Security
⤷
SOAUTH2_CLIENT_FACADE (Package) OAuth 2.0 Client Facade
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-SEC (Application Component) Security⤷
SOAUTH2_CLIENT_FACADE (Package) OAuth 2.0 Client Facade
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_OA2C_CLIENT | OAuth 2.0 Client | 20130417 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_OAUTH2_CLIENT | OAuth 2.0 Client | 20130417 |
Properties
| Interface | IF_OAUTH2_CLIENT | |
| Short Description | OAuth 2.0 Client |
General Data
| Package | SOAUTH2_CLIENT_FACADE | OAuth 2.0 Client Facade |
| Created | 20130417 | SAP |
| Last changed | 20140121 | SAP |
| 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) |
Interfaces
Interface IF_OAUTH2_CLIENT has no interface.
Friends
Interface IF_OAUTH2_CLIENT has no friend.
Attributes
Interface IF_OAUTH2_CLIENT has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_ERROR_RESPONSE |
Instance method | Public | Method | Check HTTP-Response for OAuth 2.0-Server-Error | 20130417 |
| 2 | EXECUTE_REFRESH_FLOW |
Instance method | Public | Method | Execute Refresh Flow | 20130417 |
| 3 | EXECUTE_SAML20_FLOW |
Instance method | Public | Method | Execute SAML 2.0 Flow | 20130417 |
| 4 | SET_TOKEN |
Instance method | Public | Method | Set Authorization Header in HTTP-Client | 20130417 |
Events
Interface IF_OAUTH2_CLIENT has no event.
Types
Interface IF_OAUTH2_CLIENT has no local type.
Method Signatures
Method CHECK_ERROR_RESPONSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_HTTP_CLIENT | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_CLIENT | HTTP Client Abstraction | 20130417 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_OA2C_INSUFFICIENT_SCOPE |
OAuth 2.0 Client - Insufficient Scope Exception | 20130418 | |
| 2 | CX_OA2C_INVALID_REQUEST |
OAuth 2.0 Client - Invalid Request Exception | 20130418 | |
| 3 | CX_OA2C_INVALID_TOKEN |
OAuth 2.0 Client - Invalid Token Exception | 20130418 |
Method EXECUTE_REFRESH_FLOW Signature
Method EXECUTE_REFRESH_FLOW on Interface IF_OAUTH2_CLIENT has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_OA2C_BADI_IMPLEMENTATION |
OAuth 2.0 Client BAdI Impl. Error | 20130627 | |
| 2 | CX_OA2C_INVALID_CLIENT |
OAuth 2.0 Client - Invalid Client Exception | 20130419 | |
| 3 | CX_OA2C_INVALID_GRANT |
OAuth 2.0 Client - Invalid Grant Exception | 20130419 | |
| 4 | CX_OA2C_INVALID_REQUEST |
OAuth 2.0 Client - Invalid Request Exception | 20130419 | |
| 5 | CX_OA2C_INVALID_SCOPE |
OAuth 2.0 Client - Invalid Scope Exception | 20130419 | |
| 6 | CX_OA2C_NOT_ALLOWED |
OAuth 2.0 Client - Not Allowed Exception | 20130419 | |
| 7 | CX_OA2C_NOT_SUPPORTED |
OAuth 2.0 Client - Not Supported Exception | 20130627 | |
| 8 | CX_OA2C_PROTOCOL_EXCEPTION |
OAuth 2.0 Client - Protocol Exception | 20130628 | |
| 9 | CX_OA2C_UNAUTHORIZED_CLIENT |
OAuth 2.0 Client - Unauthorized Client Exception | 20130419 | |
| 10 | CX_OA2C_UNSUPPORTED_GRANT_TYPE |
OAuth 2.0 Client - Unsupported Response Type Exception | 20130419 |
Method EXECUTE_SAML20_FLOW Signature
Method EXECUTE_SAML20_FLOW on Interface IF_OAUTH2_CLIENT has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_OA2C_INVALID_CLIENT |
OAuth 2.0 Client - Invalid Client Exception | 20130419 | |
| 2 | CX_OA2C_INVALID_GRANT |
OAuth 2.0 Client - Invalid Grant Exception | 20130419 | |
| 3 | CX_OA2C_INVALID_REQUEST |
OAuth 2.0 Client - Invalid Request Exception | 20130419 | |
| 4 | CX_OA2C_INVALID_SCOPE |
OAuth 2.0 Client - Invalid Scope Exception | 20130419 | |
| 5 | CX_OA2C_NOT_ALLOWED |
OAuth 2.0 Client - Not Allowed Exception | 20130419 | |
| 6 | CX_OA2C_NOT_SUPPORTED |
OAuth 2.0 Client - Not Supported Exception | 20130419 | |
| 7 | CX_OA2C_UNAUTHORIZED_CLIENT |
OAuth 2.0 Client - Unauthorized Client Exception | 20130419 | |
| 8 | CX_OA2C_UNSUPPORTED_GRANT_TYPE |
OAuth 2.0 Client - Unsupported Response Type Exception | 20130419 |
Method SET_TOKEN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_HTTP_CLIENT | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_CLIENT | HTTP Client Abstraction | 20130417 |
Method SET_TOKEN on Interface IF_OAUTH2_CLIENT has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 740 |
