SAP ABAP Interface IF_OA2C_AUTH_CODE_GRANT (OAuth 2.0 Authorization Code Grant)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SEC (Application Component) Security
     ⤷ SOAUTH2_CLIENT_PROTOCOL (Package) OAuth 2.0 Client Protocol

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_OA2C_AUTH_CODE_GRANT	OAuth 2.0 Client - Authorization Code Grant	20130419

Properties

Interface	IF_OA2C_AUTH_CODE_GRANT
Short Description	OAuth 2.0 Authorization Code Grant

General Data

Package	SOAUTH2_CLIENT_PROTOCOL	OAuth 2.0 Client Protocol
Created	20130415	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_OA2C_AUTH_CODE_GRANT has no interface.

Friends

Interface IF_OA2C_AUTH_CODE_GRANT has no friend.

Attributes

Interface IF_OA2C_AUTH_CODE_GRANT has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACCESS_TOKEN_REQUEST	Instance method	Public	Method	Send an Access Token Request and process the Response.	20130415
2	AUTHORIZATION_REQUEST	Instance method	Public	Method	Build a redirection URI for the Authorization Request.	20130415
3	AUTHORIZATION_RESPONSE	Instance method	Public	Method	Process the Authorization Response.	20130415

Events

Interface IF_OA2C_AUTH_CODE_GRANT has no event.

Types

Interface IF_OA2C_AUTH_CODE_GRANT has no local type.

Method Signatures

Method ACCESS_TOKEN_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ACCESS_TOKEN	Call by reference	☐	Type reference (TYPE)	STRING			20130415
2	Exporting	E_EXPIRES_IN	Call by reference	☐	Type reference (TYPE)	I			20130415
3	Exporting	E_REFRESH_TOKEN	Call by reference	☐	Type reference (TYPE)	STRING			20130415
4	Exporting	E_SCOPE	Call by reference	☐	Type reference (TYPE)	STRING			20130612
5	Exporting	E_TOKEN_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20130415
6	Importing	I_ACCESS_TOKEN_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`access_token`		20130417
7	Importing	I_CLIENT_AUTHENTICATION	Call by reference	☐	Type reference (TYPE)	I	1	1: Basic; 2: Form Fields; 3: Client Cert.	20130415
8	Importing	I_CLIENT_ID	Call by reference	☐	Type reference (TYPE)	STRING			20130415
9	Importing	I_CLIENT_ID_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`client_id`		20130415
10	Importing	I_CLIENT_SECRET	Call by reference	☐	Type reference (TYPE)	STRING			20130415
11	Importing	I_CLIENT_SECRET_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`client_secret`		20130415
12	Importing	I_CODE	Call by reference	☐	Type reference (TYPE)	STRING			20130415
13	Importing	I_CODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`code`		20130415
14	Importing	I_ERROR_DESCRIPTION_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`error_description`		20130626
15	Importing	I_ERROR_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`error`		20130626
16	Importing	I_ERROR_URI_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`error_uri`		20130626
17	Importing	I_EXPIRES_IN_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`expires_in`		20130417
18	Importing	I_GRANT_TYPE	Call by reference	☐	Type reference (TYPE)	STRING	`authorization_code`		20130415
19	Importing	I_GRANT_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`grant_type`		20130415
20	Importing	I_INVALID_CLIENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`invalid_client`		20130415
21	Importing	I_INVALID_GRANT_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`invalid_grant`		20130415
22	Importing	I_INVALID_REQUEST_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`invalid_request`		20130415
23	Importing	I_INVALID_SCOPE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`invalid_scope`		20130415
24	Importing	I_REDIRECT_URI	Call by reference	☐	Type reference (TYPE)	STRING			20130415
25	Importing	I_REDIRECT_URI_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`redirect_uri`		20130415
26	Importing	I_REFRESH_TOKEN_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`refresh_token`		20130417
27	Importing	I_SCOPE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'scope'		20130612
28	Importing	I_TOKEN_ENDPOINT	Call by reference	☐	Type reference (TYPE)	STRING			20130415
29	Importing	I_TOKEN_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`token_type`		20130417
30	Importing	I_UNAUTHORIZED_CLIENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`unauthorized_client`		20130415
31	Importing	I_UNSUPPORTED_GRANT_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`unsupported_grant_type`		20130415

