SAP ABAP Class CL_SOAP_PERSISTENCY_UTIL (Utilities for WS Persistency)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ESI-WS-ABA-RT (Application Component) WebServices ABAP Runtime
     ⤷ SOAP_PERSISTENCY (Package) Administration Tools - Translation into DE, EN, FR, JA

Properties

Class	CL_SOAP_PERSISTENCY_UTIL
Short Description	Utilities for WS Persistency
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SOAP_PERSISTENCY	Administration Tools - Translation into DE, EN, FR, JA
Created	20100419	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_SOAP_PERSISTENCY_UTIL has no forward declaration.

Interfaces

Class CL_SOAP_PERSISTENCY_UTIL has no interface implemented.

Friends

Class CL_SOAP_PERSISTENCY_UTIL has no friend class.

Attributes

Class CL_SOAP_PERSISTENCY_UTIL has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_FINAL_MESSAGE_STATES	Static method	Public	Method	Get Final Message States	20101217
2	GET_INTERFACE	Static method	Public	Method	Get WS Interface	20101217
3	GET_INTERFACE_BY_SEQID	Static method	Public	Method	Get WS Interface by Sequence ID	20101217
4	GET_QUEUE_NAME	Static method	Public	Method	Get Queue Name	20101217
5	GET_REMAINING_NUM_OF_RETRIES	Static method	Public	Method	Get Remaining Number of Retries	20101217
6	GET_SEQUENCE_ID	Static method	Public	Method	Get Sequence ID	20101217
7	GET_SEQUENCE_IDS_BY_QUEUE_NAME	Static method	Public	Method	Get Sequence ID	20120829
8	GET_STATE_GROUP_TO_MSGSTATE	Static method	Public	Method	Test States Group from Message State	20120821
9	GET_UI_ADAPTER_TYPE	Static method	Public	Method	Get UI Adapter Type	20101217
10	GET_UI_MESSAGE_STATE	Static method	Public	Method	Get UI Message State	20101217
11	GET_WS_ADAPTER_TYPE	Static method	Public	Method	Get WS Adapter Type	20101217
12	GET_WS_LOCATION_BY_PIDS	Static method	Public	Method	'C'=Consumer/'P'=Provider/initial = undefined	20120828
13	GET_WS_LOCATION_COMMTYPE	Static method	Public	Method	Get WS Location and Communication Type	20101217
14	GET_WS_MESSAGE_STATE	Static method	Public	Method	Get WS Message State	20101217
15	GET_WS_REFERENCE_IDTYPE	Static method	Public	Method	Get WS Reference ID	20101217
16	GET_XI_ADAPTER_TYPE	Static method	Public	Method	Get XI Adapter Type	20101217
17	GET_XI_ADAPTER_TYPE_BY_XI_PIP	Static method	Public	Method	Get XI Pipeline by XI Adapter Type	20120828
18	GET_XI_MESSAGE_STATE	Static method	Public	Method	Get XI Message State	20101217
19	GET_XI_PIPELINE_ADAPTER_TYPE	Static method	Public	Method	Get XI Pipeline and Adapter Type	20101217
20	GET_XI_PIP_BY_XI_ADAPTER_TYPE	Static method	Public	Method	Get XI Pipeline by XI Adapter Type	20101217
21	GET_XI_REFERENCE_IDTYPE	Static method	Public	Method	Get XI Reference ID	20101217
22	MAP_ADAPTER_TO_SEQUENCE_MODE	Static method	Public	Method	Map Adapter Type to Sequence Mode	20110224
23	MAP_STATE_GROUP_TO_MSGSTATES	Static method	Public	Method	Create Message States from STATE_GROUP	20101217

Events

Class CL_SOAP_PERSISTENCY_UTIL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TT_RANGE_OF_MESSAGE_STATE	Public	See coding			20101217	tt_range_of_message_state TYPE RANGE OF srt_message_state

Method Signatures

Method GET_FINAL_MESSAGE_STATES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_FINAL_MESSAGE_STATE	Value transfer	☐	Type reference (TYPE)	CL_SOAP_PERSISTENCY_UTIL=>TT_RANGE_OF_MESSAGE_STATE			20101217

Method GET_FINAL_MESSAGE_STATES on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_INTERFACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACCESS_ID	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_ACCESS_ID		Persistency Access ID	20101217
2	Importing	PERSIST_ID	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_PERSIST_ID		Persistence ID in SOAP Runtime	20101217
3	Returning	WS_INTERFACE	Value transfer	☐	Type reference (TYPE)	SRT_INTERFACE		Qualified Interface Name	20101217

Method GET_INTERFACE on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_INTERFACE_BY_SEQID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LOCATION	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_LOCATION		Location consumer / provider	20101217
2	Importing	SEQUENCE_ID	Call by reference	☐	Type reference (TYPE)	SRT_SEQID		Sequence ID	20101217
3	Returning	WS_INTERFACE	Value transfer	☐	Type reference (TYPE)	SRT_INTERFACE		Qualified Interface Name	20101217

