SAP ABAP Class CL_OAUTH2_S_CLIENT (OAuth2 Client)

Hierarchy

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

Properties

Class	CL_OAUTH2_S_CLIENT
Short Description	OAuth2 Client
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SOAUTH2	OAuth2
Created	20111012	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_SCOPE_COLLECTION	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_CLIENT has no interface implemented.

Friends

Class CL_OAUTH2_S_CLIENT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_AUTHCODE_LIFETIME_DEFAULT	Constant	Public	☐	Type reference (TYPE)	I	60		20121115
2	C_MODE_CREATE	Constant	Public	☐	Type reference (TYPE)	TY_MODE	'CREATE'		20120326
3	C_MODE_DELETE	Constant	Public	☐	Type reference (TYPE)	TY_MODE	'DELETE'		20120326
4	C_MODE_DISPLAY	Constant	Public	☐	Type reference (TYPE)	TY_MODE	'DISPLAY'		20120320
5	C_MODE_EDIT	Constant	Public	☐	Type reference (TYPE)	TY_MODE	'EDIT'		20120320
6	C_STATE_CHANGED	Constant	Public	☐	Type reference (TYPE)	C	'C'		20120319
7	C_STATE_NEW	Constant	Public	☐	Type reference (TYPE)	C	'N'		20120319
8	C_STATE_SAVED	Constant	Public	☐	Type reference (TYPE)	C	'S'		20120319
9	C_TEST_DOUBLE	Constant	Private	☐	Type reference (TYPE)	STRING	`LTD_OAUTH2_CLIENT_DB_ACCESSOR`		20120604
10	C_TOKEN_LIFETIME_DEFAULT	Constant	Public	☐	Type reference (TYPE)	I	3600		20120320
11	C_USTYP_SYSTEM	Constant	Private	☐	Type reference (TYPE)	C	'B'		20120403
12	MO_STATIC_DB_ACCESSOR_CLASS	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20120403
13	MS_CLIENT	Instance attribute	Private	☐	Type reference (TYPE)	OA2_SD_CL			20120403
14	MT_CLIENTT	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_CLIENTT			20120403
15	MT_CLIENT_SCOPE	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_CLIENT_SCOPE			20120403
16	MT_R_CLIENT	Static Attribute	Private	☐	Type reference (TYPE)	TY_TR_CLIENT			20120403
17	M_CLIENT_ID	Instance attribute	Private	☐	Type reference (TYPE)	OA2_S_CL_ID			20120403
18	M_MANDT	Instance attribute	Private	☐	Attribute reference (LIKE)	SY-MANDT			20120403
19	M_MODE	Instance attribute	Private	☐	Type reference (TYPE)	TY_MODE			20120403
20	M_STATE	Instance attribute	Private	☐	Type reference (TYPE)	C			20120403

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ASSIGN_MULTIPLE_SCOPES	Instance method	Public	Method		20120326
2	ASSIGN_SCOPE	Instance method	Public	Method		20111012
3	CHECK	Instance method	Public	Method		20111125
4	CHECK_AUTHORITY	Instance method	Private	Method		20120403
5	CHECK_AUTH_CODE_SETTINGS	Instance method	Private	Method		20121121
6	CHECK_CCC_ALLOWED	Static method	Private	Method		20120427
7	CHECK_CLIENT_AUTHENTICATION	Instance method	Public	Method		20120427
8	CHECK_CLIENT_CRED_USER	Instance method	Public	Method		20111219
9	CHECK_CLIENT_DESCRIPTION	Instance method	Private	Method		20130102
10	CHECK_CLIENT_TYPE	Instance method	Private	Method		20120320
11	CHECK_CLIENT_USER_PWD_STATE	Instance method	Public	Method		20120419
12	CHECK_EXISTS_ON_DB	Instance method	Private	Method		20120403
13	CHECK_LENGTH	Static method	Private	Method		20111118
14	CHECK_SAML_OAUTH_IDP	Instance method	Private	Method		20120403
15	CHECK_SCOPE	Instance method	Private	Method		20120326
16	CHECK_TOKEN_LIFETIME	Instance method	Private	Method		20120403
17	CONSTRUCTOR	Instance method	Private	Constructor		20111012
18	CREATE	Static method	Public	Method		20120326
19	DB_DELETE	Instance method	Private	Method		20120403
20	DB_READ	Instance method	Private	Method		20120403
21	DB_SAVE	Instance method	Private	Method		20120403
22	DELETE	Static method	Public	Method		20120320
23	DELETE_INT	Instance method	Private	Method		20120320
24	DEQUEUE	Instance method	Private	Method		20120326
25	DISCARD	Instance method	Public	Method		20120321
26	ENQUEUE	Instance method	Private	Method		20120326
27	GET_CLIENT_LIST	Static method	Public	Method		20120320
28	GET_DESCRIPTION	Instance method	Public	Method		20120423
29	GET_INFO	Instance method	Public	Method		20120314
30	GET_SAML_OAUTH_IDP	Instance method	Public	Method		20120105
31	GET_SYSTEM_CLIENT_EDIT	Static method	Private	Method		20120503
32	INIT	Instance method	Private	Method		20120326
33	IS_CLIENT_USER_AUTHENTICATED	Instance method	Public	Method		20120717
34	IS_CLIENT_USER_EXISTING	Instance method	Public	Method		20120719
35	IS_CLIENT_USER_LOGGED_ON	Instance method	Public	Method		20120719
36	LOAD	Static method	Public	Method		20111012
37	MAINTAIN	Static method	Public	Method		20120315
38	REMOVE_ALL_SCOPES	Instance method	Public	Method		20120411
39	REMOVE_SCOPE	Instance method	Public	Method		20111102
40	SAVE	Instance method	Public	Method		20111012
41	SET_AUTH_CODE_SETTINGS	Instance method	Public	Method		20121121
42	SET_CLIENT_AUTHENTICATION	Instance method	Public	Method		20120403
43	SET_CLIENT_TYPE	Instance method	Public	Method		20111114
44	SET_CONFIG	Instance method	Public	Method		20111013
45	SET_DEFAULTS	Instance method	Private	Method		20120326
46	SET_DESCRIPTION	Instance method	Public	Method		20111012
47	SET_SAML_SETTINGS	Instance method	Public	Method		20120403
48	SET_TOKEN_LIFETIME	Instance method	Public	Method		20120403
49	SWITCH_MODE	Instance method	Public	Method		20120320
50	TRANSPORT	Instance method	Public	Method		20120503

