SAP ABAP Class CL_OAUTH2_S_AUTH_CONTEXT (OAuth2 Server Context (Server Impl.))

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SEC (Application Component) Security
     ⤷ SOAUTH2_AUTH_CODE (Package) OAuth 2.0 Authorization Code

Properties

Class	CL_OAUTH2_S_AUTH_CONTEXT
Short Description	OAuth2 Server Context (Server Impl.)
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SOAUTH2_AUTH_CODE	OAuth 2.0 Authorization Code
Created	20120709	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)
2	CL_OAUTH2_S_TOKEN_MANAGER	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_OAUTH2	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_OAUTH2_S_AUTH_CONTEXT has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_OAUTH2_S_CONTEXT	☐	20121109	OAuth2 Server Context (Server Impl.)
2	CL_OAUTH2_S_PROT_AUTH_CODE	☐	20120723	OAuth 2.0 Protocol Authorization Grant Type
3	CL_OAUTH2_S_TOKEN_MANAGER	☐	20121211	OAuth 2.0 Token Manager

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_DEFAULT_EXPIRY	Constant	Private	☐	Type reference (TYPE)	I	60		20120709
2	C_RANDOM_LENGTH	Constant	Private	☐	Type reference (TYPE)	I	20		20120710
3	C_UUID_LENGTH	Constant	Private	☐	Type reference (TYPE)	I	16		20120710
4	MS_OA2_AC	Instance attribute	Private	☐	Type reference (TYPE)	OA2_SR_A_CTX			20121109
5	MT_OA2_AC_SCOPE	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_OA2_AC_SCOPE			20121109
6	M_AUTH_CODE_B64URL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20121109
7	M_AUTH_CODE_CONTEXT_ID	Instance attribute	Private	☐	Type reference (TYPE)	OA2_S_AUTH_CONTEXT_ID		OAuth 2.0 Authorization Code Context ID	20121109

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_WHERE_CONDITION	Static method	Public	Method		20130104
2	CONVERT_AUTHORIZATION_CODE	Instance method	Private	Method		20120709
3	CONVERT_B64URL	Static method	Private	Method		20120709
4	CONVERT_RANDOM	Instance method	Private	Method		20120709
5	CREATE	Static method	Private	Method		20120709
6	DB_DELETE	Instance method	Private	Method		20121109
7	DB_READ	Instance method	Private	Method		20120709
8	DB_SAVE	Instance method	Private	Method		20120709
9	DECODE_B64URL	Static method	Private	Method		20120709
10	GENERATE	Instance method	Private	Method		20120709
11	GENERATE_AUTH_CODE_PARTS	Instance method	Private	Method		20120710
12	GET_AUTHORIZATION_CODE_CONTEXT	Instance method	Private	Method		20120710
13	INIT	Static method	Private	Method		20121109
14	LOAD	Static method	Private	Method		20120709
15	READ	Instance method	Private	Method		20120709
16	READ_CONTEXT_ASSIGNED_SCOPES	Static method	Private	Method		20121221
17	READ_MULTI	Static method	Private	Method		20121213
18	REVOKE	Static method	Private	Method		20121211

Events

Class CL_OAUTH2_S_AUTH_CONTEXT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_T_OA2_AC_SCOPE	Private	See coding			20120710	ty_t_oa2_ac_scope TYPE STANDARD TABLE OF oa2_sr_a_ctx_sc

Method Signatures

Method BUILD_WHERE_CONDITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NOT_APPLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20130104
2	Exporting	E_WHERE_CONDITION	Call by reference	☐	Type reference (TYPE)	STRING			20130104
3	Importing	IS_REVOCATION	Call by reference	☐	Type reference (TYPE)	CL_OAUTH2_S_TOKEN_MANAGER=>TY_S_REVOCATION			20130104
4	Importing	I_TOKEN_TYPE	Call by reference	☐	Type reference (TYPE)	I			20130104

Method BUILD_WHERE_CONDITION on class CL_OAUTH2_S_AUTH_CONTEXT has no exception.

Method CONVERT_AUTHORIZATION_CODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AUTHORIZATION_CODE	Call by reference	☐	Type reference (TYPE)	STRING			20120709
2	Returning	R_AUTH_CODE_CONTEXT_ID	Value transfer	☐	Type reference (TYPE)	OA2_S_AUTH_CONTEXT_ID			20120710

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120710

Method CONVERT_B64URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AUTHORIZATION_CODE_X	Call by reference	☐	Type reference (TYPE)	XSTRING			20120709
2	Returning	R_AUTHORIZATION_CODE	Value transfer	☐	Type reference (TYPE)	STRING			20120709

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120709

Method CONVERT_RANDOM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_RANDOM	Call by reference	☐	Type reference (TYPE)	XSTRING			20120709
2	Returning	R_RANDOM_HASH	Value transfer	☐	Type reference (TYPE)	XSTRING			20120709

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐	OAuth2 Exception	20120709

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_CLIENT		OAuth2 Client	20120710
2	Importing	IR_SCOPE_COLLECTION	Call by reference	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_SCOPE_COLLECTION		OAuth2 Scope Collection	20120709
3	Importing	I_EXPIRES_IN	Call by reference	☐	Type reference (TYPE)	I			20120709
4	Importing	I_REDIRECT_URI	Call by reference	☐	Type reference (TYPE)	STRING			20120710
5	Importing	I_RO_USER	Call by reference	☐	Type reference (TYPE)	XUBNAME		User Name in User Master Record	20120709
6	Returning	R_R_AUTHORIZATION_CODE	Value transfer	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_AUTH_CONTEXT			20120709

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐	OAuth2 Exception	20120709