#	Exception	Resumable	Description	Created on
1	CX_OA2C_INVALID_CLIENT	☐	OAuth 2.0 Client - Invalid Client Exception	20130415
2	CX_OA2C_INVALID_GRANT	☐	OAuth 2.0 Client - Invalid Grant Exception	20130415
3	CX_OA2C_INVALID_REQUEST	☐	OAuth 2.0 Client - Invalid Request Exception	20130415
4	CX_OA2C_INVALID_SCOPE	☐	OAuth 2.0 Client - Invalid Scope Exception	20130415
5	CX_OA2C_PROTOCOL_EXCEPTION	☐	OAuth 2.0 Client - Protocol Exception	20130612
6	CX_OA2C_SERVER_ERROR	☐	OAuth 2.0 Client - Server Error Exception	20130626
7	CX_OA2C_TEMPORARILY_UNAVAIL	☐	OAuth 2.0 Client - Temporarily Unavailable Exception	20130626
8	CX_OA2C_UNAUTHORIZED_CLIENT	☐	OAuth 2.0 Client - Unauthorized Client Exception	20130415
9	CX_OA2C_UNSUPPORTED_GRANT_TYPE	☐	OAuth 2.0 Client - Unsupported Response Type Exception	20130415

Method AUTHORIZATION_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CLIENT_REDIRECTION_URI	Call by reference	☐	Type reference (TYPE)	STRING			20130415
2	Importing	IT_ADDITIONAL_PARAMS	Call by reference	☑	Type reference (TYPE)	TIHTTPNVP		Authorization REQUEST Extension - Name / Value Pairs	20130415
3	Importing	I_AUTHORIZATION_ENDPOINT	Call by reference	☐	Type reference (TYPE)	STRING			20130415
4	Importing	I_CLIENT_ID	Call by reference	☐	Type reference (TYPE)	STRING			20130415
5	Importing	I_CLIENT_ID_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`client_id`		20130415
6	Importing	I_ESCAPE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20130613
7	Importing	I_REDIRECT_URI	Call by reference	☐	Type reference (TYPE)	STRING			20130415
8	Importing	I_REDIRECT_URI_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`redirect_uri`		20130415
9	Importing	I_RESPONSE_TYPE	Call by reference	☐	Type reference (TYPE)	STRING	`code`		20130415
10	Importing	I_RESPONSE_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`response_type`		20130415
11	Importing	I_SCOPE	Call by reference	☐	Type reference (TYPE)	STRING			20130415
12	Importing	I_SCOPE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`scope`		20130415
13	Importing	I_STATE	Call by reference	☐	Type reference (TYPE)	STRING		Name of state-parameter may not be changed	20130415

Method AUTHORIZATION_REQUEST on Interface IF_OA2C_AUTH_CODE_GRANT has no exception.

Method AUTHORIZATION_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CODE	Call by reference	☐	Type reference (TYPE)	STRING			20130415
2	Exporting	E_STATE	Call by reference	☐	Type reference (TYPE)	STRING			20130627
3	Importing	IO_SERVER	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20130415
4	Importing	IT_URL_PARAMETERS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Table Name/Value Pairs	20130613
5	Importing	I_ACCESS_DENIED	Call by reference	☐	Type reference (TYPE)	STRING	`access_denied`		20130415
6	Importing	I_CODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`code`		20130415
7	Importing	I_ERROR_DESCRIPTION_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`error_description`		20130611
8	Importing	I_ERROR_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`error`		20130611
9	Importing	I_ERROR_URI_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`error_uri`		20130611
10	Importing	I_INVALID_REQUEST_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`invalid_request`		20130415
11	Importing	I_INVALID_SCOPE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`invalid_scope`		20130415
12	Importing	I_SERVER_ERROR_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`server_error`		20130415
13	Importing	I_STATE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'state'		20130627
14	Importing	I_TEMPORARILY_UNAVAILABLE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`temporarily_unavailable`		20130415
15	Importing	I_UNAUTHORIZED_CLIENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`unauthorized_client`		20130415
16	Importing	I_UNSUPPORTED_RESPONSE_TYPE_NA	Call by reference	☐	Type reference (TYPE)	STRING	`unsupported_response_type`		20130415

#	Exception	Resumable	Description	Created on
1	CX_OA2C_ACCESS_DENIED	☐	OAuth 2.0 Client - Access Denied Exception	20130415
2	CX_OA2C_INVALID_REQUEST	☐	OAuth 2.0 Client - Invalid Request Exception	20130415
3	CX_OA2C_INVALID_SCOPE	☐	OAuth 2.0 Client - Invalid Scope Exception	20130415
4	CX_OA2C_SERVER_ERROR	☐	OAuth 2.0 Client - Server Error Exception	20130415
5	CX_OA2C_TEMPORARILY_UNAVAIL	☐	OAuth 2.0 Client - Temporarily Unavailable Exception	20130415
6	CX_OA2C_UNAUTHORIZED_CLIENT	☐	OAuth 2.0 Client - Unauthorized Client Exception	20130415
7	CX_OA2C_UNSUPP_RESPONSE_TYPE	☐	OAuth 2.0 Client - Unsupported Response Type Exception	20130415

History

Last changed by/on	SAP	20140121
SAP Release Created in	740