Events

Class CL_OAUTH2_S_CLIENT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_MODE	Public	See coding			20120320	ty_mode TYPE c LENGTH 10
2	TY_SR_CLIENT	Public	See coding			20111031	BEGIN OF ty_sr_client, client_id TYPE oa2_s_cl_id, r_client TYPE REF TO cl_oauth2_s_client, END OF ty_sr_client
3	TY_S_CLIENT_CONFIG	Public	See coding			20111031	BEGIN OF ty_s_client_config, client_type TYPE oa2_s_ct, gt_samlbearer_is_active TYPE oa2_s_gt_samlbearer_is_active, gt_samlbearer_oauth_sts TYPE oa2_s_gt_samlbearer_oauth_sts, gt_samlbearer_idp_name TYPE oa2_s_gt_samlbearer_idp_name, gt_samlbearer_require_clnt_id TYPE oa2_sg_gt_samlbearer_req_clnt, client_user TYPE oa2_s_cl_user, token_lifetime_in_secs TYPE oa2_s_token_lifetime, client_auth_basic TYPE oa2_s_cl_auth_basic, client_auth_cert TYPE oa2_s_cl_auth_certificate, gt_authcode_is_active TYPE oa2_s_gt_authcode_is_active, gt_authcode_redirecturi TYPE oa2_s_gt_authcode_redirect_uri, authcode_lifetime type oa2_s_authcode_lifetime, END OF ty_s_client_config
4	TY_S_CLIENT_LIST	Public	See coding			20120320	BEGIN OF ty_s_client_list, client_id TYPE oa2_s_cl_id, client_type TYPE oa2_s_ct, gt_samlbearer_is_active TYPE oa2_s_gt_samlbearer_is_active, gt_authcode_is_active TYPE oa2_s_gt_authcode_is_active, mtext TYPE c LENGTH 40, END OF ty_s_client_list
5	TY_TR_CLIENT	Public	See coding			20111031	ty_tr_client TYPE STANDARD TABLE OF ty_sr_client
6	TY_T_CLIENTT	Public	See coding			20111012	ty_t_clientt TYPE STANDARD TABLE OF oa2_sd_clt WITH DEFAULT KEY
7	TY_T_CLIENT_LIST	Public	See coding			20120320	ty_t_client_list TYPE STANDARD TABLE OF ty_s_client_list
8	TY_T_CLIENT_SCOPE	Public	See coding			20111012	ty_t_client_scope TYPE STANDARD TABLE OF OA2_SD_CL_SC WITH DEFAULT KEY
9	TY_T_SCOPE	Public	Type reference (TYPE)	CL_OAUTH2_S_SCOPE_COLLECTION=>TY_T_SCOPE		20120326