Method DB_DELETE Signature

Method DB_DELETE on class CL_OAUTH2_S_AUTH_CONTEXT has no parameter.
Method DB_DELETE on class CL_OAUTH2_S_AUTH_CONTEXT has no exception.

Method DB_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AUTH_CODE_CONTEXT_ID	Call by reference	☐	Type reference (TYPE)	OA2_S_AUTH_CONTEXT_ID			20120710

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120710

Method DB_SAVE Signature

Method DB_SAVE on class CL_OAUTH2_S_AUTH_CONTEXT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐	OAuth2 Exception	20120709

Method DECODE_B64URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AUTHORIZATION_CODE	Call by reference	☐	Type reference (TYPE)	STRING			20120709
2	Returning	R_AUTHORIZATION_CODE_X	Value transfer	☐	Type reference (TYPE)	XSTRING			20120709

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120709

Method GENERATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_CLIENT		OAuth2 Client	20120710
2	Importing	IR_SCOPE_COLLECTION	Call by reference	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_SCOPE_COLLECTION		OAuth2 Scope Collection	20120709
3	Importing	I_EXPIRES_IN	Call by reference	☐	Type reference (TYPE)	I			20120709
4	Importing	I_REDIRECT_URI	Call by reference	☐	Type reference (TYPE)	STRING			20120710
5	Importing	I_RO_USER	Call by reference	☐	Type reference (TYPE)	XUBNAME		User Name in User Master Record	20120709

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐	OAuth2 Exception	20120709

Method GENERATE_AUTH_CODE_PARTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_RANDOM	Call by reference	☐	Type reference (TYPE)	XSTRING			20120710
2	Exporting	E_UUID	Call by reference	☐	Type reference (TYPE)	SYSUUID_X16			20120710

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120710

Method GET_AUTHORIZATION_CODE_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_OA2_AC	Call by reference	☐	Type reference (TYPE)	OA2_SR_A_CTX			20120710
2	Exporting	ET_OA2_AC_SCOPE	Call by reference	☐	Type reference (TYPE)	TY_T_OA2_AC_SCOPE			20120710
3	Exporting	E_AUTH_CODE_B64URL	Call by reference	☐	Type reference (TYPE)	STRING			20121109
4	Exporting	E_AUTH_CODE_CONTEXT	Call by reference	☐	Type reference (TYPE)	OA2_S_AUTH_CONTEXT_ID		OAuth 2.0 Authorization Code Context ID	20121109

Method GET_AUTHORIZATION_CODE_CONTEXT on class CL_OAUTH2_S_AUTH_CONTEXT has no exception.

Method INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AUTHORIZATION_CODE	Call by reference	☐	Type reference (TYPE)	STRING			20121109
2	Returning	R_R_AUTHORIZATION_CODE	Value transfer	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_AUTH_CONTEXT			20121109

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20121109

Method LOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AUTHORIZATION_CODE	Call by reference	☐	Type reference (TYPE)	STRING			20120709
2	Returning	R_R_AUTHORIZATION_CODE	Value transfer	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_AUTH_CONTEXT			20120709

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120710

Method READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AUTHORIZATION_CODE	Call by reference	☐	Type reference (TYPE)	STRING			20120709

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120710

Method READ_CONTEXT_ASSIGNED_SCOPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ASSIGNED_CONTEXTS	Call by reference	☐	Type reference (TYPE)	CL_OAUTH2_S_TOKEN_MANAGER=>TY_T_ASSIGNED_SCOPES		OAuth 2.0 Token Manager	20121221
2	Importing	I_CONTEXT_ID	Call by reference	☐	Type reference (TYPE)	OA2_S_CONTEXT_ID		OAuth 2.0 ServerContext ID	20121221

Method READ_CONTEXT_ASSIGNED_SCOPES on class CL_OAUTH2_S_AUTH_CONTEXT has no exception.

Method READ_MULTI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_TOKEN	Call by reference	☐	Type reference (TYPE)	CL_OAUTH2_S_TOKEN_MANAGER=>TY_T_TOKEN			20121213
2	Importing	IT_REVOCATION	Call by reference	☐	Type reference (TYPE)	CL_OAUTH2_S_TOKEN_MANAGER=>TY_T_REVOCATION			20121213
3	Importing	I_READ_ALL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20121216

Method READ_MULTI on class CL_OAUTH2_S_AUTH_CONTEXT has no exception.

Method REVOKE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_REVOCATION	Call by reference	☐	Type reference (TYPE)	CL_OAUTH2_S_TOKEN_MANAGER=>TY_T_REVOCATION			20121211

Method REVOKE on class CL_OAUTH2_S_AUTH_CONTEXT has no exception.

History

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