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

Hierarchy

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

Properties

Class	CL_OAUTH2_S_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	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)
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_CONTEXT has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_OAUTH2_S_PROT_AUTH_CODE	☐	20121022	OAuth 2.0 Protocol Authorization Grant Type
2	CL_OAUTH2_S_PROT_SAML2	☐	20111012	OAuth2 Protocol SAML2 Grant Type
3	CL_OAUTH2_S_RESOURCE_SERVER	☐	20120124	OAuth2 Resource Server (Server Implementation, Runtime)
4	CL_OAUTH2_S_TOKEN_MANAGER	☐	20121210	OAuth 2.0 Token Manager

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	PS_ACCESS_TOKEN	Instance attribute	Private	☐	Type reference (TYPE)	IF_OAUTH2=>TY_S_ACCESS_TOKEN			20111011
2	PS_OA_AT	Instance attribute	Private	☐	Type reference (TYPE)	OA2_SR_CTX		OAuth2 ServerContext (Server Implementation, Runtime)	20111011
3	PT_OA_AT_SCOPE	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_OA_AT_SCOPE			20111011
4	P_ACCESS_TOKEN_X	Instance attribute	Private	☐	Type reference (TYPE)	XSTRING			20111014
5	P_MANDT	Instance attribute	Private	☐	Attribute reference (LIKE)	SY-MANDT		Client ID of Current User	20111102

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_WHERE_CONDITION	Static method	Public	Method		20130104
2	CONSTRUCTOR	Instance method	Private	Constructor		20111011
3	CONVERT_ACCESS_TOKEN	Static method	Public	Method		20111011
4	CONVERT_B64URL	Static method	Public	Method		20111014
5	CONVERT_RANDOM	Static method	Private	Method		20111014
6	CREATE	Static method	Private	Method		20111011
7	DB_READ	Instance method	Private	Method		20111011
8	DB_SAVE	Instance method	Private	Method		20111011
9	DELETE_FROM_AUTH_CODE_CTX	Static method	Private	Method		20121109
10	FILL_ACCESS_TOKEN	Instance method	Private	Method		20111011
11	GENERATE	Instance method	Private	Method		20111011
12	GENERATE_TOKEN_PARTS	Instance method	Private	Method		20111014
13	GET_ACCESS_TOKEN	Instance method	Private	Method		20111011
14	LOAD	Static method	Private	Method		20111011
15	READ	Instance method	Private	Method		20111011
16	READ_CONTEXT_ASSIGNED_SCOPES	Static method	Private	Method		20121221
17	READ_MULTI	Static method	Private	Method		20121213
18	REVOKE	Static method	Private	Method		20121210

Events

Class CL_OAUTH2_S_CONTEXT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_T_OA_AT_SCOPE	Private	See coding			20111011	ty_t_oa_at_scope TYPE STANDARD TABLE OF OA2_SR_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_CONTEXT has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SCOPE	Call by reference	☑	Type reference (TYPE)	STRING_TABLE			20111011
2	Importing	I_CLIENT_ID	Call by reference	☑	Type reference (TYPE)	STRING			20111011
3	Importing	I_EXPIRES_IN	Call by reference	☐	Type reference (TYPE)	I	3600		20111011
4	Importing	I_MANDT	Call by reference	☐	Attribute reference (LIKE)	SY-MANDT		Client ID of Current User	20111102
5	Importing	I_RO_USER	Call by reference	☑	Type reference (TYPE)	XUBNAME			20111011
6	Importing	I_TOKEN_TYPE	Call by reference	☐	Type reference (TYPE)	STRING	IF_OAUTH2=>C_ACCESS_TOKEN_TYPE_BEARER		20111011
7	Importing	I_WITH_REFRESH_TOKEN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20111011

Method CONSTRUCTOR on class CL_OAUTH2_S_CONTEXT has no exception.

Method CONVERT_ACCESS_TOKEN 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			20111011
2	Returning	R_CONTEXT_ID	Value transfer	☐	Type reference (TYPE)	STRING			20111011

Method CONVERT_ACCESS_TOKEN on class CL_OAUTH2_S_CONTEXT has no exception.

