SAP ABAP Class CL_OA2C_CLIENT_PROTOCOL_UTILS (OAuth 2.0 Client - Utility Class)

Hierarchy

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

Properties

Class	CL_OA2C_CLIENT_PROTOCOL_UTILS
Short Description	OAuth 2.0 Client - Utility Class
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SOAUTH2_CLIENT_PROTOCOL	OAuth 2.0 Client Protocol
Created	20130626	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_OA2C_CLIENT_PROTOCOL_UTILS has no forward declaration.

Interfaces

Class CL_OA2C_CLIENT_PROTOCOL_UTILS has no interface implemented.

Friends

Class CL_OA2C_CLIENT_PROTOCOL_UTILS has no friend class.

Attributes

Class CL_OA2C_CLIENT_PROTOCOL_UTILS has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_HTTP_CLIENT	Static method	Public	Method	Create http client and set client authentication	20130702
2	GET_TOKENS	Static method	Public	Method	Send token request and parse token response	20130702
3	HANDLE_ERROR_RESPONSE	Static method	Public	Method	Handle error message in the token response	20130626
4	RESPONSE_TO_HTTP_FIELDS	Static method	Public	Method	Parse json response	20130626

Events

Class CL_OA2C_CLIENT_PROTOCOL_UTILS has no event.

Types

Class CL_OA2C_CLIENT_PROTOCOL_UTILS has no local type.

Method Signatures

Method CREATE_HTTP_CLIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EO_HTTP_CLIENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_HTTP_CLIENT		HTTP Client Abstraction	20130702
2	Importing	I_CLIENT_AUTHENTICATION	Call by reference	☐	Type reference (TYPE)	I	1	1: Basic; 2: Form Fields; 3: Client Cert.	20130702
3	Importing	I_CLIENT_ID	Call by reference	☐	Type reference (TYPE)	STRING			20130702
4	Importing	I_CLIENT_SECRET	Call by reference	☐	Type reference (TYPE)	STRING			20130702
5	Importing	I_CLIENT_SECRET_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'client_secrect'		20130702
6	Importing	I_ENDPOINT_URL	Call by reference	☐	Type reference (TYPE)	STRING			20130702

Method CREATE_HTTP_CLIENT on class CL_OA2C_CLIENT_PROTOCOL_UTILS has no exception.

Method GET_TOKENS 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			20130702
2	Exporting	E_EXPIRES_IN	Call by reference	☐	Type reference (TYPE)	I			20130702
3	Exporting	E_REFRESH_TOKEN	Call by reference	☐	Type reference (TYPE)	STRING			20130702
4	Exporting	E_SCOPE	Call by reference	☐	Type reference (TYPE)	STRING			20130702
5	Exporting	E_TOKEN_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20130702
6	Importing	IO_HTTP_CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_CLIENT		HTTP Client Abstraction	20130702
7	Importing	I_ACCESS_TOKEN_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`access_token`		20130702
8	Importing	I_ERROR_DESCRIPTION_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`error_description`		20130702
9	Importing	I_ERROR_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`error`		20130702
10	Importing	I_ERROR_URI_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`error_uri`		20130702
11	Importing	I_EXPIRES_IN_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`expires_in`		20130702
12	Importing	I_REFRESH_TOKEN_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`refresh_token`		20130702
13	Importing	I_SCOPE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'scope'		20130702
14	Importing	I_TOKEN_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`token_type`		20130702

#	Exception	Resumable	Description	Created on
1	CX_OA2C_PROTOCOL_EXCEPTION	☐	OAuth 2.0 Client - Protocol Exception	20130702

Method HANDLE_ERROR_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ERROR	Call by reference	☑	Type reference (TYPE)	STRING			20130626
2	Importing	I_ERROR_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	STRING			20130626
3	Importing	I_ERROR_DESCRIPTION_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`error_description`		20130626
4	Importing	I_ERROR_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`error`		20130626
5	Importing	I_ERROR_URI	Call by reference	☑	Type reference (TYPE)	STRING			20130626
6	Importing	I_ERROR_URI_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`error_uri`		20130626
7	Importing	I_INVALID_CLIENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`invalid_client`		20130626
8	Importing	I_INVALID_GRANT_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`invalid_grant`		20130626
9	Importing	I_INVALID_REQUEST_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`invalid_request`		20130626
10	Importing	I_INVALID_SCOPE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`invalid_scope`		20130626
11	Importing	I_RESPONSE_CODE	Call by reference	☐	Type reference (TYPE)	I			20130626
12	Importing	I_RESPONSE_REASON	Call by reference	☐	Type reference (TYPE)	STRING			20130626
13	Importing	I_UNAUTHORIZED_CLIENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`unauthorized_client`		20130626
14	Importing	I_UNSUPPORTED_GRANT_TYPE_NAME	Call by reference	☐	Type reference (TYPE)	STRING	`unsupported_grant_type`		20130626

#	Exception	Resumable	Description	Created on
1	CX_OA2C_INVALID_CLIENT	☐	OAuth 2.0 Client - Invalid Client Exception	20130626
2	CX_OA2C_INVALID_GRANT	☐	OAuth 2.0 Client - Invalid Grant Exception	20130626
3	CX_OA2C_INVALID_REQUEST	☐	OAuth 2.0 Client - Invalid Request Exception	20130626
4	CX_OA2C_INVALID_SCOPE	☐	OAuth 2.0 Client - Invalid Scope Exception	20130626
5	CX_OA2C_PROTOCOL_EXCEPTION	☐	OAuth 2.0 Client - Protocol Exception	20130626
6	CX_OA2C_UNAUTHORIZED_CLIENT	☐	OAuth 2.0 Client - Unauthorized Client Exception	20130626
7	CX_OA2C_UNSUPPORTED_GRANT_TYPE	☐	OAuth 2.0 Client - Unsupported Response Type Exception	20130626

Method RESPONSE_TO_HTTP_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_FIELDS	Value transfer	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Table Name/Value Pairs	20130626
2	Importing	I_RESPONSE_DATA	Call by reference	☐	Type reference (TYPE)	STRING			20130626

Method RESPONSE_TO_HTTP_FIELDS on class CL_OA2C_CLIENT_PROTOCOL_UTILS has no exception.

History

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