SAP ABAP Class CL_SOAP_PAYLOAD_UTIL (Utilitites for Payload)

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_PAYLOAD_UTIL
Short Description	Utilitites for Payload
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	20100507	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_SOAP_PAYLOAD_UTIL has no forward declaration.

Interfaces

Class CL_SOAP_PAYLOAD_UTIL has no interface implemented.

Friends

Class CL_SOAP_PAYLOAD_UTIL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_ATTACHMENT_URI	Constant	Private	☐	Type reference (TYPE)	STRING	'http://www.sap.com/webas/710/soap/runtime/hibernation/qxstring'		20101217
2	CO_EVENTING_PAYLOAD	Constant	Private	☐	Type reference (TYPE)	STRING	'http://www.sap.com/webas/710/soap/runtime/eventing'		20101217
3	CO_MESSAGE_BODY	Constant	Private	☐	Type reference (TYPE)	STRING	'Message Body'		20101217
4	CO_MESSAGE_ERROR	Constant	Private	☐	Type reference (TYPE)	STRING	'Error Information'		20101217
5	CO_PAYLOAD_READ_ERROR_CODE	Constant	Public	☐	See coding				20111230
6	CO_PERSISTENCY_TYPE_XI	Constant	Private	☐	Type reference (TYPE)	CHAR1	'X'	XI Persistency	20101229
7	MR_XI_PERSIST	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_XMS_PERSIST		Persistency Layer for the XML Message Broker	20101217
8	M_ABASU_PWD	Static Attribute	Private	☐	Type reference (TYPE)	XSTRING			20101217
9	M_ABASU_PWD_SC	Static Attribute	Private	☐	Type reference (TYPE)	XSTRING			20101217
10	M_BASIC_PWD	Static Attribute	Private	☐	Type reference (TYPE)	XSTRING			20101217
11	M_BASIC_PWD_SC	Static Attribute	Private	☐	Type reference (TYPE)	XSTRING			20101217
12	M_BINARY_XML	Static Attribute	Private	☐	Type reference (TYPE)	XSTRING			20101217
13	M_CREDE_PWD	Static Attribute	Private	☐	Type reference (TYPE)	XSTRING			20101217
14	M_CREDE_PWD_SC	Static Attribute	Private	☐	Type reference (TYPE)	XSTRING			20101217
15	M_ELEMENT_END	Static Attribute	Private	☐	Type reference (TYPE)	XSTRING			20101217
16	M_ELEMENT_END_LEN	Static Attribute	Private	☐	Type reference (TYPE)	I			20101217
17	M_PROXY_PWD	Static Attribute	Private	☐	Type reference (TYPE)	XSTRING			20101217
18	M_WSDL_PWD	Static Attribute	Private	☐	Type reference (TYPE)	XSTRING			20101217
19	M_WSDL_PWD_SC	Static Attribute	Private	☐	Type reference (TYPE)	XSTRING			20101217

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLASS_CONSTRUCTOR	Static method	Public	Constructor		20101217
2	CREATE_PROTOCOL_ATTRIBUTES	Static method	Private	Method	Create Attributes of a WS Protocol	20101217
3	DELETE_XML_ELEMENT	Static method	Private	Method	Delete an XML Element	20101217
4	GET_MESSAGE_PROPERTIES	Static method	Public	Method	Get all Properties of a Message	20101217
5	GET_MESSAGE_VERSIONS	Static method	Public	Method	Get all Versions of a Message	20101217
6	GET_PROTOCOL_NAME_BY_URI	Static method	Public	Method	Get Protocol Name by URI	20101217
7	GET_XI_PROPERTIES	Static method	Private	Method	Get all Properties of an XI Message	20101217
8	GET_XI_VERSIONS	Static method	Private	Method	Get all Versions of an XI Message	20101217
9	REPAIR_XML	Static method	Public	Method	Repair an XML	20101217

Events

Class CL_SOAP_PAYLOAD_UTIL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_CLUSTKEY	Private	See coding			20101217	begin of ty_clustkey, msgguid type sysuuid_c, pipeline_id type char40, version_no type srt_message_version, end of ty_clustkey

Method Signatures

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_SOAP_PAYLOAD_UTIL has no parameter.
Method CLASS_CONSTRUCTOR on class CL_SOAP_PAYLOAD_UTIL has no exception.