Method Signatures

Method ASSIGN_MULTIPLE_SCOPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SCOPES	Call by reference	☐	Type reference (TYPE)	TY_T_SCOPE			20120326

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120403

Method ASSIGN_SCOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SCOPE	Call by reference	☐	Type reference (TYPE)	OA2_S_SC_ID		OAuth2 Scope ID	20111012

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

Method CHECK Signature

Method CHECK on class CL_OAUTH2_S_CLIENT has no parameter.

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

Method CHECK_AUTHORITY 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)	TY_MODE			20120403
2	Importing	I_WITHOUT_AUTHORITY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120403

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_MSG_EXCEPTION	☐		20120403

Method CHECK_AUTH_CODE_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AUTHCODE_REDIRECT_URI	Call by reference	☑	Type reference (TYPE)	OA2_S_GT_AUTHCODE_REDIRECT_URI		OAuth 2.0 Grant Type Auth. Code: Redirect URI of the Client	20121121
2	Importing	I_AUTH_CODE_ACTIVE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20121121
3	Importing	I_AUTH_CODE_LIFETIME	Call by reference	☑	Type reference (TYPE)	OA2_S_AUTHCODE_LIFETIME		OAuth 2.0 Authorization Code Lifetime in seconds	20121121

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

Method CHECK_CCC_ALLOWED Signature

Method CHECK_CCC_ALLOWED on class CL_OAUTH2_S_CLIENT has no parameter.

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

Method CHECK_CLIENT_AUTHENTICATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BASIC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120427
2	Importing	I_CLIENT_CERT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120427

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120427

Method CHECK_CLIENT_CRED_USER Signature

Method CHECK_CLIENT_CRED_USER on class CL_OAUTH2_S_CLIENT has no parameter.

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

Method CHECK_CLIENT_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	OA2_SD_CLT-MTEXT		OAuth 2.0 Client Description	20130102

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20130102

Method CHECK_CLIENT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_TYPE	Call by reference	☐	Type reference (TYPE)	OA2_SD_CL-CLIENT_TYPE			20120403

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120320

Method CHECK_CLIENT_USER_PWD_STATE Signature

Method CHECK_CLIENT_USER_PWD_STATE on class CL_OAUTH2_S_CLIENT has no parameter.

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

Method CHECK_EXISTS_ON_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_ID	Call by reference	☐	Type reference (TYPE)	OA2_S_CL_ID			20120403
2	Importing	I_MANDT	Call by reference	☐	Type reference (TYPE)	SY-MANDT	SY-MANDT		20120403
3	Returning	R_EXISTS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120403

