SAP ABAP Class CL_OA2C_CLIENT (OAuth 2.0 Client)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_OAUTH2_CLIENT	OAuth 2.0 Client	20130417

Properties

Class	CL_OA2C_CLIENT
Short Description	OAuth 2.0 Client
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SOAUTH2_CLIENT	OAuth 2.0 Client
Created	20130417	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
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	Abstract	Final	Description	Created on
1	IF_OAUTH2_CLIENT	☐	☐	OAuth 2.0 Client	20130417

Friends

Class CL_OA2C_CLIENT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_SECSTORE_ACCESS_TOKEN	Constant	Public	☐	Type reference (TYPE)	STRING	`AT`		20130624
2	C_SECSTORE_NAMESPACE	Constant	Public	☐	Type reference (TYPE)	STRING	`/OA2C/`		20130624
3	C_SECSTORE_REFRESH_TOKEN	Constant	Public	☐	Type reference (TYPE)	STRING	`RT`		20130624
4	MO_OA2C_AUTH_CODE_GRANT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_OA2C_AUTH_CODE_GRANT		OAuth 2.0 Client - Authorization Code Grant	20130613
5	MO_OA2C_CONFIG_READER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_OA2C_CONFIG_READER			20130506
6	MO_OA2C_REFRESH_GRANT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_OA2C_REFRESH_GRANT		OAuth 2.0 Refresh Grant	20130628
7	MO_OA2C_SPECIFICS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_OA2C_SPECIFICS		OAuth 2.0 Service Provider Specifics	20130611
8	MS_ENDPOINTS	Instance attribute	Private	☐	Type reference (TYPE)	TY_S_ENDPOINTS			20130611

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_CALLER_AUTHORITY	Static method	Private	Method		20130628
2	CONSTRUCTOR	Instance method	Private	Constructor		20130417
3	CREATE	Static method	Public	Method		20130614
4	DB_COMMIT	Instance method	Private	Method		20130625
5	DB_ROLLBACK	Instance method	Private	Method		20130626
6	DELETE_TOKENS	Instance method	Public	Method		20130624
7	EXECUTE_REVOCATION_FLOW	Instance method	Public	Method	Execute Revocation Flow	20130502
8	GET_SECSTORE_IDENT	Instance method	Private	Method		20130624
9	GET_SECSTORE_REPACLIST	Instance method	Private	Method		20130625
10	HANDLE_AUTHORIZATION_RESPONSE	Instance method	Public	Method	Handle Authorization Response	20130418
11	INIT_ENDPOINT_SETTINGS	Instance method	Private	Method		20130611
12	INIT_OA2C_SPECIFICS	Instance method	Private	Method		20130611
13	INSERT_TOKENS	Instance method	Private	Method		20130624
14	PREPARE_AUTHORIZATION_REQUEST	Instance method	Public	Method	Build Authorization Request URL	20130418
15	READ_TOKEN	Instance method	Private	Method		20130924

Events

Class CL_OA2C_CLIENT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_ENDPOINTS	Private	See coding			20130611	BEGIN OF ty_s_endpoints, cloud_endpoints TYPE abap_bool, authorization_endpoint TYPE string, token_endpoint TYPE string, revocation_endpoint TYPE string, END OF ty_s_endpoints

Method Signatures

Method CHECK_CALLER_AUTHORITY Signature

Method CHECK_CALLER_AUTHORITY on class CL_OA2C_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_OA2C_CALLER_NOT_AUTHORIZED	☐	OAuth 2.0 Client - Not Allowed Exception	20130628

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_UUID	Call by reference	☑	Type reference (TYPE)	OA2C_UUID		OAuth 2.0 Client UUID	20130506
2	Importing	I_SPS_IMPLEMENTATION_NAME	Call by reference	☑	Type reference (TYPE)	OA2C_SPS_IMPLEMENTATION_NAME			20130506

