SAP ABAP Class CL_BS_SOA_IDP_UTIL (Idempotency util class for Exactly-Once behaviour)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-SOA (Application Component) Enterprise SOA
     ⤷ BS_SOA_REUSE_COMMON_OBJECTS (Package) Business Suite SOA: Reuseable Tools and Objects

Properties

Class	CL_BS_SOA_IDP_UTIL
Short Description	Idempotency util class for Exactly-Once behaviour
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	BS_SOA_REUSE_COMMON_OBJECTS	Business Suite SOA: Reuseable Tools and Objects
Created	20081124	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_BS_SOA_IDP_UTIL has no forward declaration.

Interfaces

Class CL_BS_SOA_IDP_UTIL has no interface implemented.

Friends

Class CL_BS_SOA_IDP_UTIL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_FLT_CLASS	Constant	Public	☐	Type reference (TYPE)	CLASSNAME	'CX_AI_APPLICATION_FAULT'	Reference type	20090319
2	CO_IDP_CHECK_RESULT	Constant	Public	☐	See coding				20081129
3	GT_INSTANCES	Static Attribute	Protected	☐	Type reference (TYPE)	TT_INSTANCE			20081125
4	MO_IDP_HELPER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_WS_IDP_HELPER		API Interface for Idempotent WS Service	20081125
5	MO_PATH	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_BS_SOA_PATH_COMMON		Path for field access of BDMH and LOG	20090810
6	MV_EXCEPTION_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	PRX_R3NAME		Object Type Name	20090807
7	MV_IDP_IS_REQUESTED	Instance attribute	Protected	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20090213
8	MV_MSG_GUID	Instance attribute	Protected	☐	Type reference (TYPE)	SYSUUID_C		UUID in character form	20081125
9	MV_MSG_ID	Instance attribute	Protected	☐	Type reference (TYPE)	TY_MSG_ID		CHAR60 data element for SYST	20081125
10	MV_WAIT_TIME	Instance attribute	Protected	☐	Type reference (TYPE)	TY_WAIT_TIME			20090213

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_LOG_ITEM	Instance method	Protected	Method	Add message to log item	20081129
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20081125
3	CONVERT_UUID	Static method	Protected	Method	Convert Content of UUID to memory Message GUID	20091029
4	CREATE_RESPONSE	Instance method	Protected	Method	Create response message	20081129
5	FINALIZE_EO	Instance method	Public	Method	Excatly-once: store response in idempotency framework	20081124
6	GET_INSTANCE	Static method	Public	Method	Return IDP helper instance	20081125
7	GET_PATH	Instance method	Public	Method	Get path object	20090810
8	OVERWRITE_PATH	Instance method	Public	Method	Overwrite default path	20081125
9	OVERWRITE_WAIT_TIME	Instance method	Public	Method	Overwrite default wait time	20090213
10	PREPARE	Instance method	Protected	Method	Exactly-once check	20081129
11	PREPARE_EO	Instance method	Public	Method	Exactly-once: check, if message already processed	20081124
12	RAISE_FAULT	Instance method	Protected	Method	Raise fault exception	20090319
13	REFRESH_MEMORY	Instance method	Protected	Method	Refresh memory	20081125
14	REMOVE_INSTANCE	Static method	Public	Method	Remove instance	20081129
15	SET_EXCEPTION_CLASS	Instance method	Public	Method	Set Standard Fault Exception class name	20090807
16	THROW_T100_FROM_EX	Instance method	Protected	Method	Throw message from T100 exception	20081124

Events

Class CL_BS_SOA_IDP_UTIL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TT_INSTANCE	Protected	See coding			20081125	tt_instance TYPE STANDARD TABLE OF ty_instance
2	TT_PATH	Public	See coding			20081124	tt_path TYPE STANDARD TABLE OF ty_path
3	TY_IDP_CHECK_RESULT	Public	See coding			20081129	ty_idp_check_result(1) TYPE c
4	TY_INSTANCE	Protected	See coding			20081125	BEGIN OF ty_instance, xi_guid TYPE sxmsmguid, instance TYPE REF TO cl_bs_soa_idp_util, END OF ty_instance
5	TY_MSG_ID	Protected	See coding			20081124	ty_msg_id(60) TYPE c
6	TY_PATH	Public	See coding			20081124	BEGIN OF ty_path, element(10) TYPE c, path TYPE string, END OF ty_path
7	TY_WAIT_TIME	Public	Type reference (TYPE)	F		20090213

Method Signatures

Method ADD_LOG_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_OUTPUT	Call by reference	☐	Type reference (TYPE)	ANY			20081129

Method ADD_LOG_ITEM on class CL_BS_SOA_IDP_UTIL has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXCEPTION_NAME	Call by reference	☑	Type reference (TYPE)	PRX_R3NAME		Reference type	20090807
2	Importing	IV_NOSC_BDMH	Call by reference	☐	Type reference (TYPE)	BOOLEAN	' '	Boolean Variable (X=True, -=False, Space=Unknown)	20090224