Method GET_INTERFACE_BY_SEQID on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_QUEUE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PERSIST_ID	Call by reference	☑	Type reference (TYPE)	SRT_PERSISTENCY_PERSIST_ID		Persistence ID in SOAP Runtime	20101217
2	Returning	QUEUE_NAME	Value transfer	☐	Type reference (TYPE)	SRT_SEQ_QUEUENAME		bgRFC Queue Name	20101217
3	Importing	SEQUENCE_ID	Call by reference	☑	Type reference (TYPE)	SRT_SEQID		Sequence ID	20101217

Method GET_QUEUE_NAME on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_REMAINING_NUM_OF_RETRIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PERSIST_ID	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_PERSIST_ID		Persistence ID	20101217
2	Returning	RV_RETRY_COUNTER	Value transfer	☐	Type reference (TYPE)	SRT_PERSISTENCY_RETRY_COUNTER		Retry counter	20101217

Method GET_REMAINING_NUM_OF_RETRIES on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_SEQUENCE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACCESS_ID	Call by reference	☑	Type reference (TYPE)	SRT_PERSISTENCY_ACCESS_ID		Persistency Access ID	20101217
2	Importing	PERSIST_ID	Call by reference	☑	Type reference (TYPE)	SRT_PERSISTENCY_PERSIST_ID		Persistence ID in SOAP Runtime	20101217
3	Importing	QUEUE_NAME	Call by reference	☑	Type reference (TYPE)	QRFC_QUEUE_NAME		Queue Name for Background RFC	20101217
4	Returning	SEQUENCE_ID	Value transfer	☐	Type reference (TYPE)	SRT_SEQID		Sequence ID	20101217

Method GET_SEQUENCE_ID on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_SEQUENCE_IDS_BY_QUEUE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	QUEUE_NAME	Call by reference	☐	Type reference (TYPE)	QRFC_QUEUE_NAME		Queue Name for Background RFC	20120829
2	Returning	SEQUENCE_ID_LIST	Value transfer	☐	Type reference (TYPE)	SRT_SEQID_T		Sequence ID - Table	20120829
3	Importing	USERNAME	Call by reference	☑	Type reference (TYPE)	SYUNAME		User Name	20120829

Method GET_SEQUENCE_IDS_BY_QUEUE_NAME on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_STATE_GROUP_TO_MSGSTATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSG_STATE	Value transfer	☐	Type reference (TYPE)	SRT_MESSAGE_STATE		Message State - Table	20120821
2	Returning	STATE_GROUP	Value transfer	☐	Type reference (TYPE)	SRT_PROCESSING_STATE_GROUP		Message Status Group	20120821

Method GET_STATE_GROUP_TO_MSGSTATE on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_UI_ADAPTER_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	UI_ADAPTER_TYPE	Value transfer	☐	Type reference (TYPE)	CHAR10		UI Adapter Type	20101217
2	Importing	WS_ADAPTER_TYPE	Value transfer	☐	Type reference (TYPE)	SRT_ADAPTER_TYPE		WS Adapter Type	20101217

Method GET_UI_ADAPTER_TYPE on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_UI_MESSAGE_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	UI_STATE	Value transfer	☐	Type reference (TYPE)	SRT_MESSAGE_STATE		UI Message State	20101217
2	Importing	WS_STATE	Value transfer	☐	Type reference (TYPE)	SRT_MESSAGE_STATE		WS Message State	20101217

Method GET_UI_MESSAGE_STATE on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_WS_ADAPTER_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	WS_ADAPTER_TYPE	Value transfer	☐	Type reference (TYPE)	SRT_ADAPTER_TYPE		WS Adapter Type	20101217
2	Importing	XI_ADAPTER_TYPE	Call by reference	☐	Type reference (TYPE)	CHAR10		XI Adapter Type	20101217
3	Importing	XI_PIPELINE	Call by reference	☑	Type reference (TYPE)	CHAR40		XI Pipeline	20101217

Method GET_WS_ADAPTER_TYPE on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_WS_LOCATION_BY_PIDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	WS_LOCATION	Value transfer	☐	Type reference (TYPE)	SRT_PERSISTENCY_LOCATION		Location Consumer / Provider	20120828
2	Importing	XI_PIPELINES	Call by reference	☐	Type reference (TYPE)	SXMS_SEL_OPTIONS		XMS: Selection Options	20120828

Method GET_WS_LOCATION_BY_PIDS on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_WS_LOCATION_COMMTYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	WS_COMMUNICATION_TYPE	Call by reference	☐	Type reference (TYPE)	SRT_COMMUNICATION_TYPE		WS Communication Type	20101217
2	Exporting	WS_LOCATION	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_LOCATION		WS Location	20101217
3	Importing	XI_ADAPT_TP_I	Call by reference	☑	Type reference (TYPE)	CHAR10		Adapter type provider	20101217
4	Importing	XI_ADAPT_TYP	Call by reference	☑	Type reference (TYPE)	CHAR10		Adpater type consumer	20101217
5	Importing	XI_PIPELINE	Call by reference	☐	Type reference (TYPE)	CHAR40		XI Pipeline	20101217

