SAP ABAP Class CL_OAUTH2_S_TOKEN_MANAGER (OAuth 2.0 Token Manager)

Hierarchy

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

Properties

Class	CL_OAUTH2_S_TOKEN_MANAGER
Short Description	OAuth 2.0 Token Manager
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SOAUTH2	OAuth2
Created	20121210	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)
2	RSDS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_OAUTH2_S_TOKEN_MANAGER has no interface implemented.

Friends

Class CL_OAUTH2_S_TOKEN_MANAGER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_REVOCATION_MODE_ADMIN	Constant	Public	☐	Type reference (TYPE)	STRING	`ADMIN`		20130104
2	C_REVOCATION_MODE_USER	Constant	Public	☐	Type reference (TYPE)	STRING	``		20130104
3	C_TOKEN_TYPE	Constant	Public	☐	See coding				20121212
4	C_TOKEN_TYPE_STRING	Constant	Public	☐	See coding				20121213

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_MODE	Static method	Public	Method		20130108
2	GET_TOKEN_TYPE_DESCRIPTION	Static method	Public	Method		20130109
3	READ	Static method	Public	Method		20121213
4	READ_CONTEXT_ASSIGNED_SCOPES	Static method	Public	Method		20121221
5	REVOKE	Static method	Public	Method		20121210
6	REVOKE_CLIENT	Static method	Public	Method		20130108
7	REVOKE_INT	Static method	Private	Method		20130108

Events

Class CL_OAUTH2_S_TOKEN_MANAGER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_ASSIGNED_SCOPES	Public	See coding			20121221	BEGIN OF ty_s_assigned_scopes, scope_id TYPE oa2_s_sc_id, scope_desc TYPE oa2_s_sc_desc, END OF ty_s_assigned_scopes
2	TY_S_MSG	Public	See coding			20121220	BEGIN OF ty_s_msg, msgid TYPE symsgid, msgty TYPE symsgty, msgno TYPE symsgno, msgv1 TYPE symsgv, msgv2 TYPE symsgv, msgv3 TYPE symsgv, msgv4 TYPE symsgv, END OF ty_s_msg
3	TY_S_REVOCATION	Public	See coding			20121210	BEGIN OF ty_s_revocation, client_id TYPE oa2_s_cl_id, ro_user TYPE xubname, creation_low TYPE oa2_s_time_creation, creation_high TYPE oa2_s_time_creation, expiry_low TYPE oa2_s_time_expiry, expiry_high TYPE oa2_s_time_expiry, t_token_type TYPE STANDARD TABLE OF i WITH NON-UNIQUE DEFAULT KEY, context_c TYPE oa2_s_context_id_c, END OF ty_s_revocation
4	TY_S_TOKEN	Public	See coding			20121213	BEGIN OF ty_s_token, ro_user TYPE xubname, client_id TYPE oa2_s_cl_id, context_type TYPE oa2_s_context_type, creation_time TYPE oa2_s_time_creation, expiry_time TYPE oa2_s_time_expiry, context_c TYPE oa2_s_context_id_c, class TYPE usr02-class, context_type_i TYPE i, END OF ty_s_token
5	TY_T_ASSIGNED_SCOPES	Public	See coding			20121221	ty_t_assigned_scopes TYPE STANDARD TABLE OF ty_s_assigned_scopes WITH NON-UNIQUE DEFAULT KEY
6	TY_T_MSG	Public	See coding			20121220	ty_t_msg TYPE STANDARD TABLE OF ty_s_msg WITH NON-UNIQUE DEFAULT KEY
7	TY_T_REVOCATION	Public	See coding			20121210	ty_t_revocation TYPE STANDARD TABLE OF ty_s_revocation WITH NON-UNIQUE DEFAULT KEY
8	TY_T_TOKEN	Public	See coding			20121213	ty_t_token TYPE STANDARD TABLE OF ty_s_token WITH NON-UNIQUE KEY context_c

Method Signatures

Method CHECK_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MODE	Call by reference	☐	Type reference (TYPE)	STRING			20130108
2	Returning	R_MODE	Value transfer	☐	Type reference (TYPE)	STRING			20130108

Method CHECK_MODE on class CL_OAUTH2_S_TOKEN_MANAGER has no exception.

Method GET_TOKEN_TYPE_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TOKEN_TYPE	Call by reference	☐	Type reference (TYPE)	I			20130109
2	Returning	R_DESCRIPTION	Value transfer	☐	Type reference (TYPE)	STRING			20130109

Method GET_TOKEN_TYPE_DESCRIPTION on class CL_OAUTH2_S_TOKEN_MANAGER has no exception.

Method READ 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)	TY_T_TOKEN			20121213
2	Exporting	ET_MSG	Call by reference	☐	Type reference (TYPE)	TY_T_MSG			20121220
3	Importing	IT_REVOCATION	Call by reference	☐	Type reference (TYPE)	TY_T_REVOCATION			20121213
4	Importing	I_MODE	Call by reference	☐	Type reference (TYPE)	STRING	C_REVOCATION_MODE_USER		20130104
5	Importing	I_READ_ALL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20121214

Method READ on class CL_OAUTH2_S_TOKEN_MANAGER 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)	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
3	Importing	I_CONTEXT_TYPE	Call by reference	☐	Type reference (TYPE)	I			20121221

Method READ_CONTEXT_ASSIGNED_SCOPES on class CL_OAUTH2_S_TOKEN_MANAGER has no exception.

Method REVOKE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MSG	Call by reference	☐	Type reference (TYPE)	TY_T_MSG			20121220
2	Importing	IT_REVOCATION	Call by reference	☐	Type reference (TYPE)	TY_T_REVOCATION			20121210
3	Importing	I_MODE	Call by reference	☐	Type reference (TYPE)	STRING	C_REVOCATION_MODE_USER		20130104

Method REVOKE on class CL_OAUTH2_S_TOKEN_MANAGER has no exception.

Method REVOKE_CLIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MSG	Call by reference	☐	Type reference (TYPE)	TY_T_MSG			20130108
2	Importing	I_CLIENT_ID	Call by reference	☐	Type reference (TYPE)	OA2_S_CL_ID		OAuth 2.0 Client ID	20130108

Method REVOKE_CLIENT on class CL_OAUTH2_S_TOKEN_MANAGER has no exception.

Method REVOKE_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MSG	Call by reference	☐	Type reference (TYPE)	TY_T_MSG			20130108
2	Importing	IT_REVOCATION	Call by reference	☐	Type reference (TYPE)	TY_T_REVOCATION			20130108

Method REVOKE_INT on class CL_OAUTH2_S_TOKEN_MANAGER has no exception.

History

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