SAP ABAP Class CL_OAUTH2_S_REDIRECT_HANDLER (OAuth 2.0 Redirection URI Handler)

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_REDIRECT_HANDLER
Short Description	OAuth 2.0 Redirection URI Handler
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	20120710	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_REDIRECT_HANDLER has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_OAUTH2_S_AUTH_CONTEXT	☐	20120710	OAuth2 Server Context (Server Impl.)
2	CL_OAUTH2_S_CLIENT	☐	20121112	OAuth2 Client
3	CL_OAUTH2_S_PROT_AUTH_CODE	☐	20120716	OAuth 2.0 Protocol Authorization Grant Type

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_OWNER_AUTH_ENDPOINT	Constant	Private	☐	Type reference (TYPE)	STRING	`AUTHORIZATION`		20120710
2	C_OWNER_CLIENT	Constant	Private	☐	Type reference (TYPE)	STRING	`CLIENT`		20120710
3	C_OWNER_TOKEN_ENDPOINT	Constant	Private	☐	Type reference (TYPE)	STRING	`TOKEN`		20120710
4	M_IS_REDIRECT_URI_VALID	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20120720
5	PO_CLIENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_CLIENT		OAuth2 Client	20120710
6	PT_URI_PARTS	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_URI_PARTS			20120710

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BASIC_CHECKS	Instance method	Private	Method		20120710
2	BUILD_AUTH_CODE_REDIRECT_URI	Instance method	Private	Method		20120814
3	BUILD_ERROR_REDIRECT_URI	Instance method	Private	Method		20120824
4	COMPARE_AUTH_CODE_ACCESS_TOKEN	Instance method	Private	Method		20120712
5	COMPARE_CLIENT_AUTH_CODE	Instance method	Private	Method		20120710
6	CREATE	Static method	Private	Method		20120710
7	GET_REDIRECT_URI	Instance method	Private	Method		20120710
8	IS_REDIRECT_URI_VALID	Instance method	Private	Method		20120720
9	LOAD_CLIENT_URI	Instance method	Private	Method		20120716
10	SET_REDIRECT_URI	Instance method	Private	Method		20120710

Events

Class CL_OAUTH2_S_REDIRECT_HANDLER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_URI_PARTS	Private	See coding			20120710	BEGIN OF ty_s_uri_parts, owner TYPE string, uri TYPE string, scheme TYPE string, authority TYPE string, host TYPE string, port TYPE string, path TYPE string, query TYPE string, fragment TYPE string, segment TYPE string_table, type TYPE i, uri_original TYPE string, END OF ty_s_uri_parts
2	TY_T_URI_PARTS	Private	See coding			20120710	ty_t_uri_parts TYPE STANDARD TABLE OF ty_s_uri_parts

Method Signatures

Method BASIC_CHECKS Signature

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

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

Method BUILD_AUTH_CODE_REDIRECT_URI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_REDIRECT_URI	Value transfer	☐	Type reference (TYPE)	STRING			20120814
2	Importing	I_CODE	Call by reference	☐	Type reference (TYPE)	STRING			20120814
3	Importing	I_STATE	Call by reference	☑	Type reference (TYPE)	STRING			20120814

Method BUILD_AUTH_CODE_REDIRECT_URI on class CL_OAUTH2_S_REDIRECT_HANDLER has no exception.

Method BUILD_ERROR_REDIRECT_URI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_REDIRECT_URI	Value transfer	☐	Type reference (TYPE)	STRING			20120824
2	Importing	I_ERROR	Call by reference	☐	Type reference (TYPE)	STRING			20120824
3	Importing	I_ERROR_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	STRING			20120824
4	Importing	I_STATE	Call by reference	☑	Type reference (TYPE)	STRING			20120824

Method BUILD_ERROR_REDIRECT_URI on class CL_OAUTH2_S_REDIRECT_HANDLER has no exception.

Method COMPARE_AUTH_CODE_ACCESS_TOKEN Signature

Method COMPARE_AUTH_CODE_ACCESS_TOKEN on class CL_OAUTH2_S_REDIRECT_HANDLER has no parameter.

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

Method COMPARE_CLIENT_AUTH_CODE Signature

Method COMPARE_CLIENT_AUTH_CODE on class CL_OAUTH2_S_REDIRECT_HANDLER has no parameter.

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

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_REDIRECT_HANDLER	Value transfer	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_REDIRECT_HANDLER		OAuth 2.0 Redirection URI Handler	20120710

Method CREATE on class CL_OAUTH2_S_REDIRECT_HANDLER has no exception.

Method GET_REDIRECT_URI Signature

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

Method GET_REDIRECT_URI on class CL_OAUTH2_S_REDIRECT_HANDLER has no exception.

Method IS_REDIRECT_URI_VALID Signature

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

Method IS_REDIRECT_URI_VALID on class CL_OAUTH2_S_REDIRECT_HANDLER has no exception.

Method LOAD_CLIENT_URI 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	20120716

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

Method SET_REDIRECT_URI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OWNER	Call by reference	☐	Type reference (TYPE)	STRING			20120710
2	Importing	I_REDIRECT_URI	Call by reference	☐	Type reference (TYPE)	STRING			20120710
3	Importing	I_UNESCAPE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20121031

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

History

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