Method GET_WS_LOCATION_COMMTYPE on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_WS_MESSAGE_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	WS_STATE	Value transfer	☐	Type reference (TYPE)	SRT_MESSAGE_STATE		WS Message State	20101217
2	Importing	XI_MANUAL_STATE	Call by reference	☑	Type reference (TYPE)	CHAR1		XI Manual Change State	20101217
3	Importing	XI_STATE	Call by reference	☐	Type reference (TYPE)	SRT_MESSAGE_STATE		XI Message State	20101217

Method GET_WS_MESSAGE_STATE on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_WS_REFERENCE_IDTYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	WS_REFERENCE_ID	Value transfer	☐	Type reference (TYPE)	SRT_ID_TYPE		WS Reference ID Type	20101217
2	Importing	XI_REFERENCE_ID	Call by reference	☐	Type reference (TYPE)	CHAR8		XI Reference ID Type	20101217

Method GET_WS_REFERENCE_IDTYPE on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_XI_ADAPTER_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	WS_ADAPTER_TYPE	Value transfer	☐	Type reference (TYPE)	SRT_ADAPTER_TYPE		WS Adapter Type	20101217
2	Returning	XI_ADAPTER_TYPE	Value transfer	☐	Type reference (TYPE)	CHAR10		XI Adapter Type	20101217

Method GET_XI_ADAPTER_TYPE on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_XI_ADAPTER_TYPE_BY_XI_PIP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	XI_ADAPTER_TYPE	Value transfer	☐	Type reference (TYPE)	CHAR10		WS Adapter Type	20120828
2	Importing	XI_PIPELINE	Call by reference	☐	Type reference (TYPE)	CHAR40		XI Pipeline	20120828

Method GET_XI_ADAPTER_TYPE_BY_XI_PIP on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_XI_MESSAGE_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	WS_STATE	Value transfer	☐	Type reference (TYPE)	SRT_MESSAGE_STATE		WS Message State	20101217
2	Returning	XI_STATE	Value transfer	☐	Type reference (TYPE)	SRT_MESSAGE_STATE		XI Message State	20101217

Method GET_XI_MESSAGE_STATE on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_XI_PIPELINE_ADAPTER_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	WS_ADAPTER_TYPE	Call by reference	☐	Type reference (TYPE)	SRT_ADAPTER_TYPE		WS Adapter Type	20101217
2	Importing	WS_COMMUNICATION_TYPE	Call by reference	☐	Type reference (TYPE)	SRT_COMMUNICATION_TYPE		WS Communication Type	20101217
3	Importing	WS_LOCATION	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_LOCATION		WS Location	20101217
4	Exporting	XI_ADAPTER_TYPE	Call by reference	☐	Type reference (TYPE)	CHAR10		XI Adapter Type	20101217
5	Exporting	XI_PIPELINE	Call by reference	☐	Type reference (TYPE)	CHAR40		XI Pipeline	20101217

Method GET_XI_PIPELINE_ADAPTER_TYPE on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_XI_PIP_BY_XI_ADAPTER_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	WS_LOCATION	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_LOCATION		WS Location	20101217
2	Importing	XI_ADAPTER_TYPE	Call by reference	☐	Type reference (TYPE)	CHAR10		WS Adapter Type	20101217
3	Exporting	XI_PIPELINE	Call by reference	☐	Type reference (TYPE)	CHAR40		XI Pipeline	20101217

Method GET_XI_PIP_BY_XI_ADAPTER_TYPE on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method GET_XI_REFERENCE_IDTYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	WS_REFERENCE_ID	Call by reference	☐	Type reference (TYPE)	SRT_ID_TYPE		WS Reference ID Type	20101217
2	Returning	XI_REFERENCE_ID	Value transfer	☐	Type reference (TYPE)	CHAR8		XI Reference ID Type	20101217

Method GET_XI_REFERENCE_IDTYPE on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method MAP_ADAPTER_TO_SEQUENCE_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ADAPTER_TYPE	Call by reference	☐	Type reference (TYPE)	SRT_ADAPTER_TYPE		Adapter Type	20110224
2	Returning	SEQUENCE_MODE	Value transfer	☐	Type reference (TYPE)	SRT_SEQUENCE_PROCESSMODE		Sequence Mode	20110224

Method MAP_ADAPTER_TO_SEQUENCE_MODE on class CL_SOAP_PERSISTENCY_UTIL has no exception.

Method MAP_STATE_GROUP_TO_MSGSTATES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STATE_GROUP	Call by reference	☐	Type reference (TYPE)	SRT_PROCESSING_STATE_GROUP		Message Status Group	20101217
2	Returning	STATE_LIST	Value transfer	☐	Type reference (TYPE)	SRT_MESSAGE_STATE_T		Message State - Table	20101217

Method MAP_STATE_GROUP_TO_MSGSTATES on class CL_SOAP_PERSISTENCY_UTIL has no exception.

History

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