Method CHECK_EXISTS_ON_DB on class CL_OAUTH2_S_CLIENT has no exception.

Method CHECK_LENGTH Signature

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

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

Method CHECK_SAML_OAUTH_IDP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_IDP_KEY	Call by reference	☐	Type reference (TYPE)	OA2_S_GT_SAMLBEARER_OAUTH_STS			20120403
2	Importing	I_IDP_NAME	Call by reference	☐	Type reference (TYPE)	OA2_S_GT_SAMLBEARER_IDP_NAME			20120403
3	Importing	I_SAML_ACTIVE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20120412

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120403

Method CHECK_SCOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SCOPE	Call by reference	☐	Type reference (TYPE)	OA2_S_SC_ID			20120326

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120326

Method CHECK_TOKEN_LIFETIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TOKEN_LIFETIME	Call by reference	☐	Type reference (TYPE)	OA2_S_TOKEN_LIFETIME			20120403

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120403

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_ID	Call by reference	☐	Type reference (TYPE)	OA2_S_CL_ID		OAuth2 Client ID	20111012
2	Importing	I_MANDT	Call by reference	☐	Type reference (TYPE)	SY-MANDT		Client ID of Current User	20111206
3	Importing	I_MODE	Call by reference	☐	Type reference (TYPE)	TY_MODE			20120320
4	Importing	I_WITHOUT_AUTHORITY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120323

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

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_ID	Call by reference	☐	Type reference (TYPE)	OA2_S_CL_ID			20120326
2	Returning	R_R_CLIENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_CLIENT			20120326

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120326

Method DB_DELETE Signature

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

Method DB_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_CLIENT	Call by reference	☐	Type reference (TYPE)	OA2_SD_CL			20120403
2	Exporting	ET_CLIENTT	Call by reference	☐	Type reference (TYPE)	TY_T_CLIENTT			20120403
3	Exporting	ET_CLIENT_SCOPE	Call by reference	☐	Type reference (TYPE)	TY_T_CLIENT_SCOPE			20120403
4	Importing	I_CLIENT_ID	Call by reference	☐	Type reference (TYPE)	OA2_S_CL_ID			20120403
5	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	LANG	SY-LANGU		20120403
6	Importing	I_MANDT	Call by reference	☐	Type reference (TYPE)	SY-MANDT			20120403

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120403

Method DB_SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_WRITE_CD	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120403

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120403

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_ID	Call by reference	☐	Type reference (TYPE)	OA2_S_CL_ID		OAuth2 Client ID	20120320

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

Method DELETE_INT Signature

Method DELETE_INT on class CL_OAUTH2_S_CLIENT has no parameter.

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

Method DEQUEUE Signature

Method DEQUEUE on class CL_OAUTH2_S_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120326

Method DISCARD Signature

Method DISCARD on class CL_OAUTH2_S_CLIENT has no parameter.

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

Method ENQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_WITHOUT_ENQUEUE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120326

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120326

Method GET_CLIENT_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CLIENT_LIST	Call by reference	☐	Type reference (TYPE)	TY_T_CLIENT_LIST			20120320

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

Method GET_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_DESCRIPTION	Value transfer	☐	Type reference (TYPE)	OA2_SD_CLT-MTEXT			20120423
2	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	LANGU	SY-LANGU		20120423

Method GET_DESCRIPTION on class CL_OAUTH2_S_CLIENT has no exception.

