SAP ABAP Class CL_OAUTH2_S_RESOURCE_SERVER (OAuth2 Resource Server (Server Implementation, Runtime))

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SEC (Application Component) Security
     ⤷ SOAUTH2 (Package) OAuth2

Properties

Class	CL_OAUTH2_S_RESOURCE_SERVER
Short Description	OAuth2 Resource Server (Server Implementation, Runtime)
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SOAUTH2	OAuth2
Created	20111011	SAP
Last change	20130531	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

Class CL_OAUTH2_S_RESOURCE_SERVER has no interface implemented.

Friends

Class CL_OAUTH2_S_RESOURCE_SERVER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_DEFAULT_WHTLST_ENTRY	Constant	Private	☐	Type reference (TYPE)	ICF_HAND	'CL_OAUTH2_TST_CONSUMER_IF_IMPL'		20111110
2	C_RESOURCE_REQUEST_AUTH_BEARER	Constant	Private	☐	Type reference (TYPE)	STRING	`Bearer`		20111021
3	C_STEP_0_INITIAL	Constant	Private	☐	Type reference (TYPE)	I	0		20111122
4	C_STEP_1_ISAPP_FALSE	Constant	Private	☐	Type reference (TYPE)	I	2		20111122
5	C_STEP_1_ISAPP_TRUE	Constant	Private	☐	Type reference (TYPE)	I	1		20111122
6	C_STEP_2_VALBEARER_FALSE	Constant	Private	☐	Type reference (TYPE)	I	4		20111124
7	C_STEP_2_VALBEARER_TRUE	Constant	Private	☐	Type reference (TYPE)	I	3		20111124
8	C_STEP_3_CHKSCOPE_FALSE	Constant	Private	☐	Type reference (TYPE)	I	6		20111124
9	C_STEP_3_CHKSCOPE_TRUE	Constant	Private	☐	Type reference (TYPE)	I	5		20111124
10	C_STEP_IN_PROCESS	Constant	Private	☐	Type reference (TYPE)	I	-1		20111125
11	M_CLIENT_ID	Static Attribute	Private	☐	Type reference (TYPE)	OA2_S_CL_ID		OAuth2 Client ID	20111206
12	M_EXCEPTION	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CX_OAUTH2_EXCEPTION			20111122
13	M_HANDLER_NAME	Static Attribute	Private	☐	Type reference (TYPE)	ICF_HAND		Name of ICF Handler	20111228
14	M_HTTP_REQUEST	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST			20111123
15	M_HTTP_RESPONSE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_HTTP_RESPONSE			20111123
16	M_LANGUAGE	Static Attribute	Private	☐	Attribute reference (LIKE)	SY-LANGU		Language Key of Current Text Environment	20111213
17	M_MANDT	Static Attribute	Private	☐	Attribute reference (LIKE)	SY-MANDT			20111206
18	M_RO_USER	Static Attribute	Private	☐	Attribute reference (LIKE)	SY-UNAME		User Name	20120522
19	M_STEP	Static Attribute	Private	☐	Type reference (TYPE)	I			20111122
20	M_TEST_MODE	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Determines if Resource Server is in Test Mode.	20120127
21	M_VALID_ACCESS_TOKEN_DB	Static Attribute	Private	☐	Type reference (TYPE)	OA2_S_CONTEXT_ID			20111027
22	M_WHITELIST	Static Attribute	Private	☐	See coding			Whitelist of accepted OAuth-using frameworks	20111102

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ASSEMBLE_SERVER_CONTEXT_ID	Static method	Private	Method		20111026
2	CHECK_SCOPE	Static method	Public	Method	Compare granted scopes with scope required for request	20111027
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20111102
4	GET_HANDLER_NAME	Static method	Public	Method	Name of class implementing OAuth consumer interface	20111228
5	GET_SINGLE_HEADER_FIELD	Static method	Private	Method		20111019
6	INVALIDATE_CONTEXT_TAB_BUFFER	Static method	Private	Method	Invalidate table buffer of OA2_SR_CTX and OA2_SR_CTX_SC	20120120
7	IS_APPLICABLE	Static method	Public	Method	Check whether ICF service can use OAuth authentication	20111122
8	PERSONALIZE_SESSION	Static method	Private	Method	Personalize session (perform user account checks)	20111213
9	RENDER_ERROR_RESPONSE	Static method	Public	Method	Render OAuth-specific http error response	20111124
10	VALIDATE_BEARER	Static method	Public	Method	Get OAuth Access Token from request and validate	20111027