Method CONSTRUCTOR on class CL_OA2C_CLIENT has no exception.

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_UUID	Call by reference	☑	Type reference (TYPE)	OA2C_UUID		OAuth 2.0 Client UUID	20130614
2	Importing	I_SPS_IMPLEMENTATION_NAME	Call by reference	☑	Type reference (TYPE)	OA2C_SPS_IMPLEMENTATION_NAME		Service Provider Specifics (SPS) Implementation Name	20130614
3	Returning	RO_OA2C_CLIENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_OA2C_CLIENT		OAuth 2.0 Client	20130614

#	Exception	Resumable	Description	Created on
1	CX_OA2C_CALLER_NOT_AUTHORIZED	☐	OAuth 2.0 Client - Not Allowed Exception	20130628

Method DB_COMMIT Signature

Method DB_COMMIT on class CL_OA2C_CLIENT has no parameter.
Method DB_COMMIT on class CL_OA2C_CLIENT has no exception.

Method DB_ROLLBACK Signature

Method DB_ROLLBACK on class CL_OA2C_CLIENT has no parameter.
Method DB_ROLLBACK on class CL_OA2C_CLIENT has no exception.

Method DELETE_TOKENS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACCOUNT_UUID	Call by reference	☐	Type reference (TYPE)	OA2C_ACCOUNT_UUID		OAuth 2.0 Client Account UUID	20130628
2	Importing	I_CLIENT_UUID	Call by reference	☐	Type reference (TYPE)	OA2C_UUID		OAuth 2.0 Client UUID	20130628
3	Importing	I_MANDT	Call by reference	☐	Type reference (TYPE)	MANDT		Client	20130628
4	Importing	I_UNAME	Call by reference	☐	Type reference (TYPE)	XUBNAME		User Name in User Master Record	20130628

Method DELETE_TOKENS on class CL_OA2C_CLIENT has no exception.

Method EXECUTE_REVOCATION_FLOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REVOKE_ACCESS_TOKEN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20130502
2	Importing	I_REVOKE_REFRESH_TOKEN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20130502

Method EXECUTE_REVOCATION_FLOW on class CL_OA2C_CLIENT has no exception.

Method GET_SECSTORE_IDENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TOKEN_TYPE	Call by reference	☐	Attribute reference (LIKE)	C_SECSTORE_ACCESS_TOKEN			20130624
2	Returning	R_SECSTORE_IDENT	Value transfer	☐	Type reference (TYPE)	RSECID		ID of Record in Secure Storage	20130624

Method GET_SECSTORE_IDENT on class CL_OA2C_CLIENT has no exception.

Method GET_SECSTORE_REPACLIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_REPACLIST	Value transfer	☐	Type reference (TYPE)	RSECABAC_T		Table with ABAP Access Rights	20130625

Method GET_SECSTORE_REPACLIST on class CL_OA2C_CLIENT has no exception.

Method HANDLE_AUTHORIZATION_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_OA2C_STATE	Call by reference	☐	Object reference (TYPE REF TO)	CL_OA2C_STATE		OAuth 2.0 Client State	20130611
2	Importing	IO_SERVER	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20130418
3	Importing	IT_URL_PARAMETERS	Call by reference	☑	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Table Name/Value Pairs	20130613

#	Exception	Resumable	Description	Created on
1	CX_OA2C_ACCESS_DENIED	☐	OAuth 2.0 Client - Access Denied Exception	20130613
2	CX_OA2C_BADI_IMPLEMENTATION	☐	OAuth 2.0 Client BAdI Impl. Error	20130611
3	CX_OA2C_INVALID_CLIENT	☐	OAuth 2.0 Client - Invalid Client Exception	20130614
4	CX_OA2C_INVALID_GRANT	☐	OAuth 2.0 Client - Invalid Grant Exception	20130614
5	CX_OA2C_INVALID_PARAMETERS	☐	OAuth 2.0 Client Runtime - Invalid Parameters.	20130614
6	CX_OA2C_INVALID_REQUEST	☐	OAuth 2.0 Client - Invalid Request Exception	20130613
7	CX_OA2C_INVALID_SCOPE	☐	OAuth 2.0 Client - Invalid Scope Exception	20130613
8	CX_OA2C_PROTOCOL_EXCEPTION	☐	OAuth 2.0 Client - Protocol Exception	20130614
9	CX_OA2C_SERVER_ERROR	☐	OAuth 2.0 Client - Server Error Exception	20130613
10	CX_OA2C_TEMPORARILY_UNAVAIL	☐	OAuth 2.0 Client - Temporarily Unavailable Exception	20130613
11	CX_OA2C_UNAUTHORIZED_CLIENT	☐	OAuth 2.0 Client - Unauthorized Client Exception	20130613
12	CX_OA2C_UNSUPPORTED_GRANT_TYPE	☐	OAuth 2.0 Client - Unsupported Response Type Exception	20130614
13	CX_OA2C_UNSUPP_RESPONSE_TYPE	☐	OAuth 2.0 Client - Unsupported Response Type Exception	20130613