Method GET_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_CLIENT	Call by reference	☐	Type reference (TYPE)	OA2_SD_CL		OAuth2 Client (Server Implementation, Designtime)	20120314
2	Exporting	ET_CLIENTT	Call by reference	☐	Type reference (TYPE)	TY_T_CLIENTT			20120314
3	Exporting	ET_CLIENT_SCOPE	Call by reference	☐	Type reference (TYPE)	TY_T_CLIENT_SCOPE			20120314
4	Exporting	ET_CLIENT_SCOPE_S	Call by reference	☐	Type reference (TYPE)	CL_OAUTH2_S_SCOPE_COLLECTION=>TY_T_SCOPE			20120319
5	Exporting	E_AUTHCODE_LIFETIME	Call by reference	☐	Type reference (TYPE)	OA2_SD_CL-AUTHCODE_LIFETIME		OAuth 2.0 Authorization Code Lifetime in seconds	20121116
6	Exporting	E_CLIENT_ID	Call by reference	☐	Type reference (TYPE)	OA2_S_CL_ID		OAuth2 Client ID	20120314
7	Exporting	E_CLIENT_TYPE	Call by reference	☐	Type reference (TYPE)	OA2_SD_CL-CLIENT_TYPE		OAuth2 Client Type	20120319
8	Exporting	E_CLIENT_USER	Call by reference	☐	Type reference (TYPE)	OA2_SD_CL-CLIENT_USER		OAuth2 Client Username	20120319
9	Exporting	E_IS_AUTH_CODE_ACTIVE	Call by reference	☐	Type reference (TYPE)	OA2_SD_CL-GT_AUTHCODE_IS_ACTIVE		OAuth 2.0 Grant-Type Auth.-Code: Enabled? (Server Impl.)	20120716
10	Exporting	E_IS_SAML_ACTIVE	Call by reference	☐	Type reference (TYPE)	OA2_SD_CL-GT_SAMLBEARER_IS_ACTIVE		Grant Type SAML2 Bearer active?	20120319
11	Exporting	E_MANDT	Call by reference	☐	Type reference (TYPE)	SY-MANDT			20120403
12	Exporting	E_MODE	Call by reference	☐	Type reference (TYPE)	TY_MODE			20120320
13	Exporting	E_REDIRECT_URI	Call by reference	☐	Type reference (TYPE)	STRING			20120710
14	Exporting	E_REQUIRE_CLNT_ID	Call by reference	☐	Type reference (TYPE)	OA2_SG_GT_SAMLBEARER_REQ_CLNT		Require client_id attribute in SAML assertion	20121022
15	Exporting	E_STATE	Call by reference	☐	Type reference (TYPE)	C			20120314
16	Exporting	E_TOKEN_LIFETIME	Call by reference	☐	Type reference (TYPE)	OA2_SD_CL-TOKEN_LIFETIME_IN_SECS		OAuth2 Access Token Lifetime in Seconds	20120319

Method GET_INFO on class CL_OAUTH2_S_CLIENT has no exception.

Method GET_SAML_OAUTH_IDP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_SAML_OAUTH_IDP	Call by reference	☐	Object reference (TYPE REF TO)	CL_SAML20_ENTITY		SAML20 Entity Object	20120113
2	Exporting	E_SAML_OAUTH_IDP	Call by reference	☐	Type reference (TYPE)	OA2_S_GT_SAMLBEARER_OAUTH_STS		OAuth2 SAML2 Bearer IdP	20120105
3	Exporting	E_SAML_OAUTH_IDP_NAME	Call by reference	☐	Type reference (TYPE)	OA2_S_GT_SAMLBEARER_IDP_NAME			20120105

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

Method GET_SYSTEM_CLIENT_EDIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_AUTOMATIC_RECORDING	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120503
2	Exporting	E_CCC_ALLOWED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Changes and transports for client-specific objects	20120503
3	Exporting	E_TRANSPORTS_ALLOWED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120503

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

Method INIT Signature

Method INIT on class CL_OAUTH2_S_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120326

Method IS_CLIENT_USER_AUTHENTICATED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_IS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120717

Method IS_CLIENT_USER_AUTHENTICATED on class CL_OAUTH2_S_CLIENT has no exception.

Method IS_CLIENT_USER_EXISTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_IS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120719

Method IS_CLIENT_USER_EXISTING on class CL_OAUTH2_S_CLIENT has no exception.

Method IS_CLIENT_USER_LOGGED_ON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_IS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120719