Events

Class CL_OAUTH2_S_RESOURCE_SERVER has no event.

Types

Class CL_OAUTH2_S_RESOURCE_SERVER has no local type.

Method Signatures

Method ASSEMBLE_SERVER_CONTEXT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ACCESS_TOKEN_DB	Call by reference	☐	Type reference (TYPE)	OA2_S_CONTEXT_ID			20111026
2	Importing	I_ACCESS_TOKEN_B64_CHECK	Call by reference	☐	Type reference (TYPE)	STRING			20111031

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20111026

Method CHECK_SCOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OAUTH_CONSUMER	Call by reference	☐	Object reference (TYPE REF TO)	IF_OAUTH2_CONSUMER			20111027
2	Returning	R_AUTHORIZED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20111230

Method CHECK_SCOPE on class CL_OAUTH2_S_RESOURCE_SERVER has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_OAUTH2_S_RESOURCE_SERVER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_OAUTH2_S_RESOURCE_SERVER has no exception.

Method GET_HANDLER_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ICF_HAND		Name of ICF Handler	20111228

Method GET_HANDLER_NAME on class CL_OAUTH2_S_RESOURCE_SERVER has no exception.

Method GET_SINGLE_HEADER_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_HEADER_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20111026
2	Returning	R_HEADER_FIELD	Value transfer	☐	Type reference (TYPE)	IHTTPVAL			20111230

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20111019

Method INVALIDATE_CONTEXT_TAB_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MANDT	Call by reference	☐	Type reference (TYPE)	MANDT		Client	20120120
2	Importing	SERVER_CONTEXT_ID	Call by reference	☐	Type reference (TYPE)	OA2_S_CONTEXT_ID		OAuth2 ServerContext ID	20120120

Method INVALIDATE_CONTEXT_TAB_BUFFER on class CL_OAUTH2_S_RESOURCE_SERVER has no exception.

Method IS_APPLICABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_HANDLER_LIST	Call by reference	☐	Type reference (TYPE)	ICFHANDTBL			20111122
2	Returning	R_APPLICABLE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120102

Method IS_APPLICABLE on class CL_OAUTH2_S_RESOURCE_SERVER has no exception.

Method PERSONALIZE_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	AUTH_RC	Call by reference	☐	Type reference (TYPE)	SYSUBRC		Return Value of Kernel Logon Method	20111213
2	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	SYMANDT		ABAP Client ID	20111213
3	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU		Language Key	20111213
4	Exporting	PWDSTATE	Call by reference	☐	Type reference (TYPE)	XUPWDSTATE		Status of User Password (Value: -2/-1/0/1/2/3, see doc.)	20111213
5	Importing	USERID	Call by reference	☐	Type reference (TYPE)	SYUNAME		ABAP User ID	20111213

#	Exception	Resumable	Description	Created on
1	CX_PERSONALIZE_SESSION	☐	Exception class for authentication methods (caller problems)	20120705

Method RENDER_ERROR_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EXCEPTION	Call by reference	☑	Object reference (TYPE REF TO)	CX_OAUTH2_EXCEPTION		OAuth2 Exception	20120203

Method RENDER_ERROR_RESPONSE on class CL_OAUTH2_S_RESOURCE_SERVER has no exception.

Method VALIDATE_BEARER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_AUTH_RC	Call by reference	☐	Type reference (TYPE)	SYSUBRC		Return Value of ABAP Statements	20111228
2	Exporting	E_PWDSTATE	Call by reference	☐	Type reference (TYPE)	XUPWDSTATE		Status of User Password (Value: -2/-1/0/1/2/3, see doc.)	20111228
3	Importing	I_CLIENT	Call by reference	☐	Type reference (TYPE)	SY-MANDT			20111230
4	Importing	I_HTTP_SERVER	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Request	20120116
5	Importing	I_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SY-LANGU			20111230

Method VALIDATE_BEARER on class CL_OAUTH2_S_RESOURCE_SERVER has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	732