Method CONVERT_B64URL Signature

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

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

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			20111014
2	Returning	R_RANDOM_HASH	Value transfer	☐	Type reference (TYPE)	XSTRING			20111014

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

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_AUTH_CODE_CTX	Call by reference	☑	Object reference (TYPE REF TO)	CL_OAUTH2_S_AUTH_CONTEXT		OAuth2 Server Context (Server Impl.)	20121109
2	Importing	IR_SCOPE_COLLECTION	Call by reference	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_SCOPE_COLLECTION		OAuth2 Scope Collection	20111011
3	Importing	I_CLIENT_ID	Call by reference	☑	Type reference (TYPE)	STRING			20111011
4	Importing	I_EXPIRES_IN	Call by reference	☐	Type reference (TYPE)	I	3600		20111011
5	Importing	I_MANDT	Call by reference	☐	Attribute reference (LIKE)	SY-MANDT		Client ID of Current User	20111102
6	Importing	I_RO_USER	Call by reference	☑	Type reference (TYPE)	XUBNAME		User Name in User Master Record	20111011
7	Importing	I_TOKEN_TYPE	Call by reference	☐	Type reference (TYPE)	STRING	IF_OAUTH2=>C_ACCESS_TOKEN_TYPE_BEARER		20111011
8	Importing	I_WITH_REFRESH_TOKEN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20111011
9	Returning	R_R_ACCESS_TOKEN	Value transfer	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_CONTEXT		OAuth2 Access Token	20111011

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

Method DB_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AT_CONTEXT_ID	Call by reference	☐	Type reference (TYPE)	OA2_S_CONTEXT_ID		OAuth2 Access Token Context ID	20111011

Method DB_READ on class CL_OAUTH2_S_CONTEXT has no exception.

Method DB_SAVE Signature

Method DB_SAVE on class CL_OAUTH2_S_CONTEXT has no parameter.

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

Method DELETE_FROM_AUTH_CODE_CTX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_AUTH_CODE_CTX	Call by reference	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_AUTH_CONTEXT		OAuth2 Server Context (Server Impl.)	20121109

Method DELETE_FROM_AUTH_CODE_CTX on class CL_OAUTH2_S_CONTEXT has no exception.

Method FILL_ACCESS_TOKEN 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			20111011
2	Importing	I_EXPIRES_IN	Call by reference	☐	Type reference (TYPE)	I	3600		20111011
3	Importing	I_TOKEN_TYPE	Call by reference	☐	Type reference (TYPE)	CSEQUENCE	IF_OAUTH2=>C_ACCESS_TOKEN_TYPE_BEARER		20111011
4	Importing	I_WITH_REFRESH_TOKEN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20111011

Method FILL_ACCESS_TOKEN on class CL_OAUTH2_S_CONTEXT has no exception.

Method GENERATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_AUTH_CODE_CTX	Call by reference	☑	Object reference (TYPE REF TO)	CL_OAUTH2_S_AUTH_CONTEXT		OAuth2 Server Context (Server Impl.)	20121109
2	Importing	IR_SCOPE_COLLECTION	Call by reference	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_SCOPE_COLLECTION		OAuth2 Scope Collection	20111011
3	Importing	I_CLIENT_ID	Call by reference	☑	Type reference (TYPE)	STRING			20111011
4	Importing	I_EXPIRES_IN	Call by reference	☐	Type reference (TYPE)	I	3600		20111011
5	Importing	I_RO_USER	Call by reference	☑	Type reference (TYPE)	XUBNAME		User Name in User Master Record	20111011
6	Importing	I_TOKEN_TYPE	Call by reference	☐	Type reference (TYPE)	STRING	IF_OAUTH2=>C_ACCESS_TOKEN_TYPE_BEARER		20111011
7	Importing	I_WITH_REFRESH_TOKEN	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20111011

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

Method GENERATE_TOKEN_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			20111014
2	Exporting	E_UUID	Call by reference	☐	Type reference (TYPE)	SYSUUID_X16			20111014

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

Method GET_ACCESS_TOKEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_ACCESS_TOKEN	Value transfer	☐	Type reference (TYPE)	IF_OAUTH2=>TY_S_ACCESS_TOKEN			20111011

Method GET_ACCESS_TOKEN on class CL_OAUTH2_S_CONTEXT has no exception.

Method LOAD 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			20111011
2	Importing	I_MANDT	Call by reference	☐	Attribute reference (LIKE)	SY-MANDT		Client ID of Current User	20111102
3	Returning	R_R_ACCESS_TOKEN	Value transfer	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_CONTEXT		OAuth2 Access Token	20111011

Method LOAD on class CL_OAUTH2_S_CONTEXT has no exception.

Method READ 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			20111011

Method READ on class CL_OAUTH2_S_CONTEXT has no exception.

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_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_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			20121210

Method REVOKE on class CL_OAUTH2_S_CONTEXT has no exception.

History

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