Method IS_CLIENT_USER_LOGGED_ON on class CL_OAUTH2_S_CLIENT has no exception.

Method LOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_ID	Call by reference	☐	Type reference (TYPE)	STRING			20111012
2	Importing	I_MANDT	Call by reference	☐	Type reference (TYPE)	SY-MANDT	SY-MANDT	Client ID of Current User	20111206
3	Returning	R_R_CLIENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_CLIENT		OAuth2 Client	20111012

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

Method MAINTAIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_ID	Call by reference	☐	Type reference (TYPE)	OA2_S_CL_ID		OAuth2 Client ID	20120315
2	Importing	I_MODE	Call by reference	☐	Type reference (TYPE)	TY_MODE	CL_OAUTH2_S_CLIENT=>C_MODE_EDIT		20120320
3	Returning	R_R_CLIENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_CLIENT		OAuth2 Client	20120315

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

Method REMOVE_ALL_SCOPES Signature

Method REMOVE_ALL_SCOPES on class CL_OAUTH2_S_CLIENT has no parameter.
Method REMOVE_ALL_SCOPES on class CL_OAUTH2_S_CLIENT has no exception.

Method REMOVE_SCOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SCOPE	Call by reference	☐	Type reference (TYPE)	OA2_S_SC_ID		OAuth2 Scope ID	20111102

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

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TRKORR	Call by reference	☑	Type reference (TYPE)	TRKORR		Request/Task	20120503
2	Importing	I_WRITE_CD	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120126

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

Method SET_AUTH_CODE_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AUTH_CODE_ACTIVE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20121121
2	Importing	I_AUTH_CODE_LIFETIME	Call by reference	☑	Type reference (TYPE)	OA2_S_AUTHCODE_LIFETIME		OAuth 2.0 Authorization Code Lifetime in seconds	20121121
3	Importing	I_REDIRECT_URI	Call by reference	☑	Type reference (TYPE)	OA2_S_GT_AUTHCODE_REDIRECT_URI		OAuth 2.0 Grant Type Auth. Code: Redirect URI of the Client	20121121

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

Method SET_CLIENT_AUTHENTICATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BASIC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120403
2	Importing	I_CLIENT_CERT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120403

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120403

Method SET_CLIENT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_TYPE	Call by reference	☐	Type reference (TYPE)	OA2_S_CT		OAuth2 Client Type	20111114

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

Method SET_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CONFIG	Call by reference	☐	Type reference (TYPE)	TY_S_CLIENT_CONFIG		OAuth2 Client (Server Implementation, Designtime)	20111013

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

Method SET_DEFAULTS Signature

Method SET_DEFAULTS on class CL_OAUTH2_S_CLIENT has no parameter.
Method SET_DEFAULTS on class CL_OAUTH2_S_CLIENT has no exception.

Method SET_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	OA2_SD_CLT-MTEXT		Description	20111012
2	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	LANGU	SY-LANGU	Language Key	20111012

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

Method SET_SAML_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_IDP_KEY	Call by reference	☑	Type reference (TYPE)	OA2_S_GT_SAMLBEARER_OAUTH_STS			20120403
2	Importing	I_IDP_NAME	Call by reference	☐	Type reference (TYPE)	OA2_S_GT_SAMLBEARER_IDP_NAME			20120403
3	Importing	I_REQUIRE_CLNT_ID	Call by reference	☑	Type reference (TYPE)	OA2_SG_GT_SAMLBEARER_REQ_CLNT			20121024
4	Importing	I_SAML_ACTIVE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120403

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120403

Method SET_TOKEN_LIFETIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TOKEN_LIFETIME	Call by reference	☐	Type reference (TYPE)	OA2_S_TOKEN_LIFETIME			20120403

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120403

Method SWITCH_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)	TY_MODE			20120326

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

Method TRANSPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NO_POPUP	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20120503
2	Importing	I_TRKORR	Call by reference	☑	Type reference (TYPE)	TRKORR		Request/Task	20120503

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

History

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