SAP ABAP Class CL_CLB_OAUTH (SAIL: oAuth Helper)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-STW (Application Component) Social Media ABAP Integration Library
     ⤷ S_CLB_CONNECT (Package) Connectivity Layer of the Collaboration Platform Library

Properties

Class	CL_CLB_OAUTH
Short Description	SAIL: oAuth Helper
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_CLB_CONNECT	Connectivity Layer of the Collaboration Platform Library
Created	20110805	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_CLB_OAUTH has no forward declaration.

Interfaces

Class CL_CLB_OAUTH has no interface implemented.

Friends

Class CL_CLB_OAUTH has no friend class.

Attributes

Class CL_CLB_OAUTH has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_AUTH_BODY	Instance method	Public	Method	Set oAuth w/ SAMLResponse into body	20111212
2	GET_HMAC_SIGNATURE	Instance method	Public	Method	Get a HMAC signature	20111212
3	GET_PT_SIGNATURE	Instance method	Public	Method	Get a PLAINTEXT signature for calls w/o user context	20111212
4	GET_SHA1_SIGNATURE	Instance method	Public	Method	Get an RSA-SHA1 signature for calls w/o user context	20111212
5	GET_SHA1_SIGNATURE_T	Instance method	Public	Method	Get an RSA-SHA1 signature for calls w/o user context	20111212
6	SET_HTTP_HEADER	Instance method	Public	Method	Enable oAuth method with HTTP client	20110805
7	SIGN_SIGNATURE	Instance method	Protected	Method	Encrypt the signature	20110805

Events

Class CL_CLB_OAUTH has no event.

Types

Class CL_CLB_OAUTH has no local type.

Method Signatures

Method GET_AUTH_BODY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PARAMS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Table Name/Value Pairs	20111212
2	Returning	RV_XBODY	Value transfer	☐	Type reference (TYPE)	XSTRING		HTTP client Body	20111212

Method GET_AUTH_BODY on class CL_CLB_OAUTH has no exception.

Method GET_HMAC_SIGNATURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ALGORITHM	Call by reference	☐	Type reference (TYPE)	STRING	'SHA1'		20111212
2	Importing	IV_PLAINTEXT_SIG	Call by reference	☐	Type reference (TYPE)	STRING		PLAINTEXT signature	20111212
3	Importing	IV_SIG_BASE_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Signature base string	20111212
4	Returning	RV_SIGNATURE	Value transfer	☐	Type reference (TYPE)	STRING		Signature, not escaped	20111212

Method GET_HMAC_SIGNATURE on class CL_CLB_OAUTH has no exception.

Method GET_PT_SIGNATURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONSUMER_SECRET	Call by reference	☐	Type reference (TYPE)	STRING		Key of the administrative application	20111212
2	Importing	IV_TOKEN_SECRET	Call by reference	☐	Type reference (TYPE)	STRING		Nonce value	20111212
3	Returning	RV_SIGNATURE	Value transfer	☐	Type reference (TYPE)	STRING		Signed signature	20111212

Method GET_PT_SIGNATURE on class CL_CLB_OAUTH has no exception.

Method GET_SHA1_SIGNATURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_SIGNATURE	Call by reference	☐	Type reference (TYPE)	STRING		Signed signature	20111212
2	Exporting	E_UNIX_TIMESTAMP	Call by reference	☐	Type reference (TYPE)	STRING		Unix conform timestamp used to create the signature	20111212
3	Importing	I_CONSUMER_KEY	Call by reference	☐	Type reference (TYPE)	CLB_CONSUMER_KEY		Key of the administrative application	20111212
4	Importing	I_DESTINATION_URL	Call by reference	☐	Type reference (TYPE)	STRING		Target of the signature	20111212
5	Importing	I_METHOD	Call by reference	☐	Type reference (TYPE)	CLB_REQUEST_METHOD	IF_CLB_CONSTANTS=>GC_REQUEST_METHOD-POST	Communication method	20111212
6	Importing	I_NAME1	Call by reference	☑	Type reference (TYPE)	STRING			20111212
7	Importing	I_NAME2	Call by reference	☑	Type reference (TYPE)	STRING			20111212
8	Importing	I_NONCE	Call by reference	☐	Type reference (TYPE)	STRING		Nonce value	20111212
9	Importing	I_SSFAPPL	Call by reference	☐	Type reference (TYPE)	SSFAPPL		SSF Application	20111212
10	Importing	I_VALUE1	Call by reference	☑	Type reference (TYPE)	STRING			20111212
11	Importing	I_VALUE2	Call by reference	☑	Type reference (TYPE)	STRING			20111212

Method GET_SHA1_SIGNATURE on class CL_CLB_OAUTH has no exception.

Method GET_SHA1_SIGNATURE_T Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_SIGNATURE	Call by reference	☐	Type reference (TYPE)	STRING		Signed signature	20111212
2	Exporting	E_UNIX_TIMESTAMP	Call by reference	☐	Type reference (TYPE)	STRING		Unix conform timestamp used to create the signature	20111212
3	Exporting	E_UNSIG_SIGNATURE	Call by reference	☐	Type reference (TYPE)	STRING		Unsigned signature	20111212
4	Importing	IT_PARAMS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Table Name/Value Pairs	20111212
5	Importing	I_DESTINATION_URL	Call by reference	☐	Type reference (TYPE)	STRING		Target of the signature	20111212
6	Importing	I_METHOD	Call by reference	☐	Type reference (TYPE)	CLB_REQUEST_METHOD	IF_CLB_CONSTANTS=>GC_REQUEST_METHOD-POST	Communication method	20111212
7	Importing	I_NAME1	Call by reference	☑	Type reference (TYPE)	STRING			20111212
8	Importing	I_NAME2	Call by reference	☑	Type reference (TYPE)	STRING			20111212
9	Importing	I_SSFAPPL	Call by reference	☐	Type reference (TYPE)	SSFAPPL		SSF Application	20111212
10	Importing	I_VALUE1	Call by reference	☑	Type reference (TYPE)	STRING			20111212
11	Importing	I_VALUE2	Call by reference	☑	Type reference (TYPE)	STRING			20111212

Method GET_SHA1_SIGNATURE_T on class CL_CLB_OAUTH has no exception.

Method SET_HTTP_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	IO_CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_CLIENT		HTTP Client Abstraction	20110905
2	Importing	IT_PARAMS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Table Name/Value Pairs	20110805

Method SET_HTTP_HEADER on class CL_CLB_OAUTH has no exception.

Method SIGN_SIGNATURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SIGNATURE	Call by reference	☐	Type reference (TYPE)	STRING		Plain signature	20110805
2	Importing	I_SSFAPPL	Call by reference	☐	Type reference (TYPE)	SSFAPPL		SSF Application	20110805
3	Returning	R_SIGNED_DATA	Value transfer	☐	Type reference (TYPE)	STRING		Encrypted signature ready to use	20110805

Method SIGN_SIGNATURE on class CL_CLB_OAUTH has no exception.

History

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