Method CREATE_PROTOCOL_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ATTRIBUTE_LIST	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_PROPERTY_T		Persistence property of a message - Table	20101217
2	Importing	DATA	Call by reference	☐	Type reference (TYPE)	XSTRING		Hibernated Protocol Data	20101217
3	Exporting	ERROR_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Error Text if any	20101217

Method CREATE_PROTOCOL_ATTRIBUTES on class CL_SOAP_PAYLOAD_UTIL has no exception.

Method DELETE_XML_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ELEMENT	Call by reference	☐	Type reference (TYPE)	XSTRING			20101217
2	Changing	XML	Call by reference	☐	Type reference (TYPE)	XSTRING			20101217

Method DELETE_XML_ELEMENT on class CL_SOAP_PAYLOAD_UTIL has no exception.

Method GET_MESSAGE_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR_CODE	Call by reference	☐	Type reference (TYPE)	CHAR1			20111230
2	Exporting	ERROR_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Error Text if any	20101217
3	Importing	ORIGINAL_DATA	Call by reference	☐	Type reference (TYPE)	XSDBOOLEAN		Original Data in Persistency	20101217
4	Importing	PERSIST_ID	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_PERSIST_ID		Persistence ID in SOAP Runtime	20101217
5	Exporting	PROPERTY_LIST	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_PROPERTY_T		Persistence property of a message - Table	20101217
6	Importing	VERSION	Call by reference	☑	Type reference (TYPE)	SRT_PERSISTENCY_VERSION		Persistence version of a message	20101217

Method GET_MESSAGE_PROPERTIES on class CL_SOAP_PAYLOAD_UTIL has no exception.

Method GET_MESSAGE_VERSIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ADAPTER_TYPE	Call by reference	☐	Type reference (TYPE)	SRT_ADAPTER_TYPE_UI		Adapter Type for UI	20101217
2	Exporting	LOCATION	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_LOCATION		Location consumer / provider	20101217
3	Exporting	MESSAGE_ID	Call by reference	☐	Type reference (TYPE)	SRT_MSGID		Message ID in SOAP Runtime	20101217
4	Importing	PERSIST_ID	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_PERSIST_ID		Persistence ID in SOAP Runtime	20101217
5	Exporting	VERSION_LIST	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_VERSION_T		Persistence version of a message - Table	20101217

#	Exception	Resumable	Description	Created on
1	CX_WSM_ACCESS_AUTHORITY	☐	Missing authorization	20101217

Method GET_PROTOCOL_NAME_BY_URI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NAME	Value transfer	☐	Type reference (TYPE)	STRING		Protocol Name	20101217
2	Importing	URI	Call by reference	☐	Type reference (TYPE)	STRING		Protocol URI	20101217

Method GET_PROTOCOL_NAME_BY_URI on class CL_SOAP_PAYLOAD_UTIL has no exception.

Method GET_XI_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ERROR_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Error Text if any	20101217
2	Importing	ORIGINAL_DATA	Call by reference	☐	Type reference (TYPE)	XSDBOOLEAN		Original Data in Persistency	20101217
3	Importing	PERSIST_ID	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_PERSIST_ID		Persistence ID in SOAP Runtime	20101217
4	Exporting	PROPERTY_LIST	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_PROPERTY_T		Persistence property of a message - Table	20101217
5	Importing	VERSION	Call by reference	☑	Type reference (TYPE)	SRT_PERSISTENCY_VERSION		Persistence version of a message	20101217

#	Exception	Resumable	Description	Created on
1	CX_WSM_ACCESS_AUTHORITY	☐	Missing authorization	20120105

Method GET_XI_VERSIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ADAPTER_TYPE	Call by reference	☐	Type reference (TYPE)	SRT_ADAPTER_TYPE_UI		Adapter Type for UI	20101217
2	Exporting	LOCATION	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_LOCATION		Location consumer / provider	20101217
3	Exporting	MESSAGE_ID	Call by reference	☐	Type reference (TYPE)	SRT_MSGID		Message ID in SOAP Runtime	20101217
4	Importing	PERSIST_ID	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_PERSIST_ID		Persistence ID in SOAP Runtime	20101217
5	Exporting	VERSION_LIST	Call by reference	☐	Type reference (TYPE)	SRT_PERSISTENCY_VERSION_T		Persistence version of a message - Table	20101217

Method GET_XI_VERSIONS on class CL_SOAP_PAYLOAD_UTIL has no exception.

Method REPAIR_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	XML	Call by reference	☐	Type reference (TYPE)	XSTRING			20101217

Method REPAIR_XML on class CL_SOAP_PAYLOAD_UTIL has no exception.

History

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