Method INIT_ENDPOINT_SETTINGS Signature

Method INIT_ENDPOINT_SETTINGS on class CL_OA2C_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_OA2C_BADI_IMPLEMENTATION	☐	OAuth 2.0 Client BAdI Impl. Error	20130611

Method INIT_OA2C_SPECIFICS Signature

Method INIT_OA2C_SPECIFICS on class CL_OA2C_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_OA2C_BADI_IMPLEMENTATION	☐	OAuth 2.0 Client BAdI Impl. Error	20130611

Method INSERT_TOKENS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACCESS_TOKEN	Call by reference	☐	Type reference (TYPE)	STRING			20130624
2	Importing	I_ACCOUNT_UUID	Call by reference	☐	Type reference (TYPE)	OA2C_ACCOUNT_UUID		OAuth 2.0 Client Account UUID	20130625
3	Importing	I_CLIENT_UUID	Call by reference	☐	Type reference (TYPE)	OA2C_UUID		OAuth 2.0 Client UUID	20130624
4	Importing	I_EXPIRES_IN	Call by reference	☐	Type reference (TYPE)	I			20130625
5	Importing	I_MANDT	Call by reference	☑	Type reference (TYPE)	MANDT		Client ID	20130624
6	Importing	I_REFRESH_TOKEN	Call by reference	☐	Type reference (TYPE)	STRING			20130624
7	Importing	I_UNAME	Call by reference	☐	Type reference (TYPE)	XUBNAME		User Name in User Master Record	20130624

#	Exception	Resumable	Description	Created on
1	CX_PARAMETER_INVALID_RANGE	☐	Parameter with Invalid Range	20130625
2	CX_PARAMETER_INVALID_TYPE	☐	Parameter with Invalid Type	20130625

Method PREPARE_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			20130418
2	Importing	I_ESCAPE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20130613

#	Exception	Resumable	Description	Created on
1	CX_OA2C_BADI_IMPLEMENTATION	☐	OAuth 2.0 Client BAdI Impl. Error	20130611
2	CX_OA2C_CONFIG_INCONSISTENT	☐	OAuth 2.0 Client Configuration Inconsistent	20130614
3	CX_OA2C_NOT_ALLOWED	☐	OAuth 2.0 Client - Not Allowed Exception	20130611
4	CX_OA2C_NOT_SUPPORTED	☐	OAuth 2.0 Client - Not Supported Exception	20130611
5	CX_OA2C_STATE_DB_SAVE	☐	Error writing state value to DB.	20130613
6	CX_OA2C_STATE_GENERATION	☐	Error generating state value.	20130613

Method READ_TOKEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_TOKEN	Call by reference	☐	Type reference (TYPE)	STRING			20130924
2	Importing	I_ACCOUNT_UUID	Call by reference	☐	Type reference (TYPE)	OA2C_ACCOUNT_UUID			20130924
3	Importing	I_CLIENT_UUID	Call by reference	☐	Type reference (TYPE)	OA2C_UUID			20130924
4	Importing	I_TOKEN_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20130924
5	Importing	I_UNAME	Call by reference	☐	Type reference (TYPE)	XUBNAME			20130924

Method READ_TOKEN on class CL_OA2C_CLIENT has no exception.

History

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