Method CONSTRUCTOR on class CL_BS_SOA_IDP_UTIL has no exception.

Method CONVERT_UUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_UUID_CONTENT	Call by reference	☐	Type reference (TYPE)	DATA			20091029
2	Returning	RV_MSG_GUID	Value transfer	☐	Type reference (TYPE)	SYSUUID_C		UUID in character form	20091029

#	Exception	Resumable	Description	Created on
1	CX_BS_SOA_EXCEPTION	☐	Error message occurred	20091029

Method CREATE_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CR_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20081129

Method CREATE_RESPONSE on class CL_BS_SOA_IDP_UTIL has no exception.

Method FINALIZE_EO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_OUTPUT	Call by reference	☐	Type reference (TYPE)	ANY			20081124
2	Exporting	EV_IDP_CHECK_RESULT	Call by reference	☐	Type reference (TYPE)	TY_IDP_CHECK_RESULT			20081129

Method FINALIZE_EO on class CL_BS_SOA_IDP_UTIL has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PATH	Call by reference	☑	Type reference (TYPE)	TT_PATH			20081125
2	Importing	IV_EXCEPTION_NAME	Call by reference	☑	Type reference (TYPE)	PRX_R3NAME		Proxy Generation: Name of an Object in R/3	20090820
3	Importing	IV_NOSC_BDMH	Call by reference	☐	Type reference (TYPE)	BOOLEAN	' '	Boolean Variable (X=True, -=False, Space=Unknown)	20090224
4	Importing	IV_WAIT_TIME	Call by reference	☑	Type reference (TYPE)	TY_WAIT_TIME			20090213
5	Importing	IV_XI_GUID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message ID	20081125
6	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_BS_SOA_IDP_UTIL		Idempotency util class for Exactly-Once behaviour	20081125

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Integration: Application Error	20081125

Method GET_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_PATH	Value transfer	☐	Object reference (TYPE REF TO)	CL_BS_SOA_PATH_COMMON		Path for field access of BDMH and LOG	20090810

Method GET_PATH on class CL_BS_SOA_IDP_UTIL has no exception.

Method OVERWRITE_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PATH	Call by reference	☐	Type reference (TYPE)	TT_PATH			20081125

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Integration: Application Error	20081125

Method OVERWRITE_WAIT_TIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_WAIT_TIME	Call by reference	☐	Type reference (TYPE)	TY_WAIT_TIME			20090213

Method OVERWRITE_WAIT_TIME on class CL_BS_SOA_IDP_UTIL has no exception.

Method PREPARE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_IDP_CHECK_RESULT	Call by reference	☐	Type reference (TYPE)	TY_IDP_CHECK_RESULT			20081129
2	Importing	IS_INPUT	Call by reference	☐	Type reference (TYPE)	ANY			20081129

#	Exception	Resumable	Description	Created on
1	IDP_EXCEPTION	☐	IDP framework produced exception	20090319
2	PROCESSING_STOPPED	☐	Message already processed	20081129

Method PREPARE_EO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_OUTPUT	Call by reference	☐	Type reference (TYPE)	ANY			20081124
2	Exporting	EV_IDP_CHECK_RESULT	Call by reference	☐	Type reference (TYPE)	TY_IDP_CHECK_RESULT			20081129
3	Importing	IS_INPUT	Call by reference	☐	Type reference (TYPE)	ANY			20081124

Method PREPARE_EO on class CL_BS_SOA_IDP_UTIL has no exception.

Method RAISE_FAULT Signature

Method RAISE_FAULT on class CL_BS_SOA_IDP_UTIL has no parameter.
Method RAISE_FAULT on class CL_BS_SOA_IDP_UTIL has no exception.

Method REFRESH_MEMORY Signature

Method REFRESH_MEMORY on class CL_BS_SOA_IDP_UTIL has no parameter.
Method REFRESH_MEMORY on class CL_BS_SOA_IDP_UTIL has no exception.

Method REMOVE_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_XI_GUID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message ID	20081129

Method REMOVE_INSTANCE on class CL_BS_SOA_IDP_UTIL has no exception.

Method SET_EXCEPTION_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXCEPTION_NAME	Call by reference	☐	Type reference (TYPE)	PRX_R3NAME		Boolean Variable (X=True, -=False, Space=Unknown)	20090807

Method SET_EXCEPTION_CLASS on class CL_BS_SOA_IDP_UTIL has no exception.

Method THROW_T100_FROM_EX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_T100KEY	Call by reference	☐	Type reference (TYPE)	SCX_T100KEY		T100 Key with Parameters Mapped to Attribute Names	20081124
2	Importing	IV_MSGTY	Call by reference	☑	Type reference (TYPE)	SY-MSGTY	'E'	Message Type	20081124

Method THROW_T100_FROM_EX on class CL_BS_SOA_IDP_